URL Expired

The URL for this request expired after 30 days.

retry

boolean

Defaults to false

Flag stating that this is retry attempt for add/back-id

truefalse

Back side of id

base64Image

string

Image in base64 format. One of base64Image or imageUrl is required

imageUrl

string

URL of the image. One of base64Image or imageUrl is required

api-version

string

required

Defaults to 1.0

``200 In case there's some issue when calling the endpoint due to classification failed, an issue such as bad quality, or any of the fail reasons the response will always have the field: - classification - failReason - sharpness - glare - horizontalResolution We recommend considering the call as failed if there's a failReason in the response or if the classification is false. Possible values for fail reason: - UNKNOWN_DOCUMENT_TYPE: document classification failed - WRONG_DOCUMENT_SIDE: can happen when uploading back side of id when front id is required or the other way around - WRONG_ONE_SIDED_DOCUMENT: uploading wrong document with only one side - WRONG_UNFOLDED_DOCUMENT: uploading unfolded document with unrecognizable sides - UNFOLDED_DOCUMENT_PAGE_MISMATCH: uploading unfolded document with mismatching sides - DOCUMENT_NOT_READABLE: document couldn't be read, probably due to image quality - UNABLE_TO_ALIGN_DOCUMENT: alignment failed - ID_TYPE_UNACCEPTABLE: invalid type of id - UNEXPECTED_ERROR_OCCURRED: unexpected error Whenever the classification is done successfully the fields that will always be present are: - classification - sharpness - glare - horizontalResolution - readibility - typeOfId - sessionStatus The remaining fields could be optional depending on the specific type of id and country of origin.

``400 Custom error statuses: - 4004: Could not find user - 5003: Unsatisfied image size

Updated 3 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request POST \

--url https://demo-api.incodesmile.com/omni/add/back-id/v2 \

--header 'accept: application/json' \

--header 'api-version: 1.0' \

--header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200400

Updated3 months ago