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

# Check KYC Status & Send OTP

> Checks the customer's KYC status with Ripio to determine if they can be fast-tracked through onboarding.

- **If the customer has a previously approved KYC with Ripio**, this endpoint sends a One-Time Password (OTP) to their email. You can then use the `POST /customers/{customerId}/otp/` endpoint to validate the OTP and instantly approve the customer's KYC with your service, skipping the full data submission process.

- **If the customer's KYC is not approved with Ripio** (indicated by a `KycNotApprovedException`), you must guide them through the standard KYC process. This involves retrieving the required fields via `GET /kycRequirements/` and submitting their data using `POST /customers/{customerId}/kyc/`.

- **If the customer's KYC has already been approved with your service**, a `KycAlreadyApprovedException` will be returned.



## OpenAPI

````yaml ramps-api/openapi.json POST /api/v1/customers/{customerId}/checkKyc/
openapi: 3.1.0
info:
  title: Ripio Ramp API
  version: v1
  description: >-
    API for Ripio ramp services, enabling partners to integrate On-Ramp,
    Off-Ramp, customer management, KYC processes, and other financial
    functionalities. This API is RESTful, uses JSON for requests and responses,
    and standard HTTP status codes. This document is based on the
    'onramp-api.pdf' provided and aims to be compliant with OpenAPI
    Specification v3.1.0. The PDF indicates that the API documentation is a
    draft and subject to change.
servers:
  - url: https://skala-sandbox.ripio.com
    description: Sandbox environment
  - url: https://skala.ripio.com
    description: Production environment
security:
  - BearerToken: []
tags:
  - name: Authentication
    description: Operations related to API authentication and authorization.
  - name: Customers
    description: Operations related to customer management.
  - name: KYC
    description: Operations related to Know Your Customer processes.
  - name: Fiat Accounts
    description: Operations related to managing fiat accounts and their requirements.
  - name: Quotes
    description: Operations related to obtaining and managing conversion quotes.
  - name: On-Ramp
    description: Operations related to fiat-to-crypto (on-ramp) processes.
  - name: Off-Ramp
    description: Operations related to crypto-to-fiat (off-ramp) processes.
  - name: Transactions
    description: Operations related to listing and managing all transaction types.
  - name: Networks
    description: >-
      Operations related to retrieving available deposit and withdrawal
      networks.
  - name: Rates
    description: Operations related to retrieving market rates.
  - name: Sandbox
    description: Operations specific to the sandbox environment for testing purposes.
  - name: Webhooks
    description: Webhook event notifications from Ripio Ramp API.
  - name: Sell and Pay
    description: >-
      Endpoints for managing Sell and Pay transactions, which allow customers to
      convert cryptocurrency to fiat currency and pay merchants via QR codes
paths:
  /api/v1/customers/{customerId}/checkKyc/:
    post:
      tags:
        - KYC
      summary: Check KYC Status & Send OTP
      description: >-
        Checks the customer's KYC status with Ripio to determine if they can be
        fast-tracked through onboarding.


        - **If the customer has a previously approved KYC with Ripio**, this
        endpoint sends a One-Time Password (OTP) to their email. You can then
        use the `POST /customers/{customerId}/otp/` endpoint to validate the OTP
        and instantly approve the customer's KYC with your service, skipping the
        full data submission process.


        - **If the customer's KYC is not approved with Ripio** (indicated by a
        `KycNotApprovedException`), you must guide them through the standard KYC
        process. This involves retrieving the required fields via `GET
        /kycRequirements/` and submitting their data using `POST
        /customers/{customerId}/kyc/`.


        - **If the customer's KYC has already been approved with your service**,
        a `KycAlreadyApprovedException` will be returned.
      operationId: checkKycAndSendOtp
      parameters:
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: KYC approved in Ripio and OTP sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycCheckSuccessResponse'
        '400':
          description: >-
            Bad Request - e.g., KYC already approved by partner, KYC not
            approved in Ripio, or other validation errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                kycAlreadyApproved:
                  summary: KYC already approved by partner
                  value:
                    code: 20015
                    type: KycAlreadyApprovedException
                    detail:
                      message: >-
                        KYC for customer '660c406c-918e-494d-acec-049758a0b413 -
                        individual@mail.com' is approved.
                    status: 400
                kycNotApprovedInRipio:
                  summary: KYC not approved in Ripio
                  value:
                    code: 20007
                    type: KycNotApprovedException
                    detail:
                      message: >-
                        KYC for customer '0ff137ac-3ef5-464d-b6c5-a6aac8f75843 -
                        individual@mail.com' is not approved.
                    status: 400
        '401':
          description: Unauthorized - Invalid or missing access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40001
                type: NotAuthenticated
                detail:
                  message: Authentication credentials were not provided.
                  code: not_authenticated
                status: 401
        '404':
          description: Not Found - Customer not found or inactive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40004
                type: NotFound
                detail:
                  message: Not found.
                  code: not_found
                status: 404
components:
  parameters:
    CustomerId:
      name: customerId
      in: path
      required: true
      description: Unique identifier for the customer.
      schema:
        type: string
        format: uuid
      example: 8142b065-79c4-4f48-9e33-11b17bc658d4
  schemas:
    KycCheckSuccessResponse:
      type: object
      properties:
        detail:
          type: string
          example: kyc approved. Otp sent
      required:
        - detail
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Application-specific error code.
        type:
          type: string
          description: Type of error or exception.
        detail:
          type: object
          properties:
            message:
              type: string
              description: Detailed error message.
          additionalProperties: true
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - type
        - detail
        - status
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained via
        [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as
        `Authorization: Bearer <access_token>`.

````