🔎Find a Single Address Document
Find an existing address document record by address_document_id.
Find an existing Address Document for a Customer.
GET {{baseUrl}}/address-documents/:address_document_id
Search for an Address Document record using the search parameter address_document_id.
Path Parameters
Name
Type
Description
address_document_id*
String
The UUID for an Address Document that gets generated and returned in the POST Create Address Document response.
```json
{
"data": {
"id": "1a2b996a-3622-4b7a-aa4b-c6509a74b3af",
"address_line_1": "6 Eton Road",
"address_line_2": "22 Eton Park",
"suburb": "Sandhurst",
"city": "Johannesburg",
"province": null,
"postal_code": "2196"
}
}
``````json
{
"data": {
"id": "{{addressDocumentId}}",
"valid": false,
"validated": {
"city": true,
"suburb": false,
"province": false,
"postal_code": true,
"address_line_1": true,
"address_line_2": true
},
"information": {
"city": "Private Bag X18, Johannesburg, 2000",
"suburb": "",
"province": "",
"postal_code": "1459",
"customer_name": "partial_match",
"address_line_1": "27 LANNER STREET",
"address_line_2": "PARKDENE"
},
"document": {
"id": 1044,
"name": "3.1 ABSA_Feb.pdf",
"type": "pdf",
"url": "http://uat.apply.fincheck.co.za/gathr-docs/documents/3.1%20ABSA_Kirsten_Feb.pdf"
},
"address_id": "{{addressId}}"
}
}
```Last updated