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

# Initiate Cl@ve

> Initiates the Cl@ve identity verification process for a tenant.

### Asynchronous Operation
This endpoint initiates an **Asynchronous process**. The API response
confirms that the Cl@ve flow has been started, While document
downloads are completed in the background.

**How this flow works:**
1. Provide a `redirect_url` where the tenant should be redirected after completing verification.
2. The API will respond with a verification link.
3. Redirect the tenant to the provided link.
4. The tenant completes identity verification by entering their details on the Cl@ve page.
5. After successful verification, identity documents are automatically downloaded.
6. Once the process is complete, call ***Get Tenant Documents*** to retrieve the downloaded documents.


**Important:**
- The `redirect_url` must be a valid, publicly accessible URL.
- Document availability depends on successful completion of the Cl@ve flow.
- This endpoint only initiates the process; it does not return documents immediately.

**Clave completion webhook:**
When Clave flow is completed successfully, a webhook event
`CLAVE_SUCCESS` is sent.

**The webhook payload contains:**
- `event`: Event name (`CLAVE_SUCCESS`)
- `data`: null (This webhook event is used only to indicate that the Clave flow has completed successfully and documents are downloaded)

The configured webhook endpoint **must accept POST requests**.




## OpenAPI

````yaml /api-reference/openapi.yaml post /tenants/initiate-clave/{tenantId}
openapi: 3.1.0
info:
  title: SKOR Modular API
  version: 1.0.0
  description: >
    ## Overview

    This is the SKOR Modular API v1. It provides access to tenant

    workflows, API keys, webhooks, document processing, identity

    verification, banking connectivity, and forensic analysis.


    ## Error Statuses


    The API uses standard HTTP status codes to indicate the success

    or failure of requests. Each error response provides guidance

    to help identify the issue and take corrective action.


    ### Success — `200 OK`

    The request was processed successfully and the expected response

    data is returned.


    ### Validation Error — `400 Bad Request`

    The request is invalid due to missing, malformed, or incorrect

    parameters.


    **Common causes:**

    - Required fields are missing from the request.

    - Invalid data formats or unsupported values are provided.

    - File size or payload limits are exceeded.


    **How to resolve:**

    - Verify all required parameters are present.

    - Ensure the request payload matches the documented schema.

    - Validate data formats and constraints before retrying.


    ### Unauthorized — `401 Unauthorized`

    Authentication failed or the provided token is missing or invalid.


    **Common causes:**

    - The `Authorization` header is missing.

    - An invalid or expired bearer token is provided.


    **How to resolve:**

    - Ensure the token is included in the request as an `Authorization: Bearer
    <token>` header.

    - Verify the token is valid and has not expired.

    - Generate a new token if required.


    ### Not Found — `404 Not Found`

    The requested resource does not exist or is not accessible.


    **Common causes:**

    - An invalid or non-existent resource identifier.

    - The resource has not been created or has been deleted.


    **How to resolve:**

    - Confirm the resource identifier is correct.

    - Ensure the resource exists before accessing it.


    ### Server Error — `500 Internal Server Error`

    An unexpected error occurred on the server while processing the request.


    **How to resolve:**

    - Retry the request after a short delay.

    - If the issue persists, **[contact us](mailto:info@skortorent.com)** with
    relevant request details.


    ### Need Help?

    If you encounter unexpected behavior,

    please **[contact us](mailto:info@skortorent.com)** for assistance.
servers:
  - url: https://api.skortorent.com/api/v1
    description: Live
  - url: https://dev-api.skortorent.com/api/v1
    description: Sandbox
security:
  - BearerAuth: []
paths:
  /tenants/initiate-clave/{tenantId}:
    post:
      tags:
        - Tenants
      summary: Initiate Cl@ve
      description: >
        Initiates the Cl@ve identity verification process for a tenant.


        ### Asynchronous Operation

        This endpoint initiates an **Asynchronous process**. The API response

        confirms that the Cl@ve flow has been started, While document

        downloads are completed in the background.


        **How this flow works:**

        1. Provide a `redirect_url` where the tenant should be redirected after
        completing verification.

        2. The API will respond with a verification link.

        3. Redirect the tenant to the provided link.

        4. The tenant completes identity verification by entering their details
        on the Cl@ve page.

        5. After successful verification, identity documents are automatically
        downloaded.

        6. Once the process is complete, call ***Get Tenant Documents*** to
        retrieve the downloaded documents.



        **Important:**

        - The `redirect_url` must be a valid, publicly accessible URL.

        - Document availability depends on successful completion of the Cl@ve
        flow.

        - This endpoint only initiates the process; it does not return documents
        immediately.


        **Clave completion webhook:**

        When Clave flow is completed successfully, a webhook event

        `CLAVE_SUCCESS` is sent.


        **The webhook payload contains:**

        - `event`: Event name (`CLAVE_SUCCESS`)

        - `data`: null (This webhook event is used only to indicate that the
        Clave flow has completed successfully and documents are downloaded)


        The configured webhook endpoint **must accept POST requests**.
      parameters:
        - $ref: '#/components/parameters/TenantIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - redirect_url
              properties:
                redirect_url:
                  type: string
                  format: uri
                  description: >-
                    URL to redirect the tenant after completing Cl@ve
                    verification
                  example: https://yourapp.com/kyc/callback
      responses:
        '200':
          $ref: '#/components/responses/SuccessResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/ErrorResponse'
        '500':
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    TenantIdParam:
      name: tenantId
      in: path
      required: true
      schema:
        type: string
  responses:
    SuccessResponse:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - success
              message:
                type: string
              data:
                type: object
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              message:
                type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        HTTP Bearer Authentication. Pass the token generated via
        `/keys/generate-token` as `Authorization: Bearer <token>`.

````