This optional http part with name options specifies if document request should be synchronous or asynchronous (not yet implemented), if an output processed image shoud be generated, etc. Options are set by a JSON object, with the keys/values described below. All values are optional and default to false or empty if unspecified.
| Key | value type | Description |
|---|---|---|
${organization.defaultLanguage} | boolean | highlight extracted information in the processed image (only applicable if processImage is true). |
${organization.disabled} | boolean | (ID_DOCUMENT containing an ID photo only). crop identity photo from document and publish idPhotoUrl in the response |
${organization.id} | boolean | Force document processing even if detected quality is too low (except major failure). Note that forcing document processing can change server response http status code, hence request billing |
${organization.name} | boolean | This parameter forces reading the person's first and last name from VIZ instead of MRZ. By default, it is set false. |
This optional http part with name holder specifies the expected owner of document to be checked: first name, last name, address… If applicable to actual document type, each supplied information will be extracted and compared with document.
Names constraints: holder names, if specified, must meet the following constraints:
- be composed of the following characters: Unicode letters, digits, dash, dot, apostrophes, space
- should not start or end with a space
- should start with a letter
- should not be an empty string
- for identity documents, must have at least a birthName
- for textual documents, must have at least a birthName or a lastName Holder is defined by a JSON object, with the keys/values described below:
| Key | value type | Description |
|---|---|---|
lastName | string | Holder expected last name. This is the name that usually appears on invoice or bank documents. |
birthName | string | Holder expected birth name. This is the reference name that appears on Identity documents. |
firstName | string | Holder expected first name. In case holder has several first names, only the main first name should be supplied here |
birthDate | string | Holder expected birth date. |
birthPlace | string | Holder expected birth place. |
gender | string M or F or X | Holder expected gender |
nationality | string | Holder expected nationality (2 or 3 letters country code) |
phoneNumber | string | Holder expected phone number (no spaces). This information is searched only in PHONE_INVOICE document types. |
address | JSON object | JSON object containing holder expected postal address |
Example of JSON expected for postal address
{
"address1": "address main line...",
"address2": "address other line (optional)",
"address3": "address other other line (optional)",
"postalCode": "the address postal code",
"city": "address city"
}This optional http part with name legalEntity specifies the company. Providing this part with an Identity Document generates additional controls and details in response. The legal entity name, if specified, is also searched in document OCR (for RIB document type only). Legal entity is defined by a JSON object, with the keys/values described below:
| Key | value type | Description |
|---|---|---|
legalEntityName | string | Legal entity name |
legalEntityId | string | Legal entity identifier (SIREN or SIRET). |
This optional http part with name contextLocale specifies the context in which our controls are run. It is declared in a JSON array:
| Key | value type | Description |
|---|---|---|
country | string | country code (2 upper case letters). |
language | string | language code (2 lower case letters). |