Request Body

This page gives a brief overview of the acceptable format of the request body.

Body

The request body is form data that takes two files, a front image (required) and a back image (optional) as well as a json string for the request model.

The accepted format for the RequestModel is as below. All fields are required.

Depending on your specific needs the "ExtraFields" property can be modified or extended to include more fields you'd like extracted from your document, for instance, if you'd like to extract the address you would add the address under extra fields as demonstrated below.

Country

The country the document was issued in.

DocumentType

The type of the document, e.g. Driver's License

Mode

Determines whether the document has MRZ lines and should scan MRZ only or if the document should proceed with normal entity extraction.

ExpirationCheckMode

Determines how expired documents are handled. Depending on the mode selected expired documents might not be accepted or they might just be ignored. Acceptable modes are:

STRICT,

ALLOW_EXPIRED,

LOCAL_REGULATIONS, GENERALLY_ACCEPTED_REGULATIONS

CharacterRecognitionMode

Whether the document has Latin or non-latin characters.

DefaultFields

The default fields that should be extracted from the document. Ideally should not be modified or should match the image provided above.

ExtraFields

Any extra information that you would like extracted from the document. This varies from document to document.