Skip to main content

​
Endpoint

POST /v3/universal-ai (sync) Model string pattern: ocr/identity_parser/{provider}[/{model}]

​
Input

FieldTypeRequiredDescription
filefile_inputYesPDF or image file ID from /v3/upload or direct file URL

​
Output

FieldTypeRequiredDescription
extracted_dataarray[object]No
    last_nameobjectYes
        valuestringNo
        confidencefloatNo
    given_namesarray[object]No
        valuestringNo
        confidencefloatNo
    birth_placeobjectYes
        valuestringNo
        confidencefloatNo
    birth_dateobjectYes
        valuestringNo
        confidencefloatNo
    issuance_dateobjectYes
        valuestringNo
        confidencefloatNo
    expire_dateobjectYes
        valuestringNo
        confidencefloatNo
    document_idobjectYes
        valuestringNo
        confidencefloatNo
    issuing_stateobjectYes
        valuestringNo
        confidencefloatNo
    addressobjectYes
        valuestringNo
        confidencefloatNo
    ageobjectYes
        valuestringNo
        confidencefloatNo
    countryobjectYes
        namestringYes
        alpha2stringYes
        alpha3stringYes
        confidencefloatNo
    document_typeobjectYes
        valuestringNo
        confidencefloatNo
    genderobjectYes
        valuestringNo
        confidencefloatNo
    image_idarray[object]No
        valuestringNo
        confidencefloatNo
    image_signaturearray[object]No
        valuestringNo
        confidencefloatNo
    mrzobjectYes
        valuestringNo
        confidencefloatNo
    nationalityobjectYes
        valuestringNo
        confidencefloatNo

​
Available Providers

ProviderModel StringPrice
affindaocr/identity_parser/affinda$0.07 per file
amazonocr/identity_parser/amazon$0.025 per page
base64ocr/identity_parser/base64$0.2 per page
klippaocr/identity_parser/klippa$0.1 per file
microsoftocr/identity_parser/microsoft$0.01 per page
mindeeocr/identity_parser/mindee$0.1 per page
openaiocr/identity_parser/openai$0.02 per page
openai (gpt-4o)ocr/identity_parser/openai/gpt-4o$0.02 per page

​
Quick Start

import requests

url = "https://api.edenai.run/v3/universal-ai"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

payload = {
    "model": "ocr/identity_parser/affinda",
    "input": {
        "file": "YOUR_FILE_UUID_OR_URL"
    }
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())