Verify South African ID Number (SAID)

SAID Verification

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

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Users SAID Number
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
data	Object	Validation data object
lastName	String	Last name to compare against ID
firstName	String	First name to compare against ID
middleName	String	Middle name to compare against the ID
email	String	Email address to compare against ID
phoneNumber	String	Phone number to compare against the ID

SAID Verification

SAID Number is used to verify that a provided South African number exists in the database.

SAID Verification Sample Request

{
    "id": "8012185201081",
    "isSubjectConsent": true,
    "validations": {
        "data": {
            "lastName": "PILLAY",
            "firstName": "LAVEN"
        }
    }
}

Found Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "645bca7fd80de606cd7e5ad4",
        "validations": {
            "data": {
                "lastName": {
                    "validated": true,
                    "value": "PILLAY"
                },
                "firstName": {
                    "validated": true,
                    "value": "LAVEN"
                }
            },
            "validationMessages": ""
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "selfieValidation": false,
        "firstName": "LAVEN",
        "lastName": "PILLAY",
        "isSmartCardIssued": "Yes",
        "idIssueDate": "20150708",
        "idSequenceNumber": "1",
        "deceasedStatus": "alive",
        "dateOfDeath": "",
        "maritalStatus": "Single",
        "dateOfMarriage": "",
        "onHANIS": "yes",
        "onNPR": "yes",
        "countryOfBirth": "South Africa",
        "hanisReference": "2305105157920",
        "isConsent": true,
        "businessId": "628b38f03ae28a14f52d4bf7",
        "type": "zaSAID",
        "allValidationPassed": true,
        "requestedAt": "2023-05-10T16:47:21.989Z",
        "requestedById": "628b38f13ae28a7b742d4bf9",
        "country": "ZA",
        "createdAt": "2023-05-10T16:47:22.374Z",
        "lastModifiedAt": "2023-05-10T16:47:22.374Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "Onyeka",
            "lastName": "Ijeh",
            "middleName": "",
            "id": "628b38f13ae28a7b742d4bf9"
        }
    },
    "links": []
}

Error Response

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