> ## 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. > This endpoint returns a list of fields that needs to be provided on a KYC submission. The response is structured in a list of fields so that an UI can be constructed from it. # KYC Requirements Each field has the following structure: ```json theme={null} { "field_name": string, "required": boolean, "type": string (TEXT, BOOLEAN, DATE, NUMERIC, CHOICE), "choices": array, "value": label, "label": string } ``` Notes: * `id_number` is DNI for Argentina. * `registered_tax_payer` in Argentina is "Responsable Inscripto". ## OpenAPI ````yaml crypto-as-a-service/openapi.json GET /api/v1/kyc-requirements/ openapi: 3.0.2 info: title: B2B API version: '1.0' description: >- B2B API allows a third party to access different use cases and services inside of Ripio ecosystem. It is organized around RESTful constraints, with requests and responses in JSON format, using HTTP in the standard format and the answer codes. The API is designed to be compliant with OpenAPI Specification v3.0, which is a trusted open source standard for HTTP-Based APIs. The API offers the ability to test it with a simple, yet powerful sandbox that will enhance developer experience and replicate production capabilities in a well isolated and safe environment, giving developers full freedom to try the integration without compromises. # Error Handling If a request to B2B REST API fails, the response will contain an five-digit error code with a corresponding error message to indicate the details of the error. The following code snippet is a sample error response that contains an error code and message pair: ```` { "code": 40001, "type": "NotAuthenticated", "detail": { "message": "Authentication credentials were not provided.", "code": "not_authenticated" }, "status": 403 } ```` ## Error Codes | Code | Error Category | Description | Resolution | | :------- | :------ | :------ | :----- | | 20000 | Validation Error | Raised when there is a semantic error in the payload of the request. | Check the docs for precise information on how to provide correct values for each resource atribute. | | 20001 | Parse Error | Raised when the API receives a malformed JSON document. | Check for syntax errors in the payload of your request. Also look for sample requests in the docs related to the desired operation. | | 20010 | Expired Quote | Raised when the received quote to execute has expired. | Generate a new quote and execute it within the 30 seconds time window. | | 20011 | Already Executed Quote | Raised when the received quote to execute has been executed before. | Try Generating a new quote with the former pair/amounts to replicate a similar trade. | | 20012 | Not Enough Balance | Raised when the amount to operate (sale/purchase) is larger than the balance amount of the debited currency. | Check end user's balances in order to inform the discrepancy before quote execution. Please contact our support team for further assistance. | | 20013 | Buy Limit Frequency Exceeded | Raised when the "BUY" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20014 | Sell Limit Frequency Exceeded | Raised when the "SELL" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20015 | Buy Limit Amount Exceeded | Raised when the "BUY" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20016 | Sell Limit Amount Exceeded | Raised when the "SELL" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20017 | Buy Transaction Min Limit Exceeded | Raised when the "BUY" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20018 | Buy Transaction Max Limit Exceeded | Raised when the "BUY" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20019 | Sell Transaction Min Limit Exceeded | Raised when the "SELL" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20020 | Sell Transaction Max Limit Exceeded | Raised when the "SELL" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20021 | Banned EndUser | Raised when a quote execution request comes from a banned user.| Please reach out our support team in order to get full detail on why the end user has been banned. | | 20022 | Swap Transaction Min Limit Exceeded | Raised when the "SWAP" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20023 | Swap Transaction Max Limit Exceeded | Raised when the "SWAP" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20024 | Swap Limit Frequency Exceeded | Raised when the "SWAP" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20025 | Swap Limit Amount Exceeded | Raised when the "SWAP" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20026 | Quote With No Price | Raised when the received reusable quote to execute has no price. | Try Generating a new reusable quote with the former pair to replicate a similar trade. | | 20027 | Expired Withdrawal Fee | Raised when trying to execute a withdrawal fee that has already expired. | Request another withdrawal Fee. | | 20029 | Invalid address | Raised when the address provided is not valid on given network. | Try with a valid addres for that network. | | 20030 | Kyc not approved for end user | Raised when the end user doesn't have a kyc process approved. | Check the status of end user's verification submission | | 20031 | Kyc already approved for end user | Raised when the end user already has an approved kyc process. | - | | 20032 | Invalid or disabled payment method type | Raised when the payment_method_type does not exist or is disabled for the acccount. | Please reach out our support team. | | 20033 | Frequency limit exceeded for fiat withdrawals | Raised when the QTY limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - | | 20034 | Amount limit exceeded for fiat withdrawals | Raised when the amount limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - | | 20035 | Fiat account is required | Raised when a fiat account is required. | Create a Fiat account first. | | 20036 | Withdrawal amount less than network dust limit. | Raised when the amount of withdrawal request is less to the network dust limit. | Increase Withrawal amount. | | 20037 | There is no address created for end user and given network. | Raised when there is no address for a given concrete network name. | Create an AutoSwap address first. | || | 40000 | Authentication Failed | Raised when an incoming request includes incorrect authentication. | Check for invalid credentials in your request when trying to authenticate. | | 40001 | Not Authenticated | Raised when an unauthenticated request fails the permission checks. | Check if your request contains a valid and non-expired `access_token`. | | 40003 | Permission Denied | Raised when an authenticated request fails the permission checks. | Check if you have OAuth scopes to access requested resource. Please contact our support team if you think this is an error. | | 40004 | Not Found | Raised when a resource does not exists at the given URL. | Check if the resource you're looking for does exist. | | 40005 | Method Not Allowed | Raised when an incoming request has been performed with certain HTTP verb that is not valid for the requested resource. | Check the resource's docs section to learn the accepted HTTP methods. | | 40006 | Bad Request | Raised when historical market price API endpoint has not been used properly. | Check for syntax errors in the payload of your request. Also look for sample requests in the docs related to the desired operation. | | 40007 | Bad Request | Raised when a currency network is not allowed to operate the selected currency. | Check if your request contains a valid network for the selected currency. | | 40008 | Not Found | Raised when a currency doesn't have its limits configured. | Please reach out our support team with the error details and detailed execution flow. | | 40009 | Bad Request | Raised when an existing Quote with defined external_ref has not been executed, thus it can not be excuted idempotently. | Use another external_ref for the Quote. | | 40010 | Service Unavailable | Raised when there are no addresses available for networks compatible with a specific network name. | Please reach out our support team with the error details and detailed execution flow. | | 40015 | Unsupported Media Type | Raised when the content type of the request data is not JSON compliant. | Check if your request data is compliant with JSON format. | | 40029 | Throttled | Raised when an incoming request fails the throttling checks. | Check if you are exceding the daily/hourly request quota for your account. Please contact our support team if you think you'll need an extended quota for your use-case. | || | 50003 | Service Unavailable | Raised when the service (or requested resource) is not available. | Please reach out our support team with the error details and detailed execution flow. | contact: name: Ripio email: b2b@ripio.com url: https://ripio.com termsOfService: https://www.ripio.com/ar/terms/ servers: - url: https://sandbox-b2b.ripio.com description: Sandbox environment - url: https://b2b-api.ripio.com/ description: Production environment security: - OAuth2: [] tags: - name: Access Token - name: Addresses - name: Auto Swap Addresses - name: Balance - name: Beneficiary Fiat Accounts - name: Deposit IPN - name: Deposits - name: End User - name: Fiat Accounts - name: IPN Webhooks - name: Pairs - name: Periodic Limits - name: Quote Execution - name: Quotes - name: Rates - name: Reusable Quote Execution - name: Reusable Quotes - name: Service Status - name: Swap Reusable Quote Execution - name: Swap Reusable Quotes - name: Transactions - name: TXN Limits - name: Withdrawals - name: Fiat Withdrawals - name: Fiat Deposits - name: KYC Requirements - name: KYC Submissions - name: Simulate Fiat Deposit - name: Yields paths: /api/v1/kyc-requirements/: parameters: [] get: tags: - KYC Requirements summary: KYC Requirements description: >- This endpoint returns a list of fields that needs to be provided on a KYC submission. The response is structured in a list of fields so that an UI can be constructed from it. Each field has the following structure: ```json "field_name": string, "required": boolean, "type": string (TEXT, BOOLEAN, DATE, NUMERIC, CHOICE), "choices": array "value": label, "label": string ``` operationId: get-api-v1-kyc-requirements responses: '200': description: OK content: application/json: schema: type: object properties: {} examples: Example 1: value: kyc_required_fields: - field_name: country required: true type: CHOICE choices: - value: AR label: Argentina - field_name: first_name required: true type: TEXT - field_name: last_name required: true type: TEXT - field_name: gender required: true type: CHOICE choices: - value: M label: Masculino - value: F label: Femenino - value: X label: Otro - field_name: birthday required: true type: DATE - field_name: nationality required: true type: TEXT - field_name: id_number required: true type: NUMERIC - field_name: address required: true type: TEXT - field_name: address_flat required: false type: TEXT - field_name: address_number required: true type: NUMERIC - field_name: postal_code required: true type: TEXT - field_name: city required: true type: TEXT - field_name: state required: true type: CHOICE choices: - value: AR.BA label: Buenos Aires - value: AR.CT label: Catamarca - value: AR.CC label: Chaco - value: AR.CH label: Chubut - value: AR.DF label: Ciudad de Buenos Aires - value: AR.CB label: Córdoba - value: AR.CN label: Corrientes - value: AR.ER label: Entre Ríos - value: AR.FM label: Formosa - value: AR.JY label: Jujuy - value: AR.LP label: La Pampa - value: AR.LR label: La Rioja - value: AR.MZ label: Mendoza - value: AR.MN label: Misiones - value: AR.NQ label: Neuquén - value: AR.RN label: Río Negro - value: AR.SA label: Salta - value: AR.SJ label: San Juan - value: AR.SL label: San Luis - value: AR.SC label: Santa Cruz - value: AR.SF label: Santa Fe - value: AR.SE label: Santiago del Estero - value: AR.TF label: Tierra del Fuego - value: AR.TM label: Tucumán - field_name: phone required: true type: TEXT - field_name: registered_tax_payer required: false type: BOOLEAN - field_name: cuit required: true type: TEXT - field_name: net_income required: false type: CHOICE choices: - label: Menos de 3.000.000 ARS value: AR.A - label: 3.000.000 a 5.000.000 ARS value: AR.B - label: 5.000.000 a 8.000.000 ARS value: AR.C - label: 8.000.000 a 11.000.000 ARS value: AR.D - label: 11.000.000 a 15.000.000 ARS value: AR.E - label: Más de 15.000.000 ARS value: AR.F - field_name: personal_activity required: true type: CHOICE choices: - value: AR.1 label: Empleado del Sector Privado - value: AR.2 label: Empleado del Sector Público - value: AR.3 label: Monotributista - value: AR.4 label: Autonomo - value: AR.5 label: Jubilado/ Pensionado - value: AR.6 label: Estudiante/ Ama de Casa/ Desempleado - field_name: personal_activity_other required: false type: CHOICE choices: - value: AR.1 label: >- Fabricación de joyas finas, bijouterie y artículos conexos - value: AR.2 label: Pompas fúnebres y servicios conexos - value: AR.3 label: >- Servicio de transporte aéreo de pasajeros y/o de cargas - value: AR.4 label: >- Servicio de transporte automotor de mercaderías a granel, cereales, animales y/o sustancias peligrosas - value: AR.5 label: Servicio de transporte ferroviario/automotor - value: AR.6 label: Servicio de transporte marítimo/fluvial y lacustre - value: AR.7 label: >- Servicios auxiliares a la intermediación financiera - value: AR.8 label: >- Servicios de administración de consorcios de edificios - value: AR.9 label: >- Servicios de alojamiento por hora, temporal, en campings, pensiones, hoteles, hosterías y/o residenciales similares - value: AR.10 label: Servicios de asociaciones - value: AR.11 label: Servicios de centros de estética, spa y similares - value: AR.12 label: >- Servicios de comidas "fast food", comida para llevar, helados, realizadas por/para vendedores ambulantes o para empresas y eventos - value: AR.13 label: Servicios de consorcios de edificios - value: AR.14 label: >- Servicios de cooperativas cuando realizan varias actividades - value: AR.15 label: >- Servicios de desarrollo de software y/o portales web - value: AR.16 label: Servicios de emergencias y traslados - value: AR.17 label: Servicios de enseñanza - value: AR.18 label: Servicios de entretenimiento - value: AR.19 label: >- Servicios de financiación y actividades financieras, o fondos y sociedades de inversión y entidades financieras similares - value: AR.20 label: >- Servicios de gestión de fondos a cambio de una retribución o por contratación - value: AR.21 label: >- Servicios de intermediación financiera realizada por financieras, sociedades de ahorro y préstamo, o cajas de crédito - value: AR.22 label: >- Servicios de la banca central, minorista, mayorista o de inversion - value: AR.23 label: >- Servicios de limpieza de prendas prestado por tintorerías rápidas - value: AR.24 label: Servicios de mudanza - value: AR.25 label: >- Servicios de mutuales, excepto mutuales de salud y financieras - value: AR.26 label: >- Servicios de organización de convenciones y exposiciones comerciales, excepto culturales y deportivos - value: AR.27 label: >- Servicios de organización, dirección y gestión de prácticas deportivas en clubes, espectáculos deportivos - value: AR.28 label: >- Servicios de organizaciones empresariales y de empleadores, o profesionales - value: AR.29 label: Servicios de organizaciones políticas - value: AR.30 label: Servicios de organizaciones religiosas - value: AR.31 label: >- Servicios de organizaciones y órganos extraterritoriales - value: AR.32 label: >- Servicios de parques de diversiones y parques temáticos - value: AR.33 label: Servicios de peluquería o tratamientos de belleza - value: AR.34 label: >- Servicios de producción de espectáculos artísticos, teatrales y musicales - value: AR.35 label: Servicios de restaurantes, cantinas y/o bares - value: AR.36 label: Servicios de salones de juegos - value: AR.37 label: Servicios de seguridad e investigación - value: AR.38 label: >- Servicios de seguros de salud, vida o patrimoniales excepto los de las aseguradoras de riesgo de trabajo (ART) - value: AR.39 label: Servicios de sindicatos - value: AR.40 label: Servicios empresariales - value: AR.41 label: >- Servicios inmobiliarios realizados por cuenta propia, con bienes urbanos/rurales propios o arrendados - value: AR.42 label: Servicios jurídicos - value: AR.43 label: Servicios personales - value: AR.44 label: >- Servicios prestados por deportistas y atletas para la realización de prácticas deportivas - value: AR.45 label: >- Servicios prestados por profesionales y técnicos para la realización de prácticas deportivas - value: AR.46 label: >- Servicios relacionados a activos virtuales y/o criptominería - value: AR.47 label: >- Servicios relacionados a la construcción, reforma y/o reparación de edificios, obras relacionadas al transporte y/o redes de servicios públicos - value: AR.48 label: >- Servicios relacionados a la fabricación de productos químicos, medicamentos de uso humano y productos de uso farmacéutico - value: AR.49 label: >- Servicios relacionados a la minería, metales preciosos y no ferrosos - value: AR.50 label: Servicios relacionados a los reaseguros - value: AR.51 label: Servicios relacionados a obras sociales - value: AR.52 label: >- Servicios relacionados al arrendamiento y gestión de bienes intangibles no financieros - value: AR.53 label: >- Servicios relacionados al procesamiento/ hospedaje de datos - value: AR.54 label: >- Servicios relacionados con juegos de azar y apuestas - value: AR.55 label: >- Venta al por mayor en comisión o consignación de madera y materiales para la construcción - value: AR.56 label: >- Venta al por mayor en comisión o consignación de maquinaria, equipo profesional industrial y comercial, embarcaciones y aeronaves - value: AR.57 label: >- Venta al por mayor en comisión o consignación de alimentos, bebidas y tabaco - value: AR.58 label: >- Venta al por mayor en comisión o consignación de combustibles - value: AR.59 label: >- Venta al por mayor en comisión o consignación de papel, cartón, libros, revistas, diarios, materiales de embalaje y artículos de librería - value: AR.60 label: >- Venta al por mayor en comisión o consignación de productos agrícolas y/o pecuarios - value: AR.61 label: >- Venta al por menor de productos alimenticios en comercios especializados - value: AR.62 label: >- Venta al por menor no realizada en establecimientos - value: AR.63 label: >- Venta, mantenimiento y/o reparación de vehículos automotores/motocicletas nuevos o al por mayor de partes, piezas y accesorios - value: AR.64 label: Otro components: securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: scopes: read: Default scope to read all resources. write: Default scope to performe write operations on certain resources. tokenUrl: https://sandbox-b2b.ripio.com/oauth2/token/ description: > B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow: * **clientCredentials** allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication. Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token. Every request must be accompianed by an `Authorization` header with a value that follows the following schema: `Bearer ACCESS_TOKEN` ````