DocDetail

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.

eventDetails

qualityLabels

examples:

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

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

qualityKey

forgeryLabels

Returned labels depend on the checks performed and the final review outcome; not every label applies to every country or verification flow. Clients should handle unrecognized label values without failing to parse the response.

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