Add Image
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"
}
}
'import requests
url = "https://api-umbrella.io/api/services/addImage"
payload = {
"journeyId": "uniqueJourneyIdentifier",
"imageName": "uploadedFileName",
"imageSide": "front",
"imageData": "base64EncodedImagestring",
"storeOnly": True,
"passThroughData": { "userId": "12345" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
journeyId: 'uniqueJourneyIdentifier',
imageName: 'uploadedFileName',
imageSide: 'front',
imageData: 'base64EncodedImagestring',
storeOnly: true,
passThroughData: {userId: '12345'}
})
};
fetch('https://api-umbrella.io/api/services/addImage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-umbrella.io/api/services/addImage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'journeyId' => 'uniqueJourneyIdentifier',
'imageName' => 'uploadedFileName',
'imageSide' => 'front',
'imageData' => 'base64EncodedImagestring',
'storeOnly' => true,
'passThroughData' => [
'userId' => '12345'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-umbrella.io/api/services/addImage"
payload := strings.NewReader("{\n \"journeyId\": \"uniqueJourneyIdentifier\",\n \"imageName\": \"uploadedFileName\",\n \"imageSide\": \"front\",\n \"imageData\": \"base64EncodedImagestring\",\n \"storeOnly\": true,\n \"passThroughData\": {\n \"userId\": \"12345\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-umbrella.io/api/services/addImage")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"journeyId\": \"uniqueJourneyIdentifier\",\n \"imageName\": \"uploadedFileName\",\n \"imageSide\": \"front\",\n \"imageData\": \"base64EncodedImagestring\",\n \"storeOnly\": true,\n \"passThroughData\": {\n \"userId\": \"12345\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-umbrella.io/api/services/addImage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"journeyId\": \"uniqueJourneyIdentifier\",\n \"imageName\": \"uploadedFileName\",\n \"imageSide\": \"front\",\n \"imageData\": \"base64EncodedImagestring\",\n \"storeOnly\": true,\n \"passThroughData\": {\n \"userId\": \"12345\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Invalid request payload"
}{
"message": "Unauthorized request"
}{
"message": "Journey not found"
}Document Verification
Document Verification Add Image Service (Upcoming)
Document Verification Add Image Service API Documentation
POST
/
addImage
Add Image
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"
}
}
'import requests
url = "https://api-umbrella.io/api/services/addImage"
payload = {
"journeyId": "uniqueJourneyIdentifier",
"imageName": "uploadedFileName",
"imageSide": "front",
"imageData": "base64EncodedImagestring",
"storeOnly": True,
"passThroughData": { "userId": "12345" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
journeyId: 'uniqueJourneyIdentifier',
imageName: 'uploadedFileName',
imageSide: 'front',
imageData: 'base64EncodedImagestring',
storeOnly: true,
passThroughData: {userId: '12345'}
})
};
fetch('https://api-umbrella.io/api/services/addImage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-umbrella.io/api/services/addImage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'journeyId' => 'uniqueJourneyIdentifier',
'imageName' => 'uploadedFileName',
'imageSide' => 'front',
'imageData' => 'base64EncodedImagestring',
'storeOnly' => true,
'passThroughData' => [
'userId' => '12345'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-umbrella.io/api/services/addImage"
payload := strings.NewReader("{\n \"journeyId\": \"uniqueJourneyIdentifier\",\n \"imageName\": \"uploadedFileName\",\n \"imageSide\": \"front\",\n \"imageData\": \"base64EncodedImagestring\",\n \"storeOnly\": true,\n \"passThroughData\": {\n \"userId\": \"12345\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-umbrella.io/api/services/addImage")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"journeyId\": \"uniqueJourneyIdentifier\",\n \"imageName\": \"uploadedFileName\",\n \"imageSide\": \"front\",\n \"imageData\": \"base64EncodedImagestring\",\n \"storeOnly\": true,\n \"passThroughData\": {\n \"userId\": \"12345\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-umbrella.io/api/services/addImage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"journeyId\": \"uniqueJourneyIdentifier\",\n \"imageName\": \"uploadedFileName\",\n \"imageSide\": \"front\",\n \"imageData\": \"base64EncodedImagestring\",\n \"storeOnly\": true,\n \"passThroughData\": {\n \"userId\": \"12345\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Invalid request payload"
}{
"message": "Unauthorized request"
}{
"message": "Journey not found"
}For a usage description of the Document Verification Add Image Service, please refer to the Document Verification page.
Endpoint
POST/addImageAuthorizations
Bearer token obtained from POST /auth. Valid for 60 minutes.
Body
application/json
Unique identifier for the verification journey.
Example:
"uniqueJourneyIdentifier"
Name of the uploaded image file.
Example:
"uploadedFileName"
Specifies which side of the document (front, back, selfie).
Available options:
front, back, selfie Example:
"front"
Base64-encoded image or multipart file.
Example:
"base64EncodedImagestring"
If true, stores the image without classification.
Example:
true
Custom metadata (e.g., user ID).
Example:
{ "userId": "12345" }
Response
Successfully added image to journey.
⌘I