Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Document capture

Add document asynchronously

Upload document image and store data asynchronously.

post/omni/add/document/async

Query parameters

type'signature' | 'document' | 'medicalDoc' | 'thirdId' | 'contract' 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.
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.

Headers

api-versionstring required

Request body

base64Imagestring

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

imageUrlstring

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

Example request

{
  "base64Image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
  "imageUrl": "http://..."
}

Response

OK

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status