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

# Get KYC Link

> Returns the identity verification link for a customer (basic → verified). Redirect your customer to `verification_url`.

You can call this endpoint as many times as you need:

- **First call** — opens a verification session and returns its link (`201`).
- **Link still valid** — returns the same link (`200`, `reused: true`).
- **Link expired, verification rejected or resubmission requested** — returns a new link (`201`).
- **`force: true`** — always returns a new link.

The verification is billed **only when it is approved** (2 USD, debited from your `others` ops balance).
Generating a link is free, but your `others` balance must cover the price of one verification.

The customer profile must be complete (`first_name`, `last_name`, `email`, `phone_country_code`, `phone`,
`address`, `city`, `state`, `postal_code`, `country`). Otherwise the call returns a `422` with the list of
`missing_fields`: update the customer, then request the link again.

The result is sent to your webhook endpoint (`kyc.approved`, `kyc.rejected`, `kyc.expired`,
`kyc.pending_review`, `kyc.resubmission_requested`) and is available through the KYC status endpoint.

If the KYC is approved but the identity read on the document differs from the one you declared, the customer
becomes `restricted` and a `kyc.identity_mismatch` webhook is sent: call the synchronize endpoint.




## OpenAPI

````yaml POST /kyc/{customerCode}/link
openapi: 3.1.0
info:
  title: KemyCard API
  version: '1.0'
  description: >
    KemyCard API allows you to issue virtual and physical cards, manage KYC/POA
    verification,

    create crypto wallets, virtual bank accounts, and purchase gift cards.
  contact:
    name: KemyCard API Support
    email: hi@kemycard.com
servers:
  - url: https://api.kemycard.com/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Customers
    description: Manage your customers
  - name: Card Products
    description: Browse the card product catalog
  - name: Cards
    description: Issue and manage cards
  - name: KYC
    description: Identity verification
  - name: POA
    description: Proof of address verification
  - name: Wallets
    description: Crypto wallets
  - name: Virtual Accounts
    description: Virtual bank accounts
  - name: Gift Cards
    description: Gift card catalog and purchases
  - name: Balance
    description: Operational balances and transaction history
  - name: Webhooks
    description: Webhook endpoints and delivery management
paths:
  /kyc/{customerCode}/link:
    post:
      tags:
        - KYC
      summary: Get KYC verification link
      description: >
        Returns the identity verification link for a customer (basic →
        verified). Redirect your customer to `verification_url`.


        You can call this endpoint as many times as you need:


        - **First call** — opens a verification session and returns its link
        (`201`).

        - **Link still valid** — returns the same link (`200`, `reused: true`).

        - **Link expired, verification rejected or resubmission requested** —
        returns a new link (`201`).

        - **`force: true`** — always returns a new link.


        The verification is billed **only when it is approved** (2 USD, debited
        from your `others` ops balance).

        Generating a link is free, but your `others` balance must cover the
        price of one verification.


        The customer profile must be complete (`first_name`, `last_name`,
        `email`, `phone_country_code`, `phone`,

        `address`, `city`, `state`, `postal_code`, `country`). Otherwise the
        call returns a `422` with the list of

        `missing_fields`: update the customer, then request the link again.


        The result is sent to your webhook endpoint (`kyc.approved`,
        `kyc.rejected`, `kyc.expired`,

        `kyc.pending_review`, `kyc.resubmission_requested`) and is available
        through the KYC status endpoint.


        If the KYC is approved but the identity read on the document differs
        from the one you declared, the customer

        becomes `restricted` and a `kyc.identity_mismatch` webhook is sent: call
        the synchronize endpoint.
      operationId: getKycLink
      parameters:
        - name: customerCode
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Customer UUID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                callback_url:
                  type: string
                  format: uri
                  description: >-
                    Optional. HTTPS URL your customer is redirected to after the
                    verification. If omitted, your customer is not redirected
                    back to your application at the end of the flow
                  example: https://yourapp.com/kyc/done
                lang:
                  type: string
                  description: 2-letter language code of the verification screen
                  default: en
                  example: en
                force:
                  type: boolean
                  description: >-
                    Set to true to get a new link even if the current one is
                    still valid
                  default: false
      responses:
        '200':
          description: Existing link still valid, returned as is
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycLinkResponse'
        '201':
          description: New verification link created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycLinkResponse'
        '400':
          $ref: '#/components/responses/InsufficientBalance'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    KycLinkResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            customer_code:
              type: string
              format: uuid
            kyc_status:
              type: string
              enum:
                - pending
              example: pending
            verification_url:
              type: string
              format: uri
              description: URL to redirect your customer to
              example: https://verify.kemycard.com/v/abc123
            expires_at:
              type: string
              format: date-time
              description: >-
                Until this date, calling the endpoint again returns the same
                link
            reused:
              type: boolean
              description: >-
                True when the returned link is the existing one, false when a
                new link was created
              example: false
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Missing required fields.
            details:
              type: object
              nullable: true
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      properties:
        request_id:
          type: string
          example: a4f8e2c1b3d97056
        mode:
          type: string
          enum:
            - test
            - live
          example: test
        timestamp:
          type: string
          format: date-time
  responses:
    InsufficientBalance:
      description: Insufficient ops balance
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INSUFFICIENT_BALANCE
              message: Insufficient ops balance.
              details:
                required: 50
                available: 10
                balance_type: cards_mastercard
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: RESOURCE_NOT_FOUND
              message: Resource not found.
              details: null
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key (sk_test_... or sk_live_...)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.