Web SDK

Verification screens

Understand the conditional screens and capture experiences controlled by an inquiry template.

Dynamic experience

Verification screens come from the inquiry's pinned template and open inside the SDK modal. The hosted application requests the next configured capability and can skip screens that are not part of that inquiry.

Customer details

Configured personal-information fields.

Identity document

Template-allowed document choices and pages.

Selfie

Shown only when face verification is configured.

Signature

Shown only when signature collection is configured.

Another device

Available on supported desktop capture screens.

Outcome

Completion and inquiry outcome messaging.

Personal information

Personal-information fields are configured for the inquiry. Each field can be enabled or disabled and can be optional or required.

NameTypeDescription
Full legal nametextCollected when enabled; validation is provided by the inquiry configuration.
Country of residencecountrySelected from the countries available to the inquiry.
EmailemailCan be disabled, optional, or required by the template.
Phoneinternational phoneCan be disabled, optional, or required by the template.

Identity documents

The document picker displays only the identity-document types allowed by the inquiry template. A template might allow one type or several alternatives.

NameTypeDescription
Passportfront pageCaptures the portrait identity page as a single image.
National IDfront and backCaptures the front first, followed by the back page.
Driving licencefront and backCaptures the front first, followed by the back page.

Capture and review

Camera or image upload

Supported document steps can use the device camera or an uploaded image. The customer reviews a capture before it is submitted and can retake it.

  • Camera capture checks framing, brightness, glare, contrast, sharpness, motion, distance, and stability.
  • Auto-capture can run when quality remains acceptable; a manual capture control remains available.
  • Uploads accept common browser image formats up to 20 MB and 4,096 pixels on the longest edge.
  • The hosted experience processes document images before submission.
  • Extracted document information can be presented for customer review before progression.

Selfie

When face verification is configured, the hosted experience asks the customer to take a selfie while holding the selected identity document. It uses the front-facing camera and provides live framing guidance.

  • The customer and the document portrait must both be visible.
  • The customer should face forward and avoid overlapping faces.
  • Capture can occur automatically after stable checks pass, with a manual capture option available.
  • The customer can retry before continuing.

Signature

When configured, customers can draw a signature or upload a signature image. The hosted experience processes the image into a normalized signature artifact and allows retry before submission.

Cross-device continuation

Supported desktop capture screens can offer continuation on another device. The customer opens or receives a temporary continuation link, completes the handoff, and resumes the same inquiry on the second device.

Completion

When the configured flow finishes, the hosted experience displays the applicable completion or inquiry outcome. The SDK tears down the session, then invokes onComplete. Call init() again before opening another inquiry.

Backend systems should continue to use inquiry webhooks or the merchant inquiry endpoint as the source of truth for final status.

Browser requirements

  • Serve the host application over HTTPS.
  • Allow camera access for the hosted verification frame.
  • Use a current browser with camera, canvas, image decoding, and cross-origin frame support.
  • Keep the page visible while capturing; progress refreshes when the customer returns to the tab.
  • Mobile and tablet capture generally use portrait orientation; signature collection may request landscape orientation.