Upload document image gathered and store data.
Add document V3
https://demo-api.incodesmile.com/omni/add/document/v3Query parameters
- **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. - **v5cMultiPageLogbook**: Upload single page (image) of V5C logbook multi page document. - **carInvoice**: Upload single page (image) of two pages car invoice document. - **financeSettlement**: Upload single page (image) of two pages finance settlement letter. - **w8Ben**: Upload IRS W-8BEN form as a single page image or a PDF. - **w8BenE**: Upload one page (image) of the multi page IRS W-8BEN-E form, or the complete form as a PDF. Finish with the finalize document endpoint.
signaturedocumentmedicalDocthirdIdcontractv5cMultiPageLogbookcarInvoicefinanceSettlementw8Benw8BenEOnly if type is contract. Title of contract.
Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.
imagepdfOnly applicable for some documents. Possible values are sync and async. Default is sync.
syncasyncHeaders
Request body
application/json
Image in base64 format. One of base64Image or imageUrl is required
URL of the image. One of base64Image or imageUrl is required
Responses
Response body (application/json)
AddDocumentStatus
SUCCESSPROCESS_DOC_ERRORSESSION_ERRORADD_NEXT_PAGEOPTIONAL_PAGE_CAPTURECLASSIFICATION_ERRORMULTI_PAGE_CLASSIFICATION_ERRORV5C_REGISTRATION_NUMBER_MISMATCHV5C_REFERENCE_NUMBER_MISMATCHV5C_NUMBER_MISMATCHFSL_AGREEMENT_REFERENCE_MISMATCHFSL_NAME_MISMATCHNOT_W8_BENNOT_W8_BEN_EMANDATORY_FIELD_MISSINGUNSUPPORTED_PAGE_NUMBERSVALIDATION_ERRORUNEXPECTED_ERRORFINALIZE_ERROR_NO_PAGESUNSUPPORTED_MP_DOCUMENT_TYPEResponse body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details