DocDatabaseDetail

DocDatabaseDetail

Object inside Get Result API data. Shape depends on numberTypeInfo — see Supported Regions & NumberTypes.

Full Get Result envelopes (with faceDetail, errorCode, etc.) are on the Get Result API page only.

Presence

ValueMeaning
AlwaysKey appears whenever docDatabaseDetail is non-null for that type.
ConditionalMay be null depending on vendor data or verification outcome.
Not returnedMust not appear in Get Result for that type.

Common

FieldPresenceDescription
numberValueAlwaysSubmitted number.
numberTypeInfoAlwaysregion + numberType — see supported regions.
verificationConditionalSub-object below. Usually all null for Nigeria.

Nigeria (NGA) — BVN & NIN

Shared fields (NG_BVN / NG_NIN): firstName, middleName, lastName, gender, birthday, phoneNumber, phoneNumber2 — all Conditional.

FieldNG_BVNNG_NIN
bvnAlwaysNot returned
ninNot returnedAlways
lastName sourcelastNamevendor surname
birthday sourcebirthdayvendor birthDate
phoneNumber sourcephoneNumbervendor telephoneNo

Indonesia (IDN) — NIK

FieldPresenceDescription
fullNameAlwaysFrom Generate URL input.
gender / birthdayConditionalWhen number check passes (derived from NIK).
verificationConditionalPer-field pass / fail / null.
email / phoneNumberNot returnedStripped on Get Result.

Brazil (BRA) — CPF

FieldPresenceDescription
fullName, gender, birthdayConditionalFrom identity source.
cpfStatus, motherName, addressConditionalCPF-specific.
verification.faceConditionalWhen face match result exists.

Argentina (ARG) — DNI

FieldPresenceDescription
fullName, firstName, lastNameConditionalFrom identity source.
gender, birthdayConditionalFrom identity source.
taxId, taxIdTypeConditionalTax/labour ID — see taxId.
verification.faceConditionalWhen face match result exists. Other verification sub-fields are null for Argentina.

South Africa (ZAF) — SAID

South African ID Number (SAID, 13 digits) verified against DHA (Department of Home Affairs). A successful database lookup requires an available DHA reference photo; otherwise the transaction fails with FACE_QUALITY_TOO_POOR.

FieldPresenceDescription
firstName, lastNameConditionalFrom DHA identity record.
genderConditionalFrom DHA. Values: MALE / FEMALE.
birthdayConditionalDate of birth; yyyy/MM/dd.
idStatusConditionalDHA ID status — see idStatus.
deadIndicatorConditionaltrue when the holder is recorded as deceased.
dateOfDeathConditionalPresent when deceased; yyyy/MM/dd.
idIssueDateConditionalID issue date from DHA; yyyy/MM/dd.
fullName, middleName, phoneNumber, phoneNumber2, emailNot returnedStripped for ZA_SAID.
verificationConditionalAll sub-fields are null for ZA_SAID; the face result is on faceDetail.

verification

FieldDescription
numberValue / fullName / dob / facepass, fail, or null (datasource did not report).

address

Brazil only. Fields: number, postalCode, city, street, neighborhood, state, type.

taxId

Argentina only. taxId is the holder's tax/labour ID number; taxIdType indicates its type (value: CUIL).

idStatus

South Africa only. DHA ID status. Values: Active, Deceased. When the holder is deceased, deadIndicator is true and dateOfDeath is present. idIssueDate is the DHA ID issue date.

Examples

docDatabaseDetail only (not the full Get Result response).

{
  "bvn": "22********4",
  "numberValue": "22********4",
  "numberTypeInfo": { "numberType": "NG_BVN", "region": "NGA" },
  "firstName": "T****E",
  "middleName": "C****T",
  "lastName": "I***A",
  "gender": "FEMALE",
  "birthday": "1994/07/13",
  "phoneNumber": "081******05",
  "phoneNumber2": ""
}
{
  "nin": "12********9",
  "numberValue": "12********9",
  "numberTypeInfo": { "numberType": "NG_NIN", "region": "NGA" },
  "firstName": "A****A",
  "middleName": "B****i",
  "lastName": "O***i",
  "gender": "MALE",
  "birthday": "1990/03/15",
  "phoneNumber": "080******12"
}
{
  "numberValue": "************0005",
  "numberTypeInfo": { "numberType": "ID_NIK", "region": "IDN" },
  "fullName": "R**** I******",
  "gender": "FEMALE",
  "birthday": "1976/01/15",
  "verification": {
    "numberValue": "pass",
    "fullName": "pass",
    "dob": "fail",
    "face": "pass"
  }
}
{
  "numberValue": "************0005",
  "numberTypeInfo": { "numberType": "ID_NIK", "region": "IDN" },
  "fullName": "R**** I**********",
  "gender": "FEMALE",
  "birthday": "1976/01/15",
  "verification": {
    "numberValue": "pass",
    "fullName": "fail",
    "dob": "fail",
    "face": "fail"
  }
}
{
  "numberValue": "07*.***.***-*4",
  "numberTypeInfo": { "numberType": "BR_CPF", "region": "BRA" },
  "fullName": "G******** R******** D* S****",
  "gender": "FEMALE",
  "birthday": "1999/12/26",
  "cpfStatus": "Regular",
  "motherName": "A****** R******** D* S****",
  "address": {
    "number": "SN",
    "city": "ARACOIABA",
    "street": "C********* E****** C***** S****",
    "postalCode": "62*****0",
    "neighborhood": "CENTRO",
    "state": "CE",
    "type": "residential"
  },
  "verification": { "face": "pass" }
}
{
  "numberValue": "12*****8",
  "numberTypeInfo": { "numberType": "AR_DNI", "region": "ARG" },
  "firstName": "A****** H*****",
  "lastName": "L*****",
  "fullName": "A****** H***** L*****",
  "gender": "MALE",
  "birthday": "2008/08/08",
  "verification": { "numberValue": null, "fullName": null, "dob": null, "face": "pass" },
  "taxId": "20********0",
  "taxIdType": "CUIL"
}
{
  "numberValue": "8901115124084",
  "numberTypeInfo": { "numberType": "ZA_SAID", "region": "ZAF" },
  "firstName": "CHAD ASHLEY",
  "lastName": "LOURENS",
  "gender": "MALE",
  "birthday": "1989/01/11",
  "verification": {
    "numberValue": null,
    "fullName": null,
    "dob": null,
    "face": null
  },
  "idStatus": "Active",
  "deadIndicator": false,
  "dateOfDeath": null,
  "idIssueDate": "2023/11/16"
}
{
  "numberValue": "890********084",
  "numberTypeInfo": { "numberType": "ZA_SAID", "region": "ZAF" },
  "firstName": "A****",
  "lastName": "B*****",
  "gender": "MALE",
  "birthday": "1989/01/11",
  "idStatus": "Deceased",
  "deadIndicator": true,
  "dateOfDeath": "2023/05/20"
}