Proof of Address Verification

Proof of Address Verification

POST {{baseurl}}/v2/api/identity/za/poa

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Users identity number
addressDetails*	Object	Address detail data object
proofOfAddressImage*	String	Proof of address image
address1*	String	Address line 1
address2*	String	Address line 2
suburb*	String	Suburban area
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
houseNumber*	String	House number of candidate
street*	String	Street name of candidate
buildingName*	String	Candidates building name
unitName*	String	Candidates unit name
personalInformation*	Object	Validation data object
lastName*	String	Candidates last name
province*	String	Candidates province
city*	String	Candidates city
postalCode*	String	Candidates postal code
stateCode*	String	Candidates city code
duration*	String	Duration of stay
propertyType*	String	Candidates property type
country*	String	Candidates country
firstName*	String	Candidates first name
gender*	String	Candidates gender
email*	String	Candidates email address
idType*	String	Candidates ID type

Proof of Address Verification

With this endpoint, you have access to the verification of the client's proof of address in South Africa.

Proof of Address Verification Sample Request

{
    "personalInformation": {
        "firstName": "JONAH",
        "lastName": "PILLAY",
        "gender": "M",
        "email": "[e-mail]"
    },
    "addressDetails": {
        "proofOfAddressImage": "{{Base64String}}",
        "imageName": "image.jp",
        "address1": "Body Corporate of Cohiba",
        "address2": "Stand NO: 433",
        "suburb": "Radiokop",
        "houseNumber": "1",
        "street": "2",
        "buildingName": "2",
        "unitName": "2",
        "province": "2",
        "city": "Radiokop",
        "postalCode": "1752",
        "stateCode": "GP",
        "duration": "13",
        "propertyType": "O  ",
        "country": "ZA"
    },
    "id": "2502161858090",
    "idType": "SAID",
    "isSubjectConsent": true
}

Found Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "645bca7cd80de606cd7e5ad3",
        "validations": {
            "data": {
                "phoneNumber": {
                    "validated": false,
                    "value": "0795030317"
                },
                "fullName": {
                    "validated": true,
                    "value": "CONCO"
                },
                "email": {
                    "validated": false,
                    "value": "[e-mail]"
                }
            },
            "validationMessages": "Email does not match, Phone Number does not match"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "identityNumberValid": "No",
        "accountTypeValid": "Yes",
        "accountStatus": "Open",
        "acceptsDebits": "Yes",
        "acceptsCredits": "Yes",
        "accountNumberValid": "Yes",
        "{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64cc3994d0ae9481b885e518",
        "parentId": null,
        "status": "found",
        "reason": null,
        "businessId": "62c2a4868d319373a6280152",
        "requestedAt": "2023-08-03T23:34:44.712Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "ZA",
        "type": "zaPOA",
        "riskOutcome": "High",
        "isConsent": true,
        "metadata": {},
        "personalInformation": {
            "firstName": "JONAH",
            "lastName": "PILLAY",
            "gender": "M",
            "email": "[e-mail]"
        },
        "addressDetails": {
            "proofOfAddressImage": "{{Base64String}}",
            "imageName": "image.jp",
            "address1": "Body Corporate of Cohiba",
            "address2": "Stand NO: 433",
            "suburb": "Radiokop",
            "houseNumber": "1",
            "street": "2",
            "buildingName": "2",
            "unitName": "2",
            "province": "2",
            "city": "Radiokop",
            "postalCode": "1752",
            "stateCode": "GP",
            "duration": "13",
            "propertyType": "O  ",
            "country": "ZA"
        },
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}

Error Response

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}