Document Recognize

The API allows you to extract information from various identity documents such as passports, driver's licenses and more.

Endpoint

POST https://cloud.ooto-ai.com/api/v1.0/recognize

Parameters

  • doc_image: The document image file.

Authentication

To access the API, you need to include the following headers in your request:

  • APP-ID: Your application's unique identifier.

  • APP-KEY: Your application's authentication key.

Example

curl -X POST --location 'https://cloud.ooto-ai.com/api/v1.0/recognize' \
--header 'APP-ID: put_app_id_here' \
--header 'APP-KEY: put_app_key_here' \
--form 'doc_image=@"/path/to/doc_image"'

Replace «app_id», «app_key» with your actual credentials and the path to your doc image.

Response (HTTP 200)

{
    "transactionId": "string",
    "result": {
        {
            "doc": "string",
            "ocr": {
              "countryName": "string",
              "countryName_local": "string",
              "dateOfBirth": "string",
              "dateOfIssue": "string",
              "dateOfExpiration": "string",
              "IDPlaceOfBirthCountry": "string",
              "givenNames": "string",
              "givenNames_local": "string",
              "surname": "string",
              "surname_local": "string",
              "identityCardNumber": "string",
              "issuingStateCode": "string",
              "sex": "string",
              "mrz": "string",
              "bookletNumber": "string",
              "citizenshipStatus": "string",
              "nationality": "string",
              "height_cm": 0,
              "weight_kg": 0,
              "eyes": "string"
            },
            "position": {
              "x": 0,
              "y": 0,
              "w": 0,
              "h": 0,
              "angle": 0
            },
            "portrait": {
              "x": 0,
              "y": 0,
              "w": 0,
              "h": 0,
              "angle": 0
            }
      }
}

Last updated