The Address object
Attributes
id string | Unique identifier for the address object |
country_iso string | Country ISO 2 code |
alias string | Alias name of the address |
salutation string | This can have the following values:
|
first_name string | First name of the user for whom the identity is created |
last_name string | Second name of the user for whom the identity is created |
address_line1 string | Building name/number |
address_line2 string | The street name/number of the address |
city string | The city of the address for which the address proof is created |
region string | The region of the address for which the address proof is created |
postal_code string | The postal code of the address that is being created |
fiscal_identification_code string | The code is available for businesses alone and will be available for spain mobile numbers. If not present, return null |
street_code string | Street code of the address. Return null if not present. |
municipal_code string | Municipal code of the address. Return null if not present. |
validation_status string | Can take the following values: pending. accepted, rejected, null |
verification_status string | Can take the following values: pending. verified, rejected, null |
subaccount string | The link to the subaccount resource associated with the application. If the application belongs to the main account, this field will be null. |
url string | A plivo wrapped link to the document stored in the Plivo CDN. |
proof_type string | The type of document that is provided as address proof. Possible values:
|
address_proof_number string | The unique id number associated with the document uploaded as proof. |
linked_phone_numbers | Array of all phone numbers linked to this document. |
Response
{
"account": "MAXXXXXXXXXXXXXXXXXX",
"address_line1": "128",
"address_line2": "RUE DU COMMANDANT GUILBAUD",
"alias": "test_address",
"api_id": "08361d92-0b59-11e8-aa7e-02ad5072be3e",
"city": "PARIS",
"country_iso": "FR",
"document_details": {
"address_line1": "128",
"address_line2": "RUE DU COMMANDANT GUILBAUD",
"city": "PARIS",
"first_name": "Bruce",
"last_name": "Wayne",
"postal_code": "75016",
"region": "PARIS",
"salutation": "Mr"
},
"first_name": "Bruce",
"id": "20220771838737",
"last_name": "Wayne",
"postal_code": "75016",
"region": "PARIS",
"salutation": "Mr",
"subaccount": null,
"url": "https://api.plivo.com/v1/Account/MAXXXXXXXXXXXXXXXXXX/Verification/Address/20220771838737/",
"validation_status": "accepted",
"verification_status": "pending"
}