> ## Documentation Index > Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt > Use this file to discover all available pages before exploring further. # Comenzar con Unit API > Endpoints, autenticación, formatos comunes de solicitud y respuesta, y reglas de facturación de Unit API, que permite llamar funciones de verificación de identidad una a una. 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. > [card] [Referencia de Unit API](https://client-api.argosidentity.com/docs#es/description/introduction) > > Consulte las especificaciones de solicitud y respuesta de cada API, copie el código de llamada para su lenguaje y descargue el documento OpenAPI. > [!TIP] > > 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](https://developers.argosidentity.com/dashboard/es/unit-api.md) *** ## APIs disponibles ### Análisis de imagen y texto | API | Tx Code | Qué hace | Resultado | | - | - | - | - | | [ID-OCR](https://developers.argosidentity.com/es/idcheck/unit-api/id-ocr.md) | `ID_OCR` | Reconoce el tipo de documento y lee los campos impresos | Campos reconocidos | | [ID-LIVE](https://developers.argosidentity.com/es/idcheck/unit-api/id-live.md) | `ID_LIVE` | Comprueba si la imagen se tomó del documento físico | Puntuación 0–100 | | [FACE-COM](https://developers.argosidentity.com/es/idcheck/unit-api/face-com.md) | `FACE_COM` | Compara si dos rostros son de la misma persona | Similitud 0–1 | | [FACE-LIVE-PSV](https://developers.argosidentity.com/es/idcheck/unit-api/face-live-psv.md) | `FACE_LIVE_PSV` | Comprueba si una selfie se tomó de una persona real | Puntuación 0–100 | | [TXT-FZ-MAT](https://developers.argosidentity.com/es/idcheck/unit-api/txt-fz-mat.md) | `TXT_FZ_MAT` | Compara cuánto se parecen dos nombres | Similitud 0–100 | ### Consultas a registros oficiales y bancarios | API | Tx Code | Qué hace | Fuente | | - | - | - | - | | [GC-KOR-NID](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-nid.md) | `GC_KOR_NID` | Verificación de autenticidad de la tarjeta de registro de residente de Corea | Ministerio del Interior y Seguridad | | [GC-KOR-DRV](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-drv.md) | `GC_KOR_DRV` | Verificación de autenticidad de la licencia de conducir de Corea | Agencia Nacional de Policía de Corea | | [GC-KOR-PASS](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-pass.md) | `GC_KOR_PASS` | Verificación de autenticidad del pasaporte de Corea | Ministerio de Relaciones Exteriores | | [GC-KOR-ARC](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-arc.md) | `GC_KOR_ARC` | Verificación de autenticidad de la tarjeta de registro de extranjero de Corea | Ministerio de Justicia | | [GC-KOR-FPS](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-fps.md) | `GC_KOR_FPS` | Consulta de estancia de extranjeros | Ministerio de Justicia | | [GC-KOR-BRS](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-brs.md) | `GC_KOR_BRS` | Consulta del estado de una empresa coreana | Servicio Nacional de Impuestos | | [GC-KOR-BIV](https://developers.argosidentity.com/es/idcheck/unit-api/gc-kor-biv.md) | `GC_KOR_BIV` | Verificación de autenticidad del registro de una empresa coreana | Servicio Nacional de Impuestos | | [GC-MEX-CURP](https://developers.argosidentity.com/es/idcheck/unit-api/gc-mex-curp.md) | `GC_MEX_CURP` | Consulta de CURP de México | RENAPO | | [BANK-KOR-AON](https://developers.argosidentity.com/es/idcheck/unit-api/bank-kor-aon.md) | `BANK_KOR_AON` | Consulta del titular de una cuenta bancaria coreana | Bancos | Las consultas a registros resumen la respuesta de la fuente en `verdict` y `verdictReason`. Consulte [Cómo leer los veredictos](#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. | Región | Host | | - | - | | US | `https://client-api.argosidentity.com` | | KR | `https://kr.client-api.argosidentity.com` | ```text theme={null} POST https://client-api.argosidentity.com/v1/units/{api} ``` * `{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](https://developers.argosidentity.com/dashboard/es/region.md). *** ## Autenticación Incluya la **clave de Unit API** de su proyecto en el encabezado de solicitud `x-api-key`. ```bash US theme={null} curl -X POST "https://client-api.argosidentity.com/v1/units/txt-fz-mat" \ -H "x-api-key: {yourUnitApiKey}" \ -H "Content-Type: application/json" \ -d '{"text1": "Hong Gildong", "text2": "Gildong Hong", "referenceId": "order-20261103-0001"}' ``` ```bash KR theme={null} curl -X POST "https://kr.client-api.argosidentity.com/v1/units/txt-fz-mat" \ -H "x-api-key: {yourUnitApiKey}" \ -H "Content-Type: application/json" \ -d '{"text1": "Hong Gildong", "text2": "Gildong Hong", "referenceId": "order-20261103-0001"}' ``` > [!WARNING] > > 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](https://developers.argosidentity.com/dashboard/es/event.md). > [!WARNING] > > 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`. | Campo | Tipo | Descripción | | - | - | - | | `referenceId` | string, 1–100 caracteres | Su propio identificador (número de pedido, número de socio, etc.). Se devuelve en la respuesta y se guarda en el registro de la llamada. **No incluya información personal.** | 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](https://developers.argosidentity.com/es/idcheck/unit-api/errors.md#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`. ```json theme={null} { "txId": "01a17c3a-646f-762e-bb38-fe0cae059282", "txCode": "FACE_LIVE_PSV", "createdAt": "2026-11-03T07:19:24.015Z", "latencyMs": 812, "billing": { "unit": "response", "count": 1, "unitPrice": 0.08, "credit": 0.08, "pricingVersion": "v4.0_KOR" }, "referenceId": "order-20261103-0001", "data": { "livenessScore": 93 } } ``` **txId** `string` *required* 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`. **txCode** `string` *required* El código de la API llamada. Ejemplos: `ID_OCR`, `GC_KOR_NID` **createdAt** `string` *required* Momento en que se recibió la solicitud, en UTC (RFC 3339) con precisión de milisegundos. **latencyMs** `integer` *required* Tiempo desde la recepción de la solicitud hasta la respuesta, en milisegundos. **billing** `object` *required* Detalle de facturación de esta llamada. **properties** **unit** `string` *required* Qué se cuenta: `recognition` (caras reconocidas), `pipeline` (comprobaciones), `compare` (comparaciones) o `response` (respuestas). **count** `integer` *required* Número de unidades facturadas en esta llamada. **unitPrice** `number` *required* Créditos por unidad, hasta tres decimales. **credit** `number` *required* Créditos descontados en esta llamada. En las API con precio por paquete (ID-LIVE), puede diferir de `unitPrice × count`. **pricingVersion** `string` *required* La tabla de precios aplicada: `v3.1_USA`, `v4.0_KOR` o `Trial` para proyectos de prueba. **referenceId** `string | null` *required* El `referenceId` que envió, o `null` si no lo envió. **data** `object` *required* El resultado que produjo la API. Consulte la página de cada API para ver su estructura. > [!NOTE] > > 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](https://developers.argosidentity.com/es/idcheck/unit-api/errors.md#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. | Campo | Descripción | | - | - | | `verdict` | El veredicto: `MATCH`, `MISMATCH` o `REJECTED`. Los valores que se usan y su significado varían ligeramente según la API; consulte cada página | | `verdictReason` | El motivo del veredicto. `null` en caso de `MATCH`. Úselo para decidir si un reintento puede cambiar el resultado | | `agency` | La respuesta original de la fuente. **No está cubierta por el contrato.** Puede cambiar sin aviso si la fuente modifica sus campos, así que bifurque su lógica con `verdict` y `verdictReason` | * `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](#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. | API | Unidad de facturación (`count`) | Precio KOR | Precio USA | | - | - | :-: | :-: | | ID-OCR | Caras reconocidas (1–2) | 0,24 por cara | 0,32 por cara · 0,36 por cara con `universal` si el país emisor no es KOR | | ID-LIVE | Comprobaciones con puntuación (1–3) | 1: 0,07 · 2–3: 0,14 | 1: 0,09 · 2–3: 0,18 | | FACE-COM | 1 | 0,01 | 0,06 | | FACE-LIVE-PSV | 1 | 0,08 | 0,12 | | TXT-FZ-MAT | 1 | 0,01 | 0,012 | | GC-KOR-NID | 1 | 0,04 | 0,12 | | GC-KOR-DRV | 1 | 0,04 | 0,12 | | GC-KOR-PASS | 1 | 0,04 | 0,12 | | GC-KOR-ARC | 1 | 0,04 | 0,12 | | GC-KOR-FPS | 1 | 0,04 | 0,058 | | GC-KOR-BRS | 1 | 0,01 | 0,012 | | GC-KOR-BIV | 1 | 0,01 | 0,012 | | GC-MEX-CURP | 1 | 0,09 | 0,09 | | BANK-KOR-AON | 1 | 0,04 | 0,10 | También puede consultar los precios de su proyecto en **Unit API > Prueba de API** del panel. *** ## Uso según el estado del proyecto | Estado del proyecto | Llamadas | Límite | Facturación | | - | :-: | - | :-: | | Servicio (`OPEN`) | Permitidas | Sin límite | Sí | | Prueba (`TEST`) | Permitidas | Sin límite | Sí | | Trial (`TRIAL`) | Permitidas | 10 al mes | No | | Cerrado (`CLOSE`) | No permitidas | `403 ACCESS_FORBIDDEN` | - | * 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 > [card] [Códigos de error y reintentos](https://developers.argosidentity.com/es/idcheck/unit-api/errors.md) > > Formato de las respuestas de error, qué hacer con cada código y reglas de reintento > [card] [Unit API en el panel](https://developers.argosidentity.com/dashboard/es/unit-api.md) > > Prueba de API, historial de llamadas y gestión de la clave This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.