> For the complete documentation index, see [llms.txt](https://chekin.gitbook.io/chekin-public-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chekin.gitbook.io/chekin-public-api/api-reference/ocr/get-status-and-data-analyzed.md).

# Get status and data analyzed

The "Get Status and Data Analyzed" endpoint allows users to retrieve the results and status of the OCR (Optical Character Recognition) analysis for a submitted document image. This information includes whether the MRZ (Machine Readable Zone) was detected, the status of the analysis, and detailed data extracted from the MRZ

### **Header Parameters:**

* **Authorization** *(string) <mark style="color:red;">**\***</mark>**Mandatory***\
  Required for authentication and authorization. You'll need to include a valid token here to access the reservations

### **Body Parameters:**

* **id** *(string, format: UUID) <mark style="color:red;">**\***</mark>**Mandatory***\
  Unique identifier of the OCR analysis results process. This ID is obtained from the response of the [send image to analyze](/chekin-public-api/api-reference/ocr/send-image-to-analyze.md) request

### Response:

* **id** (*string*): The unique identifier of the analysis request.
* **picture\_file** (*string*): The URL of the uploaded document image.
* **mrz\_detected** (*boolean*): Indicates whether the MRZ was successfully detected in the image.
* **status** (*string*): The current status of the OCR process, such as "COM" for completed.
* **type\_doc** (*string*): The type of document analyzed, with "P" representing a Passport. This code helps categorize the document for appropriate data handling.
* **country** (*string*): The ISO code of the country that issued the document, derived from the MRZ.
* **date\_of\_birth** (*string*): The birth date of the document holder as extracted from the MRZ, crucial for age verification and identity checks.
* **place\_of\_birth**: The place of birth of the document holder, which may include country, city, or other locality information, as applicable and as extracted from the document.
* **issue\_date**: The date the document was issued. Along with the expiration date, this helps determine the document's validity period.
* **expiration\_date** (*string*): The expiration date of the document, important for verifying the document's current validity.
* **names** (*string*): The given name(s) of the document holder.
* **surname** (*string*): The family name of the document holder. When multiple surnames are present, they may be combined here or split into **first\_surname** and **second\_surname**.
* **valid\_composite**, **valid\_date\_of\_birth**, **valid\_issue\_date**, **valid\_expiration\_date**, **valid\_number**: Booleans indicating the validity of various pieces of extracted data, ensuring each critical piece of information meets expected formats or validation criteria.
* **valid\_score** (*string*): A score indicating the accuracy or confidence in the OCR process results, typically ranging from 0 to 100. Higher scores suggest greater accuracy in data extraction.
* **created\_by** (*string*): The identifier of the user who made the OCR request, linking the action to a specific account or individual for auditing or tracking purposes.

{% openapi src="/files/2YNWdcD7SWYAbJN2lC4R" path="/ocr/data/{id}" method="get" %}
[Chekin-Chekin-1.0.0-resolved.json](https://3564732132-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfAJzL2tAGO9ZwOToBa0R%2Fuploads%2Fgit-blob-0641a0e07e27281f11fe82de446c7229bfe15c1e%2FChekin-Chekin-1.0.0-resolved.json?alt=media)
{% endopenapi %}
