IDCanopy Developers
IDCanopy APIKYC

Document Verification

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

Document-based identification

Use document verification when the case calls for identity evidence from document images. Your application collects the images and your backend submits them for verification. This is the document route described in the IDCanopy KYC overview, alongside data-based 2×2 KYC and identification through an existing bank account.

The broader KYC product includes document, chip and biometric capabilities. This page documents the image-based API below; it does not establish NFC or liveness support for these endpoints.

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.

Verification sequence

Open a journey, add images, then verify
Open a journey, add images, then verifyYour backend to IDCanopy API: POST /openJourney. IDCanopy API to Your backend: Return journeyId. Your backend to IDCanopy API: POST /addImage with journeyId and one image (repeat as needed). IDCanopy API to Your backend: Image accepted. Your backend to IDCanopy API: POST /verify with journeyId. IDCanopy API to Your backend: Return identity data, auditTrail and fraudAlertsYour backendIDCanopy API1. POST /openJourney2. Return journeyId3. POST /addImage with journeyId and one image (repeat as needed)4. Image accepted5. POST /verify with journeyId6. Return identity data, auditTrail and fraudAlerts

Submit the document sides and selfie required for your integration. Keep the same journeyId across the calls. Upload acceptance is not an identity decision; inspect auditTrail.workStatus and the fraud evidence from verification. The response is returned by the API, not by a workflow webhook.

Use the journey route when images arrive in stages. If all images are ready together, POST /verifySingle accepts them in one request without a separate /openJourney call. Age eligibility is a separate /verify/age operation, not an automatic extra step in this sequence.

Request

POST /openJourney, optional passThroughData object, any shape.

POST /addImage, one image object per call, associated with the opened journey:

FieldRequiredDescription
journeyIdyesIdentifier returned by /openJourney
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

Test cases are not available yet. Contact IDCanopy: office@idcanopy.com.

Reference

The operations of this topic and the token call. The full Umbrella API reference has every topic.

Send request against Production or Sandbox needs a bearer token from POST /auth and a server-side or allowed origin. In the browser, use Mock.

On this page