> ## Documentation Index
> Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# KYC Links

> Verify individuals through a Sumsub-hosted link, with the result recorded on their entity

<Info>
  **Coming soon.** KYC Links is under active development and is not yet available. This documentation is published ahead of launch. At launch, KYC Links supports **individual entities**. Business verification (KYB Links) is coming soon.
</Info>

<Note>
  KYC Links must be enabled for your account. To get started, reach out to your **Customer Success Manager (CSM)**.
</Note>

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

| Use case | Challenge | How KYC Links helps |
| - | - | - |
| Platforms without their own onboarding or KYC stack, such as marketplaces onboarding sellers | Building document collection and verification takes engineering time and a specialist vendor | Generate a link with one API call. Verification runs on the Sumsub-hosted page, and the result lands on the entity |
| Platforms that don't want to handle sensitive ID documents | Collecting passports and proofs of address means storing and securing personal data in your own systems | Individuals upload documents directly on the hosted page. You receive the verification result and extracted details, not the document files |

## How it works

<Steps>
  <Step title="Create the entity">
    Create an entity with the [Create Entity](/api-reference/tazapay-api/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.
  </Step>

  <Step title="Generate a KYC link">
    Generate a Sumsub-hosted verification link for the entity with a single API call. Links are valid for 30 days by default, configurable from 7 to 90 days.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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**.
  </Step>

  <Step title="Receive the result">
    You receive a webhook on every status change, and can retrieve the latest state at any time. Completed results include the checks performed, the details extracted from the documents, and any rejection reasons.
  </Step>
</Steps>

### 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 balance to cover the verification fee.

## Link statuses

| Status | Meaning | What to do |
| - | - | - |
| `pending` | Link is active and verification is in progress | Wait for the next webhook |
| `requires_action` | The individual needs to resubmit a document | Direct them back to the same link |
| `approved` | Verification passed | No action needed |
| `rejected` | Verification failed permanently | Review the rejection reasons |
| `expired` | Link expired, or was expired via the API | Generate a new link if needed |

## 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](/managed-payments/onboarding-requirements/onboarding-requirements-individuals).

## API reference

| Operation | Method | Path |
| - | - | - |
| Generate a KYC link | `POST` | `/v3/entity/{entity_id}/kyc_link` |
| Retrieve a KYC link and its result | `GET` | `/v3/entity/{entity_id}/kyc_link` |
| Update KYC link metadata | `PUT` | `/v3/entity/{entity_id}/kyc_link` |
| Expire a KYC link | `POST` | `/v3/entity/{entity_id}/kyc_link/expire` |

<CardGroup cols={2}>
  <Card title="Generate a KYC link" icon="link" href="/api-reference/tazapay-api/generate-kyc-link">
    Create a Sumsub-hosted verification link for an individual entity
  </Card>

  <Card title="Retrieve a KYC link" icon="magnifying-glass" href="/api-reference/tazapay-api/retrieve-kyc-link">
    Get the link status and verification result
  </Card>

  <Card title="Update KYC link metadata" icon="pen-to-square" href="/api-reference/tazapay-api/update-kyc-link-metadata">
    Attach your own reference data to the link
  </Card>

  <Card title="Expire a KYC link" icon="clock" href="/api-reference/tazapay-api/expire-kyc-link">
    Deactivate an active link before it expires
  </Card>

  <Card title="KYC link webhooks" icon="bell" href="/api-reference/tazapay-api/kyc-link-webhook">
    Events sent on every link status change
  </Card>
</CardGroup>