​

Document Verification (UI) — Preview

​

When to use this

• You want to keep users inside your app instead of sending them to the Hosted UI.
• You need fine-grained layout and UX control.
• You plan to combine steps (e.g., document first, FaceMatch later).

​

How it works

• Multi-step (recommended)
  1. Open a verification journey → /openJourney
  2. Add images as they are captured → /addImage (front/back/selfie)
  3. Verify the collected images → /verify
  4. (Optional) Age/Disability check → /verify/age
• Single-step
  Submit all images at once → /verifySingle (no intermediate feedback for missing pages).

​

Prerequisites

• SDK Authentication configured (see SDK → Authentication).
• A webhook URL + secret (recommended) to receive final results.

​

Quick start (mount the widget)

<div id="doc-root"></div>
<script type="module">
  import { IdCanopy } from "idcanopy-sdk";

  const canopy = new IdCanopy({
    apiKey: "...",
    customerId: "...",
    environment: "sandbox"
  });

  await canopy.auth.getToken();

  // 1) Open a doc verification journey (provider)
  const { journeyId } = await canopy.documentVerification.openJourney();

  // 2) Mount the UI component
  const unmount = canopy.ui.documentVerification.mount(
    document.getElementById("doc-root"),
    {
      journeyId,                // required
      allowUpload: false,       // camera-first UX
      sides: ["front", "back"], // widget will prompt in order
      selfieRequired: true,     // include a selfie step if your flow needs it
      locale: "en",
      theme: "light"
    }
  );

  // 3) Listen for lifecycle events (optional)
  const off = canopy.ui.on("document.verification.completed", (e) => {
    console.log("Verification completed", e);
    // Typically you'll wait for the webhook for authoritative results.
  });
</script>

​

Events

• document.ready — widget mounted and camera ready.
• document.capture.started — user starts capturing a side.
• document.image.added — /addImage succeeded for a side.
• document.verification.started — /verify called.
• document.verification.completed — verify finished (you’ll still get the webhook for authoritative results).
• document.error — fatal error (e.g., camera block, invalid image).

const off = canopy.ui.on("document.image.added", (e) => {
  // e: { journeyId, imageSide: "front"|"back"|"selfie", imageName }
});

​

Using the SDK without the widget (service methods)

​

Results

• proofOfWork entries for documentFront, documentBack, selfie (if used)
• authoritativeData.identityDocument (type, idNumber, issuingCountry, expirationDate, verificationChannel, etc.)
• A steps[] item for the document step with its status

​

Errors