Document Verification Add Image Service (Upcoming)

Document Verification Add Image Service API Documentation

POST /addImage

Add Image

cURL

curl --request POST \
  --url https://api-umbrella.io/api/services/addImage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "journeyId": "uniqueJourneyIdentifier",
  "imageName": "uploadedFileName",
  "imageSide": "front",
  "imageData": "base64EncodedImagestring",
  "storeOnly": true,
  "passThroughData": {
    "userId": "12345"
  }
}
'

400

{
  "message": "Invalid request payload"
}

For a usage description of the Document Verification Add Image Service, please refer to the Document Verification page.

Endpoint

POST /addImage

Authorizations

Authorization · string · header · required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json

journeyId · string · required

Unique identifier for the verification journey.

Example:

"uniqueJourneyIdentifier"

imageName · string · required

Name of the uploaded image file.

Example:

"uploadedFileName"

imageSide · enum<string> · required

Specifies which side of the document (front, back, selfie).

Available options: front, back, selfie

Example:

"front"

imageData · string · required

Base64-encoded image or multipart file.

Example:

"base64EncodedImagestring"

storeOnly · boolean

If true, stores the image without classification.

Example:

true

passThroughData · object

Custom metadata (e.g., user ID).

Example:

{ "userId": "12345" }

Response

200

Successfully added image to journey.