Introducción

Este documento contiene la especificación de los servicios expuestos en modo SaaS a través de las APIs REST de Facephi para los productos Document Capture y Selphi.

Autorizaciones

Todas las llamadas a los endpoints deben incluir las siguientes claves en el encabezado de la solicitud:

Clave

Valor

Obligatoriedad

client-id

[Client ID]

Opcional

token-app

[Client authorization token]

Opcional

x-api-key

[API access authorization]

Requerido

Si no se incluyen las claves requeridas, todos los endpoints devolverán la siguiente respuesta:

json

{
  "serviceResultCode": 401,
  "message": "Unauthorized"
}

Integración con Identity Platform

⚠️ Importante: Todas las llamadas a los endpoints para seguimiento con Identity Platform deben contener el siguiente encabezado:

Clave

Valor

family

"OnBoarding" (para procesos de Digital Onboarding)

"Authentication" (para procesos de Autenticación)


Estructura de la Documentación de la API

Recurso: /services

Endpoints disponibles:

  • /evaluatePassiveLivenessToken Descripción: [Agregar descripción del servicio aquí]

  • /authenticateFacial Descripción: [Agregar descripción del servicio aquí]

  • /authenticateUser Descripción: [Agregar descripción del servicio aquí]

  • /updateUserTemplate Descripción: [Agregar descripción del servicio aquí]

  • /extractDocumentData Descripción: [Agregar descripción del servicio aquí]

  • /extractDocumentDataWeb Descripción: [Agregar descripción del servicio aquí]

  • /civilValidation Descripción: [Agregar descripción del servicio aquí]

  • /finishTracking Descripción: [Agregar descripción del servicio aquí]

  • /detokenize Descripción: [Agregar descripción del servicio aquí]

  • /extractFacial Descripción: [Agregar descripción del servicio aquí]


Recurso: /onboarding

Endpoints disponibles:

  • /identity Descripción: [Agregar descripción del servicio aquí]

  • /v2/identity Descripción: [Agregar descripción del servicio aquí]


Recurso: /verify

Endpoints disponibles:

  • /pad Descripción: [Agregar descripción del servicio aquí]

  • /documentValidation Descripción: [Agregar descripción del servicio aquí]

  • /documentValidation/v2 Descripción: [Agregar descripción del servicio aquí]

  • /pad/diagnostic Descripción: [Agregar descripción del servicio aquí]


Last updated