Endpoint KYC

KYC REQUEST

POST https://api-stg.tupayonline.com/v1/kyc

Este punto final le permite validar la información KYC de sus clientes.

Headers

Name	Type	Description
Content-Type	string	application/json
X-Date*	string	Fecha según el estándar ISO8601 formato: yyyy-MM-dd'T'HH:mm:ssZ
X-Login*	string	X-Login API Key del Comercio
Authorization	string	Hash de control de autorización
X-Idempotency-Key	string	Idempotency key única

Request body

Name	Type	Description
country*	string	(PE) País por defecto PE
document_type*	string	(max length: 10) Tipo de documento especificado
document*	string	(max length: 11) Documento de identidad del usuario

200: Ok Success

{
    "user": {
        "name": "ONLINEPRO S.A.C.",
        "document": "20607546941"
    },
    "errors": []
}

200: Error

{
    "user": {
        "document": "34sa"
    },
    "errors": [
        {
            "field": "document",
            "message": "Invalid document"
        }
    ]
}

Nota

Para utilizar esta API (tanto en entornos de ensayo como de producción), póngase en contacto con nosotros a través de [email protected] o con su gestor de cuenta responsable, con información sobre su comerciante, para que podamos activar esta función para su cuenta, ya que viene desactivada por defecto.

Hasta que no haya una confirmación de nuestro equipo de integración, no podrá utilizar esta API y recibirá un error.

Solicitud de Ejemplo

{
    "country": "PE",
    "document": "20607546941",
    "document_type": "RUC"
}

cUrl

curl --location 'https://api.stg-tupayonline.com/v1/kyc' \
--header 'X-Date: {{X-Date}}' \
--header 'X-Login: {{X-Login}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Content-Type: application/json' \
--header 'Cookie: GCLB=CKXsisOwpuHToAEQAw' \
--data '{
    "country": "PE",
    "document": "20607546941",
    "document_type": "RUC"
}'

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.tupayonline.com/v1/kyc");
request.Headers.Add("X-Date", "{{X-Date}}");
request.Headers.Add("X-Login", "{{X-Login}}");
request.Headers.Add("Authorization", "{{Authorization}}");
request.Headers.Add("Cookie", "GCLB=CKXsisOwpuHToAEQAw");
var content = new StringContent("{\n    \"country\": \"PE\",\n    \"document\": \"20607546941\",\n    \"document_type\": \"RUC\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Respuesta de Ejemplo

{
    "user": {
        "name": "ONLINEPRO S.A.C.",
        "document": "20607546941"
    },
    "errors": []
}

Códigos de Errores

Agrupamos los códigos de error en diferentes categorías para un mejor entendimiento.

• 1xx - Errores de encabezado

• 2xx - Error en la llamada o de configuración del comercio

• 3xx - Errores del usuario

• 4xx - Errores en la creación del depósito

• 5xx - Otros errores

• 7xx - Errores internos

Codigo	Http	Tipo	Mensaje
300	400	INVALID_DOCUMENT	Invalid document number
306	400	INVALID_PIX_KEY	Invalid Pix Key
307	400	COUNTRY_NOT_AVAILABLE	Country not available
407	400	OTHER	Other
500	500	INTERNAL_SERVER_ERROR	Oh no! Something has gone wrong. Please contact a system administrator.