Flujos de SPID Services

Este documento describe brevemente los flujos de operación del SPID Services, la API para integración con el SPID Client.

Hay dos flujos esenciales, Captura Presencial y Captura Remota, detallados a continuación.

Captura Presencial

El flujo de operación para captura presencial sigue el diagrama a continuación, y la principal diferenciación depende de si el CPF consultado ya existe en la base. Todas las operaciones mencionadas en este flujo están detalladas en el manual SPID Services API.

Flujo SPID Services: Captura Presencial

Autenticación

1. La aplicación debe autenticarse en el SPID Client con la llamada Login y asegurarse de que la operación fue exitosa con la llamada Login Status.

2. La aplicación debe iniciar una verificación llamando Verify con el CPF del individuo.

Si el CPF del individuo no está en la base, la llamada devolverá PERSON_NOT_FOUND, y la aplicación deberá seguir Individuo No Registrado. De lo contrario, deberá seguir el Individuo Ya Registrado.

Individuo No Registrado

1. La aplicación necesita realizar el enroll del individuo, llamando Enroll (Enroll) y llamar Capture Status hasta obtener el estado CLIENT_CAPTURE_DONE.

2. La aplicación debe iniciar la autenticación biométrica del operador con Operator Capture, y llamar Capture Status hasta obtener la indicación de éxito OPERATOR_CAPTURE_DONE.

3. La aplicación debe enviar la captura con Capture Send (Send). En este caso, la operación será asíncrona, la respuesta esperada es CAPTURE_ENQUEUED.

4. Opcionalmente, la aplicación puede consultar el estado del procesamiento del enroll con Capture Result by ID. El procesamiento del enroll puede ser lento, y la aplicación no debe asumir que obtendrá una respuesta definitiva en un corto periodo de espera.

5. La aplicación puede obtener el informe de la operación con Capture Report, concluyendo el flujo de tratamiento del individuo.

Individuo Ya Registrado

1. La llamada Verify devolverá CLIENT_CAPTURING y se iniciará la captura biométrica del individuo. La aplicación debe llamar Capture Status hasta obtener indicación de que la captura fue concluida, CLIENT_CAPTURE_DONE.

2. La aplicación debe iniciar la autenticación biométrica del operador con Operator Capture, y llamar Capture Status hasta obtener la indicación de éxito OPERATOR_CAPTURE_DONE.

3. La aplicación debe enviar la captura con Capture Send (Send). En este caso, la operación será síncrona y devolverá la respuesta VERIFIED indicando éxito.

4. La aplicación debe obtener el estado del match biométrico, llamando Capture Result by ID con el TGUID recibido en el paso anterior. Si no hubo match (SEARCH_NOT_MATCH), la aplicación puede, si lo desea, realizar el enroll del individuo.

5. La aplicación puede obtener el informe de la operación con Capture Report, concluyendo el flujo de tratamiento del individuo.

Reenvíos

Los envíos (Capture Send) pueden fallar por errores de transmisión y fallas temporales de infraestructura (servidores no disponibles o sobrecargados). Se recomienda que la aplicación realice una vez al día el reenvío de las operaciones pendientes, llamando Capture Resend All (Capture Resend All).

Captura Remota

El flujo de operación para captura remota a través de un servicio externo de verificación, que incluye una aplicación instalada en el dispositivo (smartphone/tablet) del cliente, sigue el diagrama a continuación. Todas las operaciones mencionadas en este flujo están detalladas en el manual SPID Services API. La captura remota permite tanto la verificación de clientes ya registrados en la base (Remote Verify) como el registro de nuevos clientes (Remote Enroll).

Flujo SPID Services: Captura Remota

Autenticación

1. La aplicación debe autenticarse en el SPID Client con la llamada Login y asegurarse de que la operación fue exitosa con la llamada Login Status.

Captura del Operador

1. La aplicación debe iniciar la autenticación biométrica del operador con Operator Capture, y llamar Capture Status hasta obtener la indicación de éxito OPERATOR_CAPTURE_DONE.

Verificación Remota del Cliente

1. La aplicación debe iniciar la verificación remota del cliente con la llamada Remote Verify. Esta llamada devolverá una URL (usada por la aplicación externa del cliente para enviar los datos biométricos para verificación) y un TGUID (identificador de la transacción).

2. El URL es remitido al servicio de verificación remota, que realizará la captura biométrica (a través de una aplicación en el dispositivo del cliente) y utilizará la URL para enviar los datos biométricos capturados.

3. La aplicación debe verificar el resultado de la verificación biométrica con la llamada Remote Verify Result by ID, que devolverá SEARCH_MATCH o SEARCH_NOT_MATCH, indicando el resultado de la operación.