Saltar al contenido principal

Funciones Principales

La API de ARGOS KYC ofrece las siguientes funcionalidades principales:
  • Envío y Gestión de Datos KYC: Crear, consultar, actualizar y eliminar información de clientes.
  • Verificaciones AML y Consulta de Reportes: Solicitar verificaciones AML y revisar resultados.
  • Procesamiento de Imágenes: Cargar y gestionar documentos de identidad y otras imágenes requeridas.

Endpoints de la API

La API de ARGOS KYC sigue una arquitectura RESTful y proporciona los siguientes endpoints principales:

POST/Submission

Enviar Datos KYC

PATCH/Submission

Actualizar Datos KYC

GET/Submission

Consultar Datos KYC

DELETE/Submission

Eliminar Datos KYC

PARTIAL-DELETE/Submission

Eliminar Parcialmente Componentes de Datos KYC

REVIEW/Submission

Revisar casos pendientes

GET/Image

Consultar Imágenes

PUT/Image

Cargar/Actualizar Imágenes

GET/Report/AML

Consultar Reportes AML

POST/AML

Solicitar Verificaciones AML

POST/AML Ongoing

Registrar recordId de Monitoreo Continuo AML

GET/AML Ongoing

Consultar recordId de Monitoreo Continuo AML

DELETE/AML Ongoing

Eliminar recordId de Monitoreo Continuo AML

POST/Token

Solicitar registro de Tokens Privados

GET/Token

Solicitar descarga de Tokens Privados

DELETE/Token

Solicitar eliminación de Tokens Privados

GET/Projects

Solicitar ver configuración del proyecto

Notas Importantes

Comprendiendo Nuestras APIs de ID Check

Nuestras APIs de ID Check están diseñadas para transferir datos sin problemas, actuando como un conducto para la información que entra y sale del sistema ARGOS. Piense en ellas como canales seguros: puede usarlas para traer datos externos a ARGOS, o para extraer datos de ARGOS para usarlos en otras aplicaciones. Su función principal es el movimiento eficiente de datos, asegurando que su información fluya hacia donde necesita ir.

Manejo de Datos y Limitaciones

Es crucial entender que, si bien estas APIs son excelentes para la transferencia de datos, no procesan ni validan los datos en sí. Esto significa que si usa una API POST submission para enviar datos a ARGOS, o una API PUT Image para cargar imágenes, el sistema no aprobará ni rechazará automáticamente los resultados. Las APIs facilitan la transferencia, pero cualquier procesamiento posterior de datos, validación o toma de decisiones no funcionará.

Módulo Verify para Desarrollo de UI Personalizada

Para clientes que desean utilizar la funcionalidad de ID Check a través de su propia UI, recomendamos usar el módulo Verify. Verify es una herramienta flexible que proporciona la funcionalidad de ARGOS en formato API.
Consideraciones al Usar el Módulo Verify
  • Sin Base de Datos Integrada: Requiere construir su propia base de datos
  • Sin Procesamiento Integrado: Toda la lógica de procesamiento de datos debe ser implementada por usted
  • Sin Dashboard: No se proporciona interfaz web para la gestión de envíos
  • Configuración Completa por su Cuenta: Debe configurar todo usted mismo - conectando todas las funciones, almacenamiento y gestión
Si su objetivo es proporcionar servicios basados en API a clientes, ARGOS está dispuesto a brindar soporte para integración y conectividad. Para información más detallada, por favor consulte la página de Primeros Pasos de Verify.

Clave API

La clave API de ID Check juega un papel vital en la autenticación y autorización de solicitudes de clientes y servidores. Asegura que las credenciales del solicitante sean validadas, y ARGOS Identity proporciona la respuesta apropiada.

Cómo Acceder a la Clave API

1

Iniciar sesión en el Dashboard

Inicie sesión en el Dashboard de ID Check.
2

Acceder al Menú de Configuración

Haga clic en el menú Settings en la barra de navegación superior del dashboard.
3

Navegar a la Página de Gestión de Acceso

Desde la sección General en la barra lateral izquierda, seleccione Access Management.
4

Ingresar URL del Webhook

Localice la sección API Key, haga clic en el icono para copiar la clave API y guárdela de forma segura.
5

Estructura del Encabezado de Solicitud

Localice la sección API Key, haga clic en el icono para copiar la clave API y guárdela de forma segura.
6

Implementar la Integración API

Implemente y pruebe la integración API en su entorno de desarrollo.
7

Cambiar a Producción

Transicione al entorno de producción y comience a procesar datos en vivo.

Códigos de Estado de Respuesta HTTP

Los códigos de respuesta HTTP se utilizan para indicar el estado de una solicitud. Cada código representa el resultado de la solicitud, siguiendo estas reglas:
  • 2xx: Solicitud exitosa
  • 4xx: Error del cliente
  • 5xx: Error del servidor
HTTP Status CodeMessageDescripción
200OKLa solicitud fue procesada exitosamente.
400Invalid Query String parametersLa solicitud no puede ser procesada. Faltan parámetros requeridos o tienen formato incorrecto. Por favor verifique sus parámetros de solicitud nuevamente.
403User is not authorized to access this resource with an explicit denyAcceso denegado. Se intentó acceder desde una IP no registrada en la lista blanca de IPs.
403ForbiddenAcceso denegado. Es posible que se haya utilizado una clave API incorrecta.
413Request Entity Too LargeLa solicitud es demasiado grande. La solicitud contiene datos que exceden el tamaño que el servidor puede procesar. Por favor reduzca los datos de la solicitud e intente nuevamente.
500Internal Server ErrorOcurrió un error del servidor. Puede haber un problema con el servidor de ARGOS. En este caso, por favor contacte al equipo de ARGOS.
502Bad GatewayEl servidor recibió una respuesta inválida del servidor upstream. Por favor intente nuevamente más tarde o contacte al equipo de ARGOS.
Simplifique sus procesos de KYC y AML, mejore el cumplimiento regulatorio y mejore las experiencias de incorporación de clientes utilizando la API de ARGOS ID Check.