MRZ¶

The overview describes the common field interpretation rules, failure reasons, and full/light file formats.

Parent: mrz_result. Retrieval and recognition of a document's machine-readable zone.

Fields of mrz_result.

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field	JSON type	Purpose and conditions
`status`	string, enum	Required: `NOT_REQUESTED` — not requested; `REQUESTED` — requested; `IN_PROCESS` — processing; `RECEIVED` — received; `REQUEST_FAILED` — request error; `PARSE_FAILED` — recognition error.
`photo`	string	Photo URL, if a file exists; a URL in both response variants.
`mrz_string`	string	Recognized MRZ, up to 255 characters; may contain line separators. Not an object of parsed document fields.
`result`	boolean	Stored technology result: `true` means accepted, `false` means a negative result. May be absent before calculation; consider the status and the details below.
`failure_reason`	object	Failure reason, if recorded; see the structure.

JSON examples¶

Fragments of the root response object, not complete responses. All values and URLs are illustrative. File formats follow the explanations on this page.

{
  "mrz_result": {
    "status": "PARSE_FAILED",
    "result": false,
    "failure_reason": {
      "type": "CLIENT"
    }
  }
}