Document capture
Add document V3
Upload document image gathered and store data.
post/omni/add/document/v3
Query parameters
type'signature' | 'document' | 'medicalDoc' | 'thirdId' | 'contract' | 'v5cMultiPageLogbook' | 'carInvoice' | 'financeSettlement' required
- 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.
titlestring
Only if type is contract. Title of contract.
format'image' | 'pdf'
Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.
processingMethod'sync' | 'async'
Only applicable for some documents. Possible values are sync and async. Default is sync.
Headers
api-versionstring required
Request body
Example request
{
"base64Image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
"imageUrl": "http://..."
}Response
OK