Skip to main content
POST
/
v3
/
id-verification
ID Verification
curl --request POST \
  --url https://verification.didit.me/v3/id-verification/ \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form front_image='@example-file' \
  --form back_image='@example-file' \
  --form perform_document_liveness=false \
  --form minimum_age=60 \
  --form expiration_date_not_detected_action=DECLINE \
  --form invalid_mrz_action=DECLINE \
  --form inconsistent_data_action=DECLINE \
  --form preferred_characters=latin \
  --form save_api_request=true \
  --form 'vendor_data=<string>'
{
  "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "id_verification": {
    "status": "Declined",
    "issuing_state": "ESP",
    "issuing_state_name": "Spain",
    "region": null,
    "document_type": "Identity Card",
    "document_number": "YZA123456",
    "personal_number": "X9876543L",
    "date_of_birth": "1985-03-15",
    "age": 40,
    "expiration_date": "2022-08-21",
    "date_of_issue": "2012-08-21",
    "first_name": "Elena",
    "last_name": "Martínez Sánchez",
    "full_name": "Elena Martínez Sánchez",
    "gender": "F",
    "address": "Calle Mayor 10, 4B, Madrid, Madrid",
    "formatted_address": "Calle Mayor 10, 4B, 28013 Madrid, Madrid, Spain",
    "place_of_birth": "Valencia",
    "marital_status": null,
    "nationality": "ESP",
    "extra_fields": {
      "dl_categories": [],
      "blood_group": null
    },
    "parsed_address": {
      "city": "Madrid",
      "label": "ID Card Address",
      "region": "Community of Madrid",
      "country": "ES",
      "category": "Residential",
      "street_1": "Calle Mayor 10",
      "street_2": "4B",
      "is_verified": true,
      "postal_code": "28013",
      "raw_results": {
        "types": [
          "street_address",
          "subpremise"
        ],
        "geometry": {
          "location": {
            "lat": 40.4155,
            "lng": -3.7074
          },
          "viewport": {
            "northeast": {
              "lat": 40.41685,
              "lng": -3.70605
            },
            "southwest": {
              "lat": 40.41415,
              "lng": -3.70875
            }
          },
          "location_type": "ROOFTOP"
        },
        "place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
        "formatted_address": "Calle Mayor, 10, 4B, 28013 Madrid, Spain",
        "navigation_points": [
          {
            "location": {
              "latitude": 40.4155,
              "longitude": -3.7074
            }
          }
        ],
        "address_components": [
          {
            "types": [
              "subpremise"
            ],
            "long_name": "4B",
            "short_name": "4B"
          },
          {
            "types": [
              "street_number"
            ],
            "long_name": "10",
            "short_name": "10"
          },
          {
            "types": [
              "route"
            ],
            "long_name": "Calle Mayor",
            "short_name": "Calle Mayor"
          },
          {
            "types": [
              "locality",
              "political"
            ],
            "long_name": "Madrid",
            "short_name": "Madrid"
          },
          {
            "types": [
              "administrative_area_level_1",
              "political"
            ],
            "long_name": "Community of Madrid",
            "short_name": "CM"
          },
          {
            "types": [
              "country",
              "political"
            ],
            "long_name": "Spain",
            "short_name": "ES"
          },
          {
            "types": [
              "postal_code"
            ],
            "long_name": "28013",
            "short_name": "28013"
          }
        ]
      },
      "address_type": "Calle",
      "document_location": {
        "latitude": 40.4155,
        "longitude": -3.7074
      },
      "formatted_address": "Calle Mayor, 10, 4B, 28013 Madrid, Spain"
    },
    "portrait_image": "/9j/4AAQSkZJRgA...p5X3Ku+x//9k=",
    "front_document_image": "/9j/4AAQSkZJRgA...p5X3Ku+x//9k=",
    "back_document_image": "/9j/4AAQSkZJRgA...p5X3Ku+x//9k=",
    "mrz": {
      "surname": "MARTINEZ<SANCHEZ",
      "name": "ELENA",
      "country": "ESP",
      "nationality": "ESP",
      "birth_date": "850315",
      "expiry_date": "220821",
      "sex": "F",
      "document_type": "ID",
      "document_number": "YZA123456",
      "optional_data": "X9876543L",
      "optional_data_2": "",
      "birth_date_hash": "7",
      "expiry_date_hash": "4",
      "document_number_hash": "9",
      "final_hash": "2",
      "personal_number": "X9876543L",
      "warnings": [],
      "errors": [],
      "mrz_type": "TD1",
      "mrz_string": "IDESPMARTINEZ<SANCHEZ<<<<<<<<<<\nYZA123456<9ESP8503157F3208214<X9876543L<<<<<<<2\nMARTINEZ<SANCHEZ<<ELENA<<<<<<<<<<",
      "mrz_key": "YZA123456985031573208214"
    },
    "barcodes": [
      {
        "type": "PDF_417",
        "data": {
          "first": "Elena",
          "last": "Martínez",
          "middle": null,
          "city": "Madrid",
          "state": "Madrid",
          "address": "Calle Mayor 10, 4B",
          "issue_identifier": "636001",
          "document_number": "YZA123456",
          "expiration_date": "2022-08-21",
          "date_of_birth": "1985-03-15",
          "postal_code": "28013",
          "class": null,
          "restrictions": null,
          "endorsements": null,
          "sex": "F",
          "height": "168 cm",
          "weight": "65 kg",
          "hair": "Brown",
          "eyes": "Green",
          "issued": "2022-08-21",
          "units": "METRIC",
          "suffix": null,
          "prefix": null
        },
        "data_raw": "JVBERi0xLjUNCiXi48/TDQoNCjEgMCBvYmo[...]truncated_for_example",
        "side": "back"
      }
    ],
    "matches": [],
    "warnings": [
      {
        "risk": "DOCUMENT_EXPIRED",
        "additional_data": null,
        "log_type": "error",
        "short_description": "Document expired",
        "long_description": "The document's expiration date has passed, rendering it no longer valid for use."
      }
    ]
  },
  "created_at": "2025-05-01T13:11:07.977806Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.didit.me/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

multipart/form-data
​
front_image
file
required

Front side image of the identity document. Framing: do not crop—show the entire document with all four corners visible and margin around the edges; cropped corners commonly cause declines even if text is sharp. Size: file must be > 250 KB (required resolution); < 1 MB per image is recommended for faster processing. Allowed formats: JPEG, PNG, WebP, TIFF, PDF. Maximum file size: 5 MB.

​
back_image
file

Back side image of the identity document, required for dual-sided documents like ID cards. Same rules as front_image: uncropped full document, four corners + margin, > 250 KB (ideally < 1 MB). Allowed formats: JPEG, PNG, WebP, TIFF, PDF. Maximum file size: 5 MB.

​
perform_document_liveness
boolean
default:false

Whether or not to perform document liveness to make sure the imaged is not a screened copy, or portrait replacement.

​
minimum_age
integer | null

Minimum age required. Users under this age will be declined. Must be between 1-120.

Required range: 1 <= x <= 120
​
expiration_date_not_detected_action
enum<string>
default:DECLINE

Action to take when the expiration date is not detected. Must be one of NO_ACTION or DECLINE.

Available options:
NO_ACTION,
DECLINE
​
invalid_mrz_action
enum<string>
default:DECLINE

Action to take when MRZ reading fails because the MRZ has been tampered, or there is some occlusions that does not allow to read it properly. Must be one of NO_ACTION or DECLINE.

Available options:
NO_ACTION,
DECLINE
​
inconsistent_data_action
enum<string>
default:DECLINE

Action to take when the extracted data in the VIZ (Visual Inspection Zone) is not consistent with the MRZ data, indicating signs of data tampering. Must be one of NO_ACTION or DECLINE.

Available options:
NO_ACTION,
DECLINE
​
preferred_characters
enum<string>
default:latin

Preferred character set to use when the document carries names, address, or place of birth in multiple scripts (e.g. a Kyrgyz ID with both Latin and Cyrillic surname fields). Controls which script populates the top-level response fields (first_name, last_name, full_name, address, place_of_birth); the opposite script is exposed inside extra_fields with suffix _non_latin (when this is latin) or _latin (when this is non_latin). Alternate-script keys are only emitted when the OCR actually extracts a real value in the opposite script. If this is latin but the document contains only non-Latin text, Didit transliterates the extracted values and exposes _latin keys as a fallback. Must be one of latin or non_latin.

Available options:
latin,
non_latin
​
save_api_request
boolean
default:true

Whether to save this API request. If true, then it will appear on the Manual Checks section in the Business Console.

​
vendor_data
string

A unique identifier for the vendor or user, such as a UUID or email. This field enables proper session tracking and user data aggregation across multiple verification sessions.

Response

​
request_id
string<uuid>
​
id_verification
object
​
created_at
string<date-time>