> ## 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.

# Retrieve KYC Requirements

> Retrieves the specific Know Your Customer (KYC) requirements, detailing the fields and document types needed for customer verification.

<Note>
  KYC requirements are determined by the country your account is configured for. If your account operates in Argentina, the fields and document types returned will correspond to Argentine regulations. You do not need to filter by country — the response is already scoped to your account's country.
</Note>


## OpenAPI

````yaml ramps-api/openapi.json GET /api/v1/kycRequirements/
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/kycRequirements/:
    get:
      tags:
        - KYC
      summary: Retrieve KYC Requirements
      description: >-
        Retrieves the specific Know Your Customer (KYC) requirements, detailing
        the fields and document types needed for customer verification.
      operationId: getKycRequirements
      responses:
        '200':
          description: Successfully retrieved KYC requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycRequirementsResponse'
              example:
                kycRequiredFields:
                  - fieldName: legalFirstName
                    required: true
                    type: TEXT
                  - fieldName: legalLastName
                    required: true
                    type: TEXT
                  - fieldName: dateOfBirth
                    required: true
                    type: DATE
                  - fieldName: idNumber
                    required: true
                    type: TEXT
                  - fieldName: nationality
                    required: true
                    type: TEXT
                    choices:
                      - value: AR
                        label: Argentina
                      - value: BR
                        label: Brazil
                      - value: CO
                        label: Colombia
        '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
components:
  schemas:
    KycRequirementsResponse:
      type: object
      properties:
        kycRequiredFields:
          type: array
          items:
            $ref: '#/components/schemas/KycRequiredField'
      required:
        - kycRequiredFields
    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
    KycRequiredField:
      type: object
      properties:
        fieldName:
          type: string
          description: The technical name of the required field used within the API.
        required:
          type: boolean
          description: Indicates whether the field is mandatory (true) or optional (false).
        type:
          type: string
          description: >-
            The data type expected for the field value (e.g., TEXT, DATE,
            FILE_UPLOAD).
        choices:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
          description: >-
            A list of valid options for the field. This is only present for
            fields that have a predefined set of values.
      required:
        - fieldName
        - required
        - type
  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>`.

````