POST
/
addImage
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",
  "storeOnly": true,
  "imageData": "base64EncodedImagestring",
  "passThroughData": {
    "userId": "12345"
  }
}'
This response does not have an example.

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 authentication header of the form Bearer <token>, where <token> is your auth token.

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
_mintlify/placeholder

Successfully added image to journey.