Skip to main content

Integration Settings

Integration Settings is where an Administrator connects the platform to the Company's systems. It has four tabs — API interface, Webhooks, Web redirect, and No-code — and, like all settings, is kept per environment, so Sandbox and Production hold separate values.

Editing on every tab requires the app-configuration permission (Administrator); other roles see the values read-only.

API interface​

For integrating your own application and backend against the platform APIs.

  • API credentials — your API client (client ID) and API secret (client secret), shown as read-only, copy-to-clipboard fields. These are the OAuth2 client-credentials your backend uses to call the Capture & Workflow API and the Customer API.
  • Generate API keys — the first use creates the API client; later uses issue a new secret for the same client ID and invalidate the old one, so a confirmation dialog guards it. The client is set up completely by the platform — its roles, its membership in your organization, and the access it needs. Access to the Customer API follows your tenant's record storage: it is granted while storage is enabled, and an existing client is updated when storage is switched on or off. Nothing needs to be configured by hand.

Webhooks​

Where the platform delivers webhooks — verification results, workflow events and record changes — to your backend.

  • Webhook endpoints — add one or more https:// URLs on a public host. Each endpoint gets its own signing secret, shown once when the endpoint is added and again only when you Rotate secret; copy it then. Each endpoint can be switched between Active and Paused, have its URL edited, or be deleted.
  • Include selfie in webhook — whether the workflow.completed result carries the selfie crop. On by default.
  • Failed webhook deliveries — View deliveries opens the list of events that could not be delivered, with the endpoint URL, event type, event ID, last HTTP status and time of failure. Replay sends an event again. A banner on the tab shows how many are waiting.

See Webhooks & Callbacks for the event types, payloads, signature verification and retry behaviour.

Web redirect​

Configuration for the hosted Website Redirect flow — where the platform returns users after they finish in the hosted verification app.

  • Enable web redirect — a toggle that turns the redirect flow on or off.
  • The return URLs and branding:
FieldUsed when
Verified URLVerification succeeded.
Rejected URLVerification was rejected. When empty, the user goes to the Unverified URL instead.
Unverified URLThe user cancelled, or the verification could not be completed for a technical reason.
Logo URLYour logo, displayed inside the hosted verification app.

Save with Save changes.

No-code​

Generate a ready-to-use hosted verification experience with no development at all.

  • Default workflow — choose and save which workflow the no-code link runs. You must have created a workflow first, and a default must be saved before a link can be generated.
  • Verification usage — in Sandbox, no-code verifications count against a verification limit; when the limit is reached the link is blocked and a Contact us action lets you request an increase.
  • Generate link / Revoke link — create or revoke the shareable link (Generate is disabled until a default workflow is saved).

Once a link exists, it is offered three ways (in a dialog with a tab for each):

FormatUse
QR codeA scannable QR code to download and print or display.
LinkA static URL to share directly.
EmbedAn <iframe> HTML snippet to embed in your own page.

See No-code / Low-code.

See also​