Validate client

Allows obtaining the data associated with an identification number by querying the registry DHA of South Africa 🇿🇦.

The verification will be performed on the identification number provided in the POST Create client endpoint.

Endpoint

GET /civil-registry/dha/validation/{ID_NUMBER}

Authentication

Type	Location	Name
API Key	Header	x-api-key

Path parameters

Parameter	Type	Required	Description
ID_NUMBER	string	Yes	Identification number of 13 digits.

Request example

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/dha/validation/{ID_NUMBER}' \
--header 'x-api-key: {API_KEY}'

Responses

200 Success

Response example

{
    "id": "d56c6eb9-0caf-4c36-ae3d-6be8841a10d4",
    "idNumber": "{{idNumber}}",
    "firstNames": "{{firstName}}",
    "surname": "{{lastName}}",
    "gender": "Female",
    "dateOfBirth": "1992-08-01T00:00:00",
    "status": "Active",
    "datePerformed": "2024-03-01T14:46:06.4871561+02:00",
    "birthPlaceCountryCode": "",
    "deadIndicator": false,
    "dateOfDeath": "",
    "maritalStatus": "",
    "dateOfMarriage": "",
    "idIssueDate": "20160831",
    "idSequenceNumber": "1",
    "onHANIS": true,
    "onNPR": true,
    "smartCardIssued": true,
    "idNumberBlocked": false,
    "photo": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDABA.....",
    "dataSource": "DHA SAFPS",
    "hasPhoto": true
}

400 Bad Request

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

502 Bad Gateway

{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}

504 Gateway Timeout

{
  "message": "Endpoint request timed out"
}