API reference, Document capture

Add document

POSThttps://demo-api.incodesmile.com/omni/add/document

Upload document image and store data.

Note: Make sure to put the 'Content-Type' header as 'Content-Type: image/jpeg' or 'Content-Type: image/png'.

Query parameters

typestringrequired

- **signature**: Upload user's digital signature. This can be later fetched in get images endpoint. - **document**: Upload user's proof of address document. This can be later fetched in get images endpoint. - **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead. - **medicalDoc**: Upload user's medical document. - **thirdId**: Upload user's third ID. - **contract**: Upload contract image.

enumsignaturedocumentmedicalDocthirdIdcontract
titlestring

Only if type is contract. Title of contract.

formatstring

Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.

enumimagepdf

Headers

api-versionstringrequiredDefaults to 1.0

Responses

Was this page helpful?