Crear sesión

Autentícate con tu X-API-Key de tenant. FinPay resuelve el espacio de trabajo desde esa clave y luego crea una sesión de verificación para ese espacio de trabajo. Si se omite workflow_id (o está vacío) en el cuerpo JSON, el servidor usa el flujo predeterminado del tenant configurado en ese espacio de trabajo (no un valor global). Los campos opcionales del cuerpo incluyen callback, metadata y opciones relacionadas de sesión.
Devuelve un verification_url alojado cuando se crea la sesión.
Al crear una sesión con un flujo de Autenticación biométrica, incluye portrait_image como una imagen facial de referencia codificada en base64 para el usuario enrolado. Sin este campo, la verificación solo puede ejecutar prueba de vida, por lo que FinPay rechaza creaciones de autenticación biométrica cuando puede identificar que el flujo seleccionado requiere entrada para comparación facial.
Cada llamada crea una sesión nueva. Envía un valor vendor_data distinto cuando quieras correlacionar sesiones con tu propio usuario o id de orden (reutilizar el mismo vendor_data puede vincular sesiones para ese identificador). Omite vendor_data para verificaciones independientes de una sola vez.
El encabezado opcional Idempotency-Key evita sesiones duplicadas causadas por reintentos de red (no reutilices la misma clave en creaciones diferentes).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

Id interno opcional del usuario que se asociará con la sesión.

uuid

UUID opcional del flujo. Cuando se omite o está vacío, FinPay usa el flujo predeterminado de este tenant configurado en el espacio de trabajo. Cuando se define, reemplaza ese valor predeterminado (sujeto a listas permitidas del espacio de trabajo si están configuradas).

string
length ≤ 255

Tu identificador para la persona o el caso (por ejemplo, id de usuario o id de orden). Usa un valor único por cada verificación distinta; repetir el mismo valor puede vincular sesiones para ese identificador.

string
length ≤ 12000000

Imagen facial de referencia codificada en base64 para flujos de Autenticación biométrica. Es obligatoria cuando el workflow_id seleccionado es un flujo de autenticación biométrica para que la captura reciente de prueba de vida del solicitante pueda compararse con el retrato enrolado.

uri
length ≤ 2048
string
enum
Allowed:
string

Cadena opaca almacenada con la sesión (se recomienda una cadena JSON).

string
length ≤ 10
contact_details
object
expected_details
object
Headers
string
length ≤ 128

Clave única opcional para reintentos seguros en la creación.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json