South Africa

ID

Government database lookup API

POSThttps://id.uqudo.io/api/v2/id/lookup/zaf/id

Header parameters

Body

application/json

identityNumber*string

Response

200400401403429500503

OK

Body

application/json

faceImagestring

Base64 encoded face image of the user

identityNumberstring

firstNamestring

lastNamestring

maidenNamestring

smartCardIssuedstring

issueDatestring

issueDateFormattedstring

ISO-8601 format yyyy-MM-dd

idCardDatestring

idCardDateFormattedstring

ISO-8601 format yyyy-MM-dd

idBookDatestring

idBookDateFormattedstring

ISO-8601 format yyyy-MM-dd

idSequenceNumberstring

deadIndicatorstring

dateOfDeathstring

dateOfDeathFormattedstring

ISO-8601 format yyyy-MM-dd

identityNumberBlockedstring

maritalStatusstring

dateOfMarriagestring

dateOfMarriageFormattedstring

ISO-8601 format yyyy-MM-dd

onHANISstring

onNPRstring

countryOfBirthstring

placeOfBirthstring

Request

JavaScriptCurl

const response = await fetch('https://id.uqudo.io/api/v2/id/lookup/zaf/id', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identityNumber": "text"
    }),
});
const data = await response.json();

Response

{
  "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"
}