Saltar al contenido principal
Descripción general de la API Reference

Todo lo que necesitas para ir de cero a tu primer humanToken.

Markdown

Human Token tiene tres endpoints. Esta página muestra cómo encajan entre sí para que puedas comenzar a integrar de inmediato.

URL base​

EntornoURL base
Producciónhttps://humantoken.unico.app

Todas las solicitudes requieren el header x-unico-accesskey. Consulta Autenticación para generar tu clave.


Flujo de inicio rápido​


Paso 1 — Autenticación​

Genera tu x-unico-accesskey en el Human Dashboard o mediante la Authentication API. Cada solicitud a continuación utiliza esta clave.

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

Paso 2 — Crear un proceso​

Llama a Create Process para iniciar la verificación. Elige uno de los dos modelos:

ModeloFlowsCómo funciona
API Onlyapi+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidationTu backend envía el selfie como imageBase64. El humanToken regresa en la misma respuesta.
Human Token Journeyhumantoken, humantoken+revalidationEl usuario completa la captura en la plataforma Unico. Obtienes un token y un link para presentar el journey, luego consultas el resultado con Get Process.

Ejemplo de API Only:

curl -X POST https://humantoken.unico.app/client/v1/process \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{
"flow": "api+humantoken",
"imageBase64": "<base64-encoded-selfie>",
"companyBranchId": "<your-branch-id>"
}'

Ejemplo de Human Token Journey:

curl -X POST https://humantoken.unico.app/client/v1/process \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{
"flow": "humantoken",
"callbackUri": "https://yourapp.com/callback",
"companyBranchId": "<your-branch-id>"
}'

Consulta Create Process para todos los flows, parámetros y detalles de respuesta.


Paso 3 — Presentar el journey al usuario (solo flows Journey)​

Para los flows humantoken y humantoken+revalidation, la respuesta de Create Process incluye:

  • token — inicializa el Web SDK o la integración nativa
  • link — URL para redirigir al usuario

Elige la integración que se adapte a tu plataforma:

PlataformaEnfoque
Web — SDKIntegra el journey en línea con idpay-b2b-sdk → Web Integration
Web — RedirectRedirige al usuario a link → Web Integration
AndroidCustom Tabs → Android
iOSASWebAuthenticationSession → iOS
IonicCapacitor plugin → Ionic
React NativeNative module → React Native
FlutterPlatform Channels → Flutter

Cuando el journey finaliza, el usuario regresa a tu callbackUri. Continúa con el Paso 4.

Flows API Only

Omite este paso — el resultado ya está en la respuesta de Create Process.


Paso 4 — Obtener el resultado (solo flows Journey)​

Llama a Get Process con el id del proceso para obtener el resultado:

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY"

La respuesta incluye data.humanToken.value (flows estándar) o data.humanTokenMatch (flows de revalidación). Consulta Get Process para el esquema completo de respuesta y los valores de estado.


Paso 5 — Usar el humanToken​

El humanToken es un identificador estable y opaco (hasta 100 caracteres). La misma persona siempre resuelve al mismo valor.

const { humanToken } = process.data;

if (!humanToken?.value) {
// Inconclusive — retry or reject per your business rules
return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
// Same person seen before — returning user or duplicate
} else {
// First time — create a new record
await db.persons.create({ humanToken: humanToken.value });
}
advertencia

Verifica siempre que data.humanToken.value no esté vacío antes de almacenarlo o compararlo.


Paso 6 — Obtener el selfie (opcional)​

Llama a Get Selfie para descargar la imagen capturada. El selfie está disponible durante 24 horas después de que finaliza el proceso — después de eso, se elimina permanentemente.

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY"

Consulta Get Selfie para detalles de respuesta y códigos de error.


Endpoints de un vistazo​

MétodoEndpointDescripción
POST/client/v1/processCreate Process — iniciar una verificación
GET/client/v1/process/{processId}Get Process — obtener el resultado
GET/client/v1/process/{processId}/selfieGet Selfie — descargar el selfie (24 h)

Siguientes pasos​

  • Create Process — referencia completa de parámetros para los cinco flows
  • Authentication — generar y gestionar tus claves de acceso
  • Build With LLM — pega un prompt en tu asistente de IA para generar la integración completa