Update a proof of address check-in.

PUT 
/api/users/checkin/proof-of-address/:id

Update a proof of address check-in. A proof of address check-in requires a document (or photos) clearly proving residence. Photos need to be uploaded to the Ownli cloud via the Photo upload api.

Request

Path Parameters

id stringrequired

application/json

Body

required

userId stringrequired

Id of the user.

documentType stringrequired

Possible values: [UtilityBill, Paycheck, FinancialStatement, SaleDeed, LeaseAgreement, PhoneBill, Invalid, UtilityBill, Paycheck, FinancialStatement, SaleDeed, LeaseAgreement, PhoneBill]

Document type for attached document.

latitude doublerequired

Latitude of the check-in.

longitude doublerequired

Longitude of the check-in.

addressType string

Possible values: [StandaloneHome, Apartment, Condominium, Duplex, Other, Invalid, StandaloneHome, Apartment, Condominium, Duplex, Other]

Type of home.

address

object

Address

addressLine1 string

Street Address

city string

City

state string

2 Letter State Code (eg. AL, CA, CO etc.

country string

2 Letter Country Code. Must be US.

zip string

Zipcode

latitude double

Latitude of the address.

longitude double

Longitude of the address.

photos

object[]

Array [

url stringrequired

Url of the photo. The photo needs to be uploaded via the Photo Upload API.

type stringrequired

Possible values: [FrontView, AlternateView, Invalid, FrontView, AlternateView]

Type of the photo. A value from one of the photo types.

]

documents

object[]

Array [

url stringrequired

Url of the document. The document needs to be uploaded via the Photo Upload API.

type stringrequired

Possible values: [DOCUMENT, GALLERY, CAMERA, INVALID, DOCUMENT, GALLERY, CAMERA]

File type of the document.

ordinal int32

Ordinal

]

Responses

200

The created proof of address check-in object.

application/json

Schema

Schema

userId stringrequired

Id of the user.

documentType stringrequired

Possible values: [UtilityBill, Paycheck, FinancialStatement, SaleDeed, LeaseAgreement, PhoneBill, Invalid, UtilityBill, Paycheck, FinancialStatement, SaleDeed, LeaseAgreement, PhoneBill]

Document type for attached document.

latitude doublerequired

Latitude of the check-in.

longitude doublerequired

Longitude of the check-in.

addressType string

Possible values: [StandaloneHome, Apartment, Condominium, Duplex, Other, Invalid, StandaloneHome, Apartment, Condominium, Duplex, Other]

Type of home.

address

object

Address

addressLine1 string

Street Address

city string

City

state string

2 Letter State Code (eg. AL, CA, CO etc.

country string

2 Letter Country Code. Must be US.

zip string

Zipcode

latitude double

Latitude of the address.

longitude double

Longitude of the address.

photos

object[]

Array [

url stringrequired

Url of the photo. The photo needs to be uploaded via the Photo Upload API.

type stringrequired

Possible values: [FrontView, AlternateView, Invalid, FrontView, AlternateView]

Type of the photo. A value from one of the photo types.

]

documents

object[]

Array [

url stringrequired

Url of the document. The document needs to be uploaded via the Photo Upload API.

type stringrequired

Possible values: [DOCUMENT, GALLERY, CAMERA, INVALID, DOCUMENT, GALLERY, CAMERA]

File type of the document.

ordinal int32

Ordinal

]

Example (from schema)

{
  "userId": "string",
  "documentType": "UtilityBill",
  "latitude": 0,
  "longitude": 0,
  "addressType": "StandaloneHome",
  "address": {
    "addressLine1": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zip": "string",
    "latitude": 0,
    "longitude": 0
  },
  "photos": [
    {
      "url": "string",
      "type": "FrontView"
    }
  ],
  "documents": [
    {
      "url": "string",
      "type": "DOCUMENT",
      "ordinal": 0
    }
  ]
}

401

Authorization error e.g. due to an invalid or missing API keys.

403

The caller does not have access to the checkin. Possible error codes

1. ERROR_NO_PERMISSIONS_TO_RESOURCE

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

404

User not found. Possible error codes

1. ERROR_USER_NOT_FOUND

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

Loading...