IDCanopy Developers
Umbrella API

Document Verification

Open a journey, submit document images, verify identity and age

What it returns

A journey-based flow: open a journey, add document/selfie images, then verify. The verify step returns the extracted identity data and a pass/fail audit trail; the age step returns an eligibility boolean.

Request

POST /openJourney, optional passThroughData object, any shape.

POST /addImage, a single image object or an array of image objects:

FieldRequiredDescription
imageNameyesName of the uploaded image
imageSideyesfront, back, selfie
imageDatayesBase64-encoded image or multipart file
storeOnlynoIf true, stores without classification
passThroughDatanoCustom metadata

POST /verify, { "journeyId": "..." }.

POST /verify/age, journeyId required, plus ageFrom/ageTo (mutually exclusive) and minDisabilityPercentage.

POST /verifySingle, request body is a bare array of image objects (not wrapped in an images key), each with imageName, imageSide, imageData required.

Response

/openJourney returns journeyId. /addImage returns journeyId and per-image imageId, stored, classified. /verify returns status, identitySubject (name, dob, nationality, address), authoritativeData.identityDocument, auditTrail.workStatus (PASS/FAIL), fraudAlerts. /verify/age returns ageResult (yes/no) and disabilityResult (eligible/not eligible).

Decision

The caller decides from auditTrail.workStatus and fraudAlerts.aggregateFraudAlertScore for identity; from ageResult for age eligibility.

Test cases

Pending.

Reference

Umbrella API reference.

On this page