Extract Identity Card Data

POST

/document-ai/{model-id}

Extracted Data Types

The following types will always be present in the API response. If a type parameter is not found in the input, its value will be null.

Parameter Name	Variable Type
`id_number`	string \| null
`id_holder_fullname`	string \| null
`id_holder_date_of_birth`	string \| null
`id_sex`	string \| null
`id_nationality`	string \| null
`id_place_of_origin`	string \| null
`id_place_of_residence`	string \| null
`id_date_of_expiry`	string \| null

Notes

Each type parameter in the data array will always have the specified type, with the possibility of being null.

If a specific type parameter is not present in the input, its value in the response will be null.

Request

Authorization

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Path Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.axtraction.ai/v1/document/document-ai/model-a1b2c3d4e5f6' \
--header 'X-API-KEY: <api-key>' \
--form 'file=@""' \
--form 'fileBase64="JVBERi0xLjMNCiXi48/...."' \
--form 'mimeType="application/pdf"'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "type": "id_number",
            "value": "123456789012"
        },
        {
            "type": "id_holder_fullname",
            "value": "Nguyen Thi Mai"
        },
        {
            "type": "id_holder_date_of_birth",
            "value": "1995-08-20"
        },
        {
            "type": "id_sex",
            "value": "Female"
        },
        {
            "type": "id_nationality",
            "value": "Vietnamese"
        },
        {
            "type": "id_place_of_origin",
            "value": "Hai Phong"
        },
        {
            "type": "id_place_of_residence",
            "value": "Ho Chi Minh City"
        },
        {
            "type": "id_date_of_expiry",
            "value": "2030-12-31"
        }
    ],
    "miscellaneous": {
        "processedTime": 95.32
    }
}

Modified at 2025-05-13 04:16:11

Extract Business Card Data

Extract Passport Data