South Africa

ID

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

identityNumberstring · min: 1Required

Responses

200

OK

application/json

faceImagestringOptional

Base64 encoded face image of the user

identityNumberstringOptional

firstNamestringOptional

lastNamestringOptional

maidenNamestringOptional

smartCardIssuedstringOptional

issueDatestringOptional

issueDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

idCardDatestringOptional

idCardDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

idBookDatestringOptional

idBookDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

idSequenceNumberstringOptional

deadIndicatorstringOptional

dateOfDeathstringOptional

dateOfDeathFormattedstringOptional

ISO-8601 format yyyy-MM-dd

identityNumberBlockedstringOptional

maritalStatusstringOptional

dateOfMarriagestringOptional

dateOfMarriageFormattedstringOptional

ISO-8601 format yyyy-MM-dd

onHANISstringOptional

onNPRstringOptional

countryOfBirthstringOptional

placeOfBirthstringOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/zaf/id

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/zaf/id HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "identityNumber": "text"
}

{
  "faceImage": "text",
  "identityNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "maidenName": "text",
  "smartCardIssued": "text",
  "issueDate": "text",
  "issueDateFormatted": "text",
  "idCardDate": "text",
  "idCardDateFormatted": "text",
  "idBookDate": "text",
  "idBookDateFormatted": "text",
  "idSequenceNumber": "text",
  "deadIndicator": "text",
  "dateOfDeath": "text",
  "dateOfDeathFormatted": "text",
  "identityNumberBlocked": "text",
  "maritalStatus": "text",
  "dateOfMarriage": "text",
  "dateOfMarriageFormatted": "text",
  "onHANIS": "text",
  "onNPR": "text",
  "countryOfBirth": "text",
  "placeOfBirth": "text"
}