🔎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.

200: OK Address Document Found - No Validation

```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"
    }
}
```

200: OK Address Document Found - With Validation

```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}}"
    }
}
```

200: OK No Address Document Data Found

```json
{
    "data": {
        "id": "77c0199c-dc69-48f9-8be9-e58443faaf44",
        "valid": false,
        "validated": {
            "city": false,
            "suburb": false,
            "province": false,
            "postal_code": false,
            "address_line_1": false,
            "address_line_2": false
        },
        "information": {
            "city": "",
            "suburb": "",
            "province": "",
            "postal_code": "",
            "customer_name": "full_match",
            "address_line_1": "",
            "address_line_2": ""
        },
        "document": {
            "id": 1017,
            "name": "02-Dec-2022---03-Jan-2023 (1).pdf",
            "type": "pdf",
            "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/02-Dec-2022---03-Jan-2023%20%281%29.pdf"
        },
        "address_id": "6098e611-df48-4319-8ebe-fda59775fef6"
    }
}
```