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

# Create KYC inquiry

> Creates a KYC inquiry. Redirect the end user to `https://idv.inklink.com?inquiry_id=<id>` using the `id` from this response. When the hosted flow finishes, the user is returned to your `return_url` with the outcome in the query string (`status` and `inquiry_id`). For full result JSON from your server, use `GET /kyc/inquiry/{id}/result`. See [KYC Quickstart](/kyc/quickstart) for the full flow.



## OpenAPI

````yaml /api-reference/openapi.json POST /kyc/inquiry
openapi: 3.0.3
info:
  title: API 2.0
  version: 1.0.0
  contact: {}
servers:
  - url: https://platform.inklink.com/api/v1
security: []
tags: []
paths:
  /kyc/inquiry:
    post:
      summary: Create KYC inquiry
      description: >-
        Creates a KYC inquiry. Redirect the end user to
        `https://idv.inklink.com?inquiry_id=<id>` using the `id` from this
        response. When the hosted flow finishes, the user is returned to your
        `return_url` with the outcome in the query string (`status` and
        `inquiry_id`). For full result JSON from your server, use `GET
        /kyc/inquiry/{id}/result`. See [KYC Quickstart](/kyc/quickstart) for the
        full flow.
      operationId: createKycInquiry
      parameters:
        - name: api-key
          in: header
          schema:
            type: string
            example: secret_live_xxx
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subject_id:
                  type: string
                  description: Your stable identifier for the subject being verified.
                  example: user_123
                return_url:
                  type: string
                  format: uri
                  description: >-
                    URL where the user is redirected after the hosted IDV flow
                    completes.
                level:
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                  description: >-
                    Preset: 1 = document + selfie, 2 = + address, 3 = +
                    PEP/AML/adverse media. Mutually exclusive with `features`.
                features:
                  type: object
                  additionalProperties: true
                  description: >-
                    Feature map (`doc_scan`, `selfie_scan`, etc.). Mutually
                    exclusive with `level`.
                metadata:
                  type: object
                  additionalProperties:
                    type: string
              required:
                - subject_id
                - return_url
      responses:
        '200':
          description: Inquiry created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: kyc_iq_xxx
                  subject_id:
                    type: string
                  features:
                    type: object
                  return_url:
                    type: string
                  metadata:
                    type: object
                    nullable: true
                  expires_at:
                    type: string
                    format: date-time
                  level:
                    type: integer
                    nullable: true
                    enum:
                      - 1
                      - 2
                      - 3
                  created_by:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true

````