Skip to main content
KYC Links supports individual entities. Business verification (KYB Links) is coming soon.
KYC Links must be enabled for your account. To get started, reach out to your Customer Success Manager (CSM).
KYC Links lets you verify individuals without building your own document collection or verification flow. You generate a Sumsub-hosted verification link for an entity and share it with the individual. They complete identity verification on the hosted page, and the result is recorded against the entity and sent to you by webhook.

Why it matters

How it works

1

Create the entity

Create an entity with the Create Entity API, with type set to individual. Include name, relationship and purpose_of_use — all are required before a link can be generated. Adding the individual’s email is optional but recommended, so they receive the verification link and updates directly.
2

Generate a KYC link

Generate a KYC link for the entity with a single API call. Links are valid for 30 days by default, configurable from 30 minutes to 30 days with expiry_seconds. An unexpired pending or requires_action link is returned unchanged, and a different expiry value does not extend it. Links are not renewed automatically. Once a link expires, you must generate a new one and share it with the individual.
3

Share the link

If the entity has an email address, Sumsub emails the link to the individual. You can also share it yourself by SMS or in your app.
4

The individual completes verification

They upload a proof of identity and a proof of address, and complete a liveness check where configured for your account. If a document needs to be resubmitted, they return to the same link.
5

Receive the result

You receive KYC link webhooks for status changes and can retrieve the latest state at any time. Available results include the checks performed, the details extracted from the documents, and any rejection reasons. Optional fields depend on the documents and review.

Before you begin

  • KYC Links is enabled for your account.
  • The entity has type set to individual and is in initiated status (not yet submitted), with name, relationship and purpose_of_use populated. An email is optional but recommended.
  • Your account has sufficient available balance to cover the configured verification fee when generation requires a pricing check.
Approved and rejected links cannot be regenerated or manually expired. An already-expired link can be expired again without triggering another expiry event. Submitting the entity with Submit Entity expires an active pending or requires_action link and sends a kyc_link.expired webhook. Once a link has been generated, the entity’s name cannot be changed with Update Entity (error 2935).

Branding

By default, the verification page your customer sees carries Tazapay and Sumsub branding. It can be customised to show your own logo and brand styling alongside Sumsub’s. Custom branding is set up on request and is subject to approval by our compliance team. To get started, reach out to your account manager.

Accepted documents

Individuals can verify with a passport, national ID card, or residence permit as proof of identity, and a utility bill, bank statement, or other valid document as proof of address. Accepted documents vary by issuing country. See Onboarding requirements for individuals.

API reference

See KYC Link for the object fields. Metadata updates replace the complete metadata object.

Generate a KYC link

Create a Sumsub-hosted verification link for an individual entity

Retrieve a KYC link

Get the link status and verification result

Update KYC link metadata

Attach your own reference data to the link

Expire a KYC link

Deactivate an active link before it expires

KYC link webhooks

Events sent on every link status change