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
| Value | Meaning |
|---|---|
| Always | Key appears whenever docDatabaseDetail is non-null for that type. |
| Conditional | May be null depending on vendor data or verification outcome. |
| Not returned | Must not appear in Get Result for that type. |
Common
| Field | Presence | Description |
|---|---|---|
| numberValue | Always where applicable | The number used for verification. Not returned for Thailand ThaID; use idNumber when it is included in the requested scope. |
| numberTypeInfo | Always | region + numberType — see supported regions. |
| verification | Conditional | Sub-object below. Usually all null for Nigeria; face is set on success/fail. Not returned for Thailand ThaID. |
Nigeria (NGA) — BVN / NIN
| Field | Presence | Description |
|---|---|---|
| bvn | Always (BVN) | Same as the submitted BVN. |
| nin | Always (NIN) | Same as the submitted NIN. |
| numberValue | Always | Submitted number. |
| firstName, middleName, lastName | Conditional | From the identity record. |
| gender | Conditional | Values: MALE / FEMALE. |
| birthday | Conditional | Date of birth; yyyy/MM/dd. |
| phoneNumber | Conditional | From the identity record. |
| phoneNumber2 | Conditional | From the identity record, when the source returns it. |
| verification.face | Conditional | pass / 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.
| Field | Presence | Description |
|---|---|---|
| numberValue | Conditional | The PCN used for the check: the submitted value, or the vendor-normalized value. |
| fullName | Conditional | Full name from the identity source. If the source returns no name, it is assembled from the prefilled or H5-submitted personal information. |
| gender | Conditional | Values: MALE / FEMALE. |
| birthday | Conditional | Date of birth; yyyy/MM/dd. |
| address | Conditional | Address string from the identity source — see address. |
| verification.face | Conditional | pass / fail when a face-match outcome is reported. Other verification sub-fields are null. |
| firstName, middleName, lastName, suffix | Not returned | Merged 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
| Field | Presence | Description |
|---|---|---|
| fullName | Always | From Generate URL input. |
| gender / birthday | Conditional | When number check passes (derived from NIK). |
| verification | Conditional | Per-field pass / fail / null. |
| email / phoneNumber | Not returned | Stripped on Get Result. |
Brazil (BRA) — CPF
| Field | Presence | Description |
|---|---|---|
| fullName, gender, birthday | Conditional | From identity source. |
| cpfStatus, motherName, address | Conditional | CPF-specific. |
| verification.face | Conditional | When face match result exists. |
Argentina (ARG) — DNI
| Field | Presence | Description |
|---|---|---|
| fullName, firstName, lastName | Conditional | From identity source. |
| gender, birthday | Conditional | From identity source. |
| taxId, taxIdType | Conditional | Tax/labour ID — see taxId. |
| verification.face | Conditional | When 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.
| Field | Presence | Description |
|---|---|---|
| firstName, lastName | Conditional | From DHA identity record. |
| gender | Conditional | From DHA. Values: MALE / FEMALE. |
| birthday | Conditional | Date of birth; yyyy/MM/dd. |
| idStatus | Conditional | DHA ID status — see idStatus. |
| deadIndicator | Conditional | true when the holder is recorded as deceased. |
| dateOfDeath | Conditional | Present when deceased; yyyy/MM/dd. |
| idIssueDate | Conditional | ID issue date from DHA; yyyy/MM/dd. |
| fullName, middleName, phoneNumber, phoneNumber2, email | Not returned | Stripped for ZA_SAID. |
| verification | Conditional | All 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.
| Field | Presence | Description |
|---|---|---|
| numberTypeInfo | Always | region is THA and numberType is TH_THAIEID. |
| idNumber | Conditional | Thai national ID number. |
| fullName | Conditional | Full name in Thai. |
| fullNameEn | Conditional | Full name in English. |
| birthday | Conditional | Date of birth; yyyy/MM/dd. |
| address | Conditional | Formatted address; see address. |
| firstName | Conditional | Given name in Thai. |
| middleName | Conditional | Middle name in Thai. |
| lastName | Conditional | Family name in Thai. |
| firstNameEn | Conditional | Given name in English. |
| middleNameEn | Conditional | Middle name in English. |
| lastNameEn | Conditional | Family name in English. |
| gender | Conditional | As provided by the identity source; see the note below. |
| smartcardCode | Conditional | ID smart card code. |
| title | Conditional | Name title in Thai. |
| titleEn | Conditional | Name title in English. |
| ial | Conditional | Identity assurance level as provided by the identity source; see the note below. |
| issueDate | Conditional | ID card issue date; yyyy/MM/dd. |
| expiryDate | Conditional | ID card expiry date; yyyy/MM/dd. |
| houseAddress | Conditional | Formatted registered household address. |
| numberValue, verification | Not returned | These 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
| Field | Description |
|---|---|
| numberValue / fullName / dob / face | pass, 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) —
addressandhouseAddressare 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" }
}Updated 1 day ago
