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
numberValueAlways where applicableThe number used for verification. Not returned for Thailand ThaID; use idNumber when it is included in the requested scope.
numberTypeInfoAlwaysregion + numberType — see supported regions.
verificationConditionalSub-object below. Usually all null for Nigeria; face is set on success/fail. Not returned for Thailand ThaID.

Nigeria (NGA) — BVN / NIN

FieldPresenceDescription
bvnAlways (BVN)Same as the submitted BVN.
ninAlways (NIN)Same as the submitted NIN.
numberValueAlwaysSubmitted number.
firstName, middleName, lastNameConditionalFrom the identity record.
genderConditionalValues: MALE / FEMALE.
birthdayConditionalDate of birth; yyyy/MM/dd.
phoneNumberConditionalFrom the identity record.
phoneNumber2ConditionalFrom the identity record, when the source returns it.
verification.faceConditionalpass / fail when a face-match outcome is reported; otherwise null. Other verification sub-fields are null.

The key that does not apply to the current type (bvn for NIN, nin for BVN) is returned as null.

Use faceDetail and the top-level errorCode for the final liveness/match outcome; do not rely on docDatabaseDetail.verification.face alone.

Philippines (PHL) — PCN

PhilSys PCN verified against the Philippine identity source. For this type, faceDetail.livenessType and faceDetail.livenessFlowCategory are always DISTANT_CLOSE_FLASH.

FieldPresenceDescription
numberValueConditionalThe PCN used for the check: the submitted value, or the vendor-normalized value.
fullNameConditionalFull name from the identity source. If the source returns no name, it is assembled from the prefilled or H5-submitted personal information.
genderConditionalValues: MALE / FEMALE.
birthdayConditionalDate of birth; yyyy/MM/dd.
addressConditionalAddress string from the identity source — see address.
verification.faceConditionalpass / fail when a face-match outcome is reported. Other verification sub-fields are null.
firstName, middleName, lastName, suffixNot returnedMerged into fullName.

inputParameters echoes firstName, middleName and lastName only; suffix and birthday are not echoed in the result.
| bvn, nin, phoneNumber, phoneNumber2, email | Not returned | Not applicable for PCN. |

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.

Thailand (THA) — ThaID

For TH_THAIEID, docDatabaseDetail is populated only on PASS. It includes numberTypeInfo and the attributes selected by the effective scope. An attribute outside scope is omitted. A requested attribute may be null if the identity source does not provide a value.

FieldPresenceDescription
numberTypeInfoAlwaysregion is THA and numberType is TH_THAIEID.
idNumberConditionalThai national ID number.
fullNameConditionalFull name in Thai.
fullNameEnConditionalFull name in English.
birthdayConditionalDate of birth; yyyy/MM/dd.
addressConditionalFormatted address; see address.
firstNameConditionalGiven name in Thai.
middleNameConditionalMiddle name in Thai.
lastNameConditionalFamily name in Thai.
firstNameEnConditionalGiven name in English.
middleNameEnConditionalMiddle name in English.
lastNameEnConditionalFamily name in English.
genderConditionalAs provided by the identity source; see the note below.
smartcardCodeConditionalID smart card code.
titleConditionalName title in Thai.
titleEnConditionalName title in English.
ialConditionalIdentity assurance level as provided by the identity source; see the note below.
issueDateConditionalID card issue date; yyyy/MM/dd.
expiryDateConditionalID card expiry date; yyyy/MM/dd.
houseAddressConditionalFormatted registered household address.
numberValue, verificationNot returnedThese fields do not apply to ThaID.

gender and ial are returned as strings and are not restricted to the enumerations used by other markets.

verification

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

address

address has a different shape per market:

  • Brazil (CPF) — object with fields number, postalCode, city, street, neighborhood, state, type.
  • Philippines (PCN) — plain string.
  • Thailand (ThaID) — address and houseAddress are formatted strings when returned.

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": null,
  "verification": { "numberValue": null, "fullName": null, "dob": null, "face": "pass" }
}
{
  "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"
}
{
  "nin": "99********5",
  "numberValue": "99********5",
  "numberTypeInfo": { "numberType": "NG_NIN", "region": "NGA" },
  "firstName": "T****E",
  "middleName": "C****T",
  "lastName": "I***A",
  "gender": "FEMALE",
  "birthday": "1994/07/13",
  "phoneNumber": "081******05",
  "verification": { "numberValue": null, "fullName": null, "dob": null, "face": null }
}
{
  "numberValue": "12****3456789012",
  "numberTypeInfo": { "numberType": "PH_PCN", "region": "PHL" },
  "fullName": "J**** S**** D**** C**** JR",
  "gender": "MALE",
  "birthday": "1990/05/15",
  "address": "M****, M**** M****",
  "verification": { "numberValue": null, "fullName": null, "dob": null, "face": "pass" }
}
{
  "idNumber": "1***********2",
  "firstName": "A****",
  "lastName": "S*****",
  "birthday": "1992/03/17",
  "numberTypeInfo": { "numberType": "TH_THAIEID", "region": "THA" }
}

Did this page help you?