Verificación de Clientes

1. Introducción

La API de Negocios de Yativo proporciona una solución robusta para verificar la identidad de sus usuarios finales/clientes. Esta API permite a las empresas asegurar el cumplimiento de las regulaciones KYC (Conozca a su Cliente) validando la información del usuario en tiempo real.

2. Autenticación

Todas las solicitudes de API deben estar autenticadas usando una clave API. Puede obtener su clave API desde el panel de control de la API de Negocios de Yativo. Incluya esta clave en el encabezado de sus solicitudes de la siguiente manera:

Authorization: Bearer SU_CLAVE_API

3. Endpoints

Verificar Cliente

Endpoint: POST {{baseUrl}}/verification/verify-customer

Descripción: Verificar la identidad de un cliente.

Encabezados:

Authorization: Bearer SU_CLAVE_API
Content-Type: application/json

Parámetros de Solicitud:

Parámetro	Tipo	Requerido	Descripción
first_name	string	Sí	El primer nombre del cliente.
last_name	string	Sí	El apellido del cliente.
middle_name	string	No	El segundo nombre del cliente.
email	string	No	La dirección de correo del cliente.
phone	string	No	El número de teléfono del cliente.
date_of_birth	string	Sí	La fecha de nacimiento del cliente (AAAA-MM-DD).
ip_address	string	No	La dirección IP del cliente.

Ejemplo de solicitud:

{
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "A",
    "email": "[e-mail]",
    "phone": "[phone]",
    "date_of_birth": "1990-01-01",
    "ip_address": "192.168.1.1"
}

4. Códigos de Error

La API utiliza códigos de estado HTTP estándar para indicar el éxito o el fracaso de una solicitud de API. La siguiente tabla proporciona detalles de los códigos de error comunes:

Código de Estado	Descripción
200	La solicitud fue exitosa.
400	Solicitud incorrecta. Los parámetros de la solicitud son inválidos o están ausentes.
401	No autorizado. La clave API está ausente o es inválida.
403	Prohibido. No tiene acceso a este recurso.
404	No encontrado. No se pudo encontrar el recurso solicitado.
500	Error interno del servidor. Ocurrió un error en el servidor.

5. Mejores Prácticas

• Proteja su Clave API: Nunca exponga su clave API en repositorios públicos o en el código del lado del cliente.

• Valide la Entrada: Asegúrese de que todos los campos requeridos sean proporcionados y válidos antes de realizar solicitudes de API.

• Manejo de Errores de Manera Adecuada: Implemente el manejo de errores en su aplicación para gestionar diferentes códigos de estado HTTP y respuestas de error.

• Limitación de Tasa: Sea consciente de los límites de tasa de la API y evite realizar solicitudes excesivas en un corto período.