Get Residential Addresses

GET 
/api/accounts/:cardholderId/residential-addresses

Retrieve previously submitted residential addresses of the cardholder.

note

This endpoint is for Immersve-conducted KYC only.

Request

Path Parameters

cardholderAccountId stringrequired
ID of the cardholder account.
Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

200

application/json

Schema

Schema

• Array [

unitNumber string

The unit number.

streetNumber string

Street number. Generally a number but can also be alphanumeric.

streetName string

Street name.

town string

The town/village/suburb/city.

suburb string

The suburb in the town/city. Only use this if you require a suburb AND a town/city, otherwise, just use the "town" parameter.

state string

The state. Use local abbreviations such as VIC (Victoria) or TX (Texas).

region string

The county, province, or cantonment.

postalCode string

Postal code.

country string

The ISO 3166-2 Country code of the country the address is in.

fullAddress string

The submitted unstructured address.

• ]

Example (from schema)

[
  {
    "unitNumber": "1",
    "streetNumber": "3A",
    "streetName": "Victoria Street",
    "town": "Auckland",
    "suburb": "Epsom",
    "state": "AKL",
    "region": "Auckland",
    "postalCode": "1050",
    "country": "NZ",
    "fullAddress": "1/3A Victoria Street, Epsom, Auckland 1050, New Zealand"
  }
]

403

Subject is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Resource does not exist or there are no sufficient permissions to perform the action.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...