Skip to main content

Submit Residential Addresses

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

Submit the current residential address of the cardholder in either structured or unstructured format.

note

This endpoint is for Immersve-conducted KYC only.

Request​

Path Parameters

    cardholderAccountId stringrequired

    ID of the cardholder account.

    Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Body

array

required

  • Array [

    • anyOf

    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 stringrequired

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

  • ]

Responses​

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.

  • ]

Loading...