Ctrlk
Log Support Ticket

✅Return Address Document Validation

Validate whether the information provided for the Customer and Address is an accurate match for what can be read off of the Address Document uploaded.

Please note that the Customer's address has to be correct as per their Address Document uploaded for the validation to pass (return true).

Validate Address Documents

GET {{baseUrl}}/address-documents/:address_document_id/verify

Run this request to get the results of the Validation of the Customer's Address Document against the information stored for the Customer and Address from when they were initially created.

Path Parameters

Name
Type
Description

address_document_id*

String

This is the UUID for an Address Document that gets generated and returned in the POST Create Address Document response. 

```json
{
    "data": {
        "id": "{{addressDoucmentId}}",
        "valid": true,
        "validated": {
            "address_line_1": true,
            "address_line_2": true,
            "suburb": true,
            "city": false,
            "province": false,
            "postal_code": true
        },
        "information": {
            "address_line_1": "22 ETON PARK 6 ETON RD",
            "address_line_2": "SANDHURST",
            "suburb": "SANDHURST",
            "city": "",
            "province": "",
            "postal_code": "2196",
            "customer_name": "full_match"
        },
        "document": {
            "id": 10,
            "name": "FNB_Dec_Jan (2).pdf",
            "type": "pdf",
            "url": "https://dev.apply.fincheck.co.za/gathr-docs/documents/FNB_Dec_Jan%20%282%29.pdf"
        },
        "address_id": "{{addressId}}"
    }
}
```

Last updated

Was this helpful?