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

# Generate KYC link

> Returns a hosted verification URL the customer can open in a browser — an alternative to uploading documents through the API. The response says how long the link lasts.



## OpenAPI

````yaml api-reference/endl-onboarding-api.json POST /api/v0/customer/{userId}/kyc-link
openapi: 3.1.0
info:
  title: Endl Partner Onboarding API
  version: '0'
  description: >-
    Onboard end customers for identity verification — individuals (KYC) and
    businesses (KYB) — through one uniform REST surface.


    Authentication is API-key only: every request carries a single `API-KEY`
    header. Unlike the Partner API, responses are **flat** — a successful body
    is the data object itself, with no `{ data, code, message, status }`
    envelope.
servers:
  - url: https://qa-api.endl.xyz
    description: QA
security:
  - apiKey: []
tags:
  - name: Customers
    description: Create, read, update and delete onboarding customers.
  - name: Documents
    description: Upload identity, company and beneficial-owner documents.
paths:
  /api/v0/customer/{userId}/kyc-link:
    parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Customers
      summary: Generate KYC link
      description: >-
        Returns a hosted verification URL the customer can open in a browser —
        an alternative to uploading documents through the API. The response says
        how long the link lasts.
      responses:
        '200':
          description: A hosted verification link.
          content:
            application/json:
              example:
                url: https://in.sumsub.com/websdk/p/sbx_example
                userId: 6c4ba9af-978a-45ff-953f-729c593f14af
                ttlSeconds: 3600
                expiresAt: '2026-09-09T18:36:03Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The customer is already verified, so a new link is not needed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: '409'
                message: >-
                  This customer's KYC is already completed; a new verification
                  link is not needed
                name: PartnerOnboardingKycLink failed to process
components:
  responses:
    Unauthorized:
      description: Missing or invalid `API-KEY`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: '401'
            message: Authentication Failed!
            name: PartnerOnboarding failed to process
    Forbidden:
      description: >-
        The key lacks the `onboarding` permission, the customer belongs to
        another partner, or onboarding is not permitted for that country.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: '403'
            message: Onboarding is not permitted for this country
            name: PartnerOnboardingCreate failed to process
    NotFound:
      description: Customer or owner not found. A deleted customer also returns 404.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: '404'
            message: Not found
            name: PartnerOnboardingGet failed to process
  schemas:
    Error:
      type: object
      description: >-
        A single problem. `code` is the HTTP status, `message` the specific
        reason, and `name` the operation that failed.
      properties:
        code:
          type: string
        message:
          type: string
        name:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: API-KEY
      description: Your partner API key. The key must carry the `onboarding` permission.

````