Introduction
This document includes the specification of the services exposed in SaaS mode through the FacePhi REST APIs for SelphID and Selphi products.
Authorizations
All calls to the Endpoints must include the following keys in the request header:
| Key | Value | Required |
|---|---|---|
| client-id | [Client ID] | Not Required |
| token-app | [Client authorization token] | Not Required |
| x-api-key | [API access authorization] | Required |
If the required keys mentioned above are not included, all Endpoints will return the following response:
| serviceResultCode | Description |
|---|---|
| 401 | “message”: “Unauthorized” |
Integration with Identity Platform
caution
All calls to the Endpoints for tracking with Identity Platform must contain the following header:
| Key | Value |
|---|---|
| family | “OnBoarding” = For all calls related to Digital Onboarding processes |
| “Authentication” = For all calls related to Authentication processes |
API Documentation Structure
Resource: /services
Services
-
/evaluatePassiveLivenessToken- Description: [Provide description of the service here]
-
/authenticateFacial- Description: [Provide description of the service here]
-
/authenticateUser- Description: [Provide description of the service here]
-
/updateUserTemplate- Description: [Provide description of the service here]
-
/extractDocumentData- Description: [Provide description of the service here]
-
/extractDocumentDataWeb- Description: [Provide description of the service here]
-
/civilValidation- Description: [Provide description of the service here]
-
/finishTracking- Description: [Provide description of the service here]
-
/detokenize- Description: [Provide description of the service here]
-
/extractFacial- Description: [Provide description of the service here]
Resource: /onboarding
Services
-
/identity- Description: [Provide description of the service here]
-
/v2/identity- Description: [Provide description of the service here]
Resource: /verify
Services
-
/pad- Description: [Provide description of the service here]
-
/documentValidation- Description: [Provide description of the service here]
-
/documentValidation/v2- Description: [Provide description of the service here]
-
pad/diagnostic- Description: [Provide description of the service here]