DocDetail

Document verification details for the APIs under Historical Docs — Identity Verification Solution. This page describes the legacy response structure.

ocrResult

docType

examples:

{
  "front": "PH-ID-UMID",
  "back": null
}

refer toSupported Regions & DocTypes

subDocType

examples:

{
  "front": "PH-ID-E_NATIONAL_ID-V1",
  "back": "PH-ID-E_NATIONAL_ID-V1"
}

ocrInfo

ocrInfo contains OCR results by document side.

• front and back represent the front and back sides. back is null for a single-sided document.
• The API does not merge values from both sides. To obtain one value, read front first and use back when the front value is empty.
• Returned fields vary by country, document type, and service configuration. A field may be null or omitted.

Example

{
  "front": {
    "side": "front",
    "idNumber": "************",
    "documentNumber": null,
    "fullName": "EXAMPLE USER",
    "fullNameLocal": "EXAMPLE USER",
    "firstNameLocal": "EXAMPLE USER",
    "birthday": "1990/01/01",
    "nationality": "MYS",
    "countryCode": "MY",
    "issuerCountryIso3": "MYS"
  },
  "back": {
    "side": "back",
    "idNumber": null,
    "documentNumber": "**************"
  }
}

Name fields

Use the *NameLocal fields first. Use the *NameEn fields when English names are enabled for the service.

When OCR succeeds, at least one side contains fullNameLocal. Name fields on an individual side may still be null.

Document number fields

idNumber is the primary identifier. If it is empty on the front side, it may be returned on the back side.

Core fields

Additional fields

Passport MRZ

When Passport MRZ is enabled, ocrInfo may also contain:

• mrz: MRZ OCR results, including issuing country, passport type, name, passport number, Personal Number, date of birth, nationality, gender, and expiry date.
• mrzCheck: comparison results between visual-zone OCR and MRZ values. Each comparison value is normally pass or fail.

Within mrz, idNumber is the passport number and documentNumber is the Personal Number.

Integration notes

1. Parse ocrInfo.front and ocrInfo.back separately; do not assume the API merges them.
2. Support both omitted fields and fields whose value is null.
3. Use *NameEn for English names; do not infer the language of compatibility name fields.
4. Ignore unknown fields to remain compatible with future extensions.

additionalInfo

Planned extension: The postal-code response described below is provided for integration planning ahead of service availability. Confirm availability with your integration contact before relying on this field. Examples containing additionalInfo illustrate the planned response contract.

additionalInfo is an object at data.docDetail.additionalInfo containing supplementary information about the document.

The initial scope is Indonesian KTP documents for solution codes 01, 02, 05, and 10, subject to service enablement. No additional request parameter is required.

This postal code is supplementary information derived from an address lookup; the existing ocrInfo.front.postcode and ocrInfo.back.postcode remain OCR address fields. A postal code is not guaranteed even when an address is available. Postal-code lookup does not affect the IDV pass/fail decision.

When docDetail is present, additionalInfo contains postalCode, with a string value or null. If docDetail itself is null, it remains null. Once the IDV result is final, the postal-code result will not be populated later; no additional polling is required for this field.

Postal code available

Example of the additionalInfo object for an Indonesian KTP address:

{
  "postalCode": "71571"
}

Postal code unavailable

Example of the additionalInfo object when no postal code is available:

{
  "postalCode": null
}

eventDetails

qualityLabels

examples:

{
  "front": null,
  "back": null
}

{
  "front": {
    "isBlur": false,
    "isDim": false,
    "isExposure": true
  },
  "back": null
}

qualityKey

forgeryLabels

docTypeDetails

Example

{
  "front": {
    "side": "FRONT",
    "category": "ID",
    "subCategory": null,
    "docType": "UA-ID-N",
    "version": null,
    "countryIso3": "UKR"
  },
  "back": {
    "side": "BACK",
    "category": "ID",
    "subCategory": null,
    "docType": "UA-ID-N",
    "version": null,
    "countryIso3": "UKR"
  }
}

docTypeDetail

docTypeCategory