Identity Parser

post

https://api.edenai.run/v2/ocr/identity_parser/

Available Providers

Provider	Model	Version	Price	Billing unit
amazon	-	`boto3 (v1.15.18)`	0.025 (per 1 page)	1 page
base64	-	`latest`	0.2 (per 1 page)	1 page
microsoft	-	`rest API 4.0 (2024-02-29-preview)`	0.01 (per 1 page)	1 page
mindee	-	`v2`	0.1 (per 1 page)	1 page
klippa	-	`v1`	0.1 (per 1 file)	1 file
affinda	-	`v3`	0.07 (per 1 file)	1 file
openai	gpt-4o	`v1`	0.02 (per 1 page)	1 page

Supported Languages

Name	Value
Afrikaans	`af`
Albanian	`sq`
Arabic	`ar`
Bengali	`bn`
Bulgarian	`bg`
Chinese	`zh`
Croatian	`hr`
Czech	`cs`
Danish	`da`
Dutch	`nl`
English	`en`
Estonian	`et`
Finnish	`fi`
French	`fr`
German	`de`
Gujarati	`gu`
Hebrew	`he`
Hindi	`hi`
Hungarian	`hu`
Indonesian	`id`
Italian	`it`
Japanese	`ja`
Kannada	`kn`
Korean	`ko`
Latvian	`lv`
Lithuanian	`lt`
Macedonian	`mk`
Malayalam	`ml`
Marathi	`mr`
Modern Greek (1453-)	`el`
Nepali (macrolanguage)	`ne`
Norwegian	`no`
Panjabi	`pa`
Persian	`fa`
Polish	`pl`
Portuguese	`pt`
Romanian	`ro`
Russian	`ru`
Slovak	`sk`
Slovenian	`sl`
Somali	`so`
Spanish	`es`
Swahili (macrolanguage)	`sw`
Swedish	`sv`
Tagalog	`tl`
Tamil	`ta`
Telugu	`te`
Thai	`th`
Turkish	`tr`
Ukrainian	`uk`
Urdu	`ur`
Vietnamese	`vi`

Supported Detailed Languages

Name	Value
Auto detection	`auto-detect`
Chinese (China)	`zh-cn`
Chinese (Taiwan)	`zh-tw`
English (United States)	`en-US`
French (France)	`fr-FR`
German (Germany)	`de-DE`
Italian (Italy)	`it-IT`
Portuguese (Portugal)	`pt-PT`
Spanish (Spain)	`es-ES`

Supported Models

Default Models

Name	Value
openai	`gpt-4o`

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

settings

string

Defaults to [object Object]

A dictionnary or a json object to specify specific models to use for some providers.
It can be in the following format: {"google" : "google_model", "ibm": "ibm_model"...}.

providers

array of strings

required

It can be one (ex: 'amazon' or 'google') or multiple provider(s) (ex: 'amazon,microsoft,google') that the data will be redirected to in order to get the processed results.
Providers can also be invoked with specific models (ex: providers: 'amazon/model1, amazon/model2, google/model3')

providers*

fallback_providers

array of strings

length ≤ 5

Defaults to

Providers in this list will be used as fallback if the call to provider in providers parameter fails. To use this feature, you must input only one provider in the providers parameter. but you can put up to 5 fallbacks.

They will be tried in the same order they are input, and it will stop to the first provider who doesn't fail.

Doesn't work with async subfeatures.

fallback_providers

response_as_dict

boolean

Defaults to true

Optional : When set to true (default), the response is an object of responses with providers names as keys :
{"google" : { "status": "success", ... }, }
When set to false the response structure is a list of response objects :
[{"status": "success", "provider": "google" ... }, ].

attributes_as_list

boolean

Defaults to false

Optional : When set to false (default) the structure of the extracted items is list of objects having different attributes :
{'items': [{"attribute_1": "x1","attribute_2": "y2"}, ... ]}
When it is set to true, the response contains an object with each attribute as a list :
{ "attribute_1": ["x1","x2", ...], "attribute_2": [y1, y2, ...]}

show_base_64

boolean

Defaults to true

show_original_response

boolean

Defaults to false

Optional : Shows the original response of the provider.
When set to true, a new attribute original_response will appear in the response object.

file

File to analyse in binary format to be used with content-type: multipart/form-data
Does not work with application/json !

file_url

uri | null

File URL to analyse to be used with with content-type: application/json.

file_password

string | null

If your PDF file has a password, you can pass it here!

convert_to_pdf

boolean | null

Defaults to false

Boolean value to specify weather to convert the doc/docx files to pdf format to be accepted by a majority of the providers

Responses

200

400

403

404

500