MxDocument¶

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

Parent: mxdocument_result. Mexican document recognition, QR data extraction, and additional check results.

Fields of mxdocument_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
`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.
`frontside_image`	string	Front side: Base64 / a URL in light, when a file is available.
`backside_image`	string	Back side: Base64 / a URL in light, when a file is available.
`face_photo`	string	Face extracted from QR data: Base64 / a URL in light, when a file is available.
`result_json`	JSON	Provider response data; a dynamic structure.
`qr_extraction_data`	JSON	Data extracted from the QR code; a dynamic structure.
`qr_validation_data`	JSON	QR check; a dynamic structure.
`face_comparison_data`	JSON	Face comparison; a dynamic structure.
`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.

{
  "mxdocument_result": {
    "result": false,
    "frontside_image": "https://files.example.invalid/mx/front.png",
    "backside_image": "https://files.example.invalid/mx/back.png",
    "face_photo": "https://files.example.invalid/mx/face.png",
    "result_json": {
      "document_number": "0000000000"
    },
    "qr_extraction_data": {
      "personal_number": "AAAA000000AAAAAA00"
    },
    "qr_validation_data": {
      "valid": true
    },
    "face_comparison_data": {
      "prediction": 0.95
    }
  }
}