Saltar al contenido principal
Unit API le permite elegir y llamar funciones de verificación de identidad una a una, como el OCR de documentos de identidad, la comparación facial y las consultas a registros oficiales. Puede añadir a su servicio solo las verificaciones que necesita, sin pasar por el flujo de envío de Liveform.
  • Una llamada devuelve un resultado. No se crea ningún envío (submission).
  • Todas las llamadas son síncronas. El resultado llega en la respuesta y no hay webhooks.
  • Solo se facturan las llamadas que devuelven un resultado. Las llamadas que terminan en error no se facturan.

Referencia de Unit API

Consulte las especificaciones de solicitud y respuesta de cada API, copie el código de llamada para su lenguaje y descargue el documento OpenAPI.
Para ver resultados antes de escribir código, ejecute una llamada desde Unit API > Prueba de API en el panel. El endpoint y un ejemplo cURL se muestran antes de ejecutar, así que puede copiarlos y empezar a integrar. Guía de Unit API en el panel

APIs disponibles

Análisis de imagen y texto

Consultas a registros oficiales y bancarios

Las consultas a registros resumen la respuesta de la fuente en verdict y verdictReason. Consulte Cómo leer los veredictos.

Primeros pasos

1

Copiar la clave de Unit API

Copie la clave en Unit API > Clave de Unit API del panel. La clave se emite automáticamente al crear el proyecto, así que no hace falta solicitarla. Se requiere el rol Member o superior.
2

Probar en el panel

En Prueba de API, elija una API, introduzca los valores y ejecútela. Revise la respuesta, el TX ID, el endpoint y el ejemplo cURL.
3

Llamar desde su servidor

Envíe desde su servidor la misma solicitud que el ejemplo cURL. Use la clave solo en su servidor.
4

Guardar el resultado y el TX ID

Guarde el resultado y el txId en su sistema en cuanto reciba la respuesta. ARGOS no almacena los cuerpos de solicitud ni de respuesta.

Endpoints

Todas las Unit API son solicitudes POST. Llame al host de la región a la que pertenece su proyecto.
  • {api} es la ruta indicada en la página de cada API. Ejemplo: /v1/units/id-ocr
  • Las 14 API están disponibles en todas las regiones.
  • La clave solo funciona en la región de su proyecto. Llamar al host de otra región devuelve 401. Consulte la región de su proyecto en Regiones.

Autenticación

Incluya la clave de Unit API de su proyecto en el encabezado de solicitud x-api-key.
La clave de Unit API es distinta de la clave API de Liveform y de la clave API de complementos. Cada proyecto tiene una. Envíe la clave solo en el encabezado, nunca en la cadena de consulta.

Reemisión de la clave

  • Si la clave se expone o se sospecha un uso indebido, un Owner o Leader la reemite desde el panel.
  • Al reemitir, la clave anterior se revoca de inmediato. Las llamadas con la clave anterior se rechazan con 401 INVALID_API_KEY y no se facturan.
  • Quién reemitió la clave y cuándo queda registrado en el historial de claves y en el Registro de eventos.
La parada de emergencia de la configuración del proyecto no se aplica a las llamadas de Unit API. Para bloquear las llamadas de Unit API, reemita la clave.

Reglas de solicitud

  • Envíe un cuerpo JSON con Content-Type: application/json. Otros tipos se rechazan con 415 UNSUPPORTED_MEDIA_TYPE.
  • Los campos que no están en el contrato se rechazan con 400 UNKNOWN_PARAMETER. Así se evita que un error tipográfico se ignore en silencio y se facture con un resultado inesperado.
  • Una cadena vacía ("") o null no se considera “no enviado” y se rechaza con 400 INVALID_PARAMETER_FORMAT. Si un campo opcional no tiene valor, omita la clave.
  • Las fechas usan el formato YYYY-MM-DD. Ejemplo: 2019-03-14

Imágenes

  • Envíe las imágenes como cadenas Base64. Un prefijo como data:image/jpeg;base64, es opcional.
  • Solo se aceptan JPEG y PNG. Convierta HEIC de iPhone, GIF, BMP y otros formatos a JPEG antes de enviarlos.
  • Cada imagen puede ocupar hasta unos 3 MB en tamaño original (4.000.064 caracteres Base64 sin el prefijo). Las imágenes más grandes devuelven 400 PARAMETER_OUT_OF_RANGE. La mayoría de las fotos de documentos tomadas con el móvil se pueden enviar tal cual.

referenceId

Todas las API aceptan el campo opcional referenceId. Si envía un valor distinto en cada llamada, podrá encontrar más tarde una llamada aunque no haya recibido su respuesta. Consulte Llamadas duplicadas y reintentos.

Respuesta común

Una respuesta correcta (200) tiene la misma forma en todas las API. Los campos que describen la llamada están en el nivel superior, y el resultado que produjo la API está dentro de data.
string
requerido
El TX ID de esta llamada. Úselo para buscar en el historial de llamadas del panel y al contactar con soporte. Es el mismo valor que el encabezado de respuesta X-Tx-Id.
string
requerido
El código de la API llamada. Ejemplos: ID_OCR, GC_KOR_NID
string
requerido
Momento en que se recibió la solicitud, en UTC (RFC 3339) con precisión de milisegundos.
integer
requerido
Tiempo desde la recepción de la solicitud hasta la respuesta, en milisegundos.
object
requerido
Detalle de facturación de esta llamada.
string | null
requerido
El referenceId que envió, o null si no lo envió.
object
requerido
El resultado que produjo la API. Consulte la página de cada API para ver su estructura.
Los campos de respuesta definidos nunca se omiten; llegan como null cuando no tienen valor. Por otro lado, dentro de v1 se pueden añadir nuevos campos de respuesta y valores de enum, así que asegúrese de que los campos o valores desconocidos no rompan su código. Política de versiones

Cómo leer los veredictos

Las API de consulta a registros devuelven los siguientes campos dentro de data. La única excepción es GC-MEX-CURP, que devuelve el estado del registro tal cual, sin veredicto.
  • MATCH: Coincide con los registros de la fuente.
  • MISMATCH: La fuente respondió que no coincide. Se realizó la consulta, por lo que se factura.
  • REJECTED: Auténtico, pero ya no es válido (un pasaporte que perdió su validez, o una empresa suspendida o cerrada).
Las API de análisis de imagen y texto solo devuelven puntuaciones y mediciones. Usted decide el umbral de aprobación.

Facturación

Solo se descuentan créditos por las llamadas que devuelven un resultado. Puede ver los créditos descontados en billing.credit y en el historial de llamadas del panel.
  • Las llamadas que devuelven un resultado se facturan. Una similitud facial baja o un MISMATCH de la fuente también es un resultado, por lo que se factura.
  • Las llamadas que terminan en error no se facturan. Esto incluye toda respuesta cuyo estado HTTP no sea 200.
  • Las llamadas ejecutadas desde la Prueba de API del panel se facturan igual.
  • Los proyectos de prueba (Trial) no se facturan. En su lugar, el número de llamadas al mes está limitado. Uso según el estado del proyecto
  • Enviar la misma solicitud dos veces se procesa y se factura como dos llamadas.

Precios por API

Los proyectos con el plan v3.1_USA usan los precios USA; todos los demás planes usan los precios KOR. Los precios se expresan en créditos. También puede consultar los precios de su proyecto en Unit API > Prueba de API del panel.

Uso según el estado del proyecto

  • El límite de Trial cuenta todas las llamadas, incluidos los errores. Se incluyen las llamadas con error no facturadas y las rechazadas por superar el límite.
  • El límite se restablece a las 00:00 UTC del primer día de cada mes.
  • Al alcanzar el límite, las llamadas devuelven 429 TRIAL_LIMIT_EXCEEDED y el encabezado Retry-After indica los segundos que faltan para el restablecimiento.

Conservación de datos y privacidad

  • Los cuerpos de solicitud y respuesta no se almacenan. Guarde el resultado con su txId en su sistema en cuanto reciba la respuesta. No podrá recuperar los resultados desde ARGOS más tarde.
  • Los registros de llamadas se conservan 3 años. Incluyen la hora de la llamada, la API, el resultado, el código de error, el tiempo de procesamiento, el count, los créditos, el origen (en vivo o prueba de API), quién la ejecutó y el referenceId.
  • Incluso en pruebas, necesita una base legal, como el consentimiento del interesado, para usar información personal real.

Próximos pasos

Códigos de error y reintentos

Formato de las respuestas de error, qué hacer con cada código y reglas de reintento

Unit API en el panel

Prueba de API, historial de llamadas y gestión de la clave