FaceApi
| Method | HTTP request | Description |
|---|---|---|
| createFaceAuthenticatorUsingPOST | POST /api/web/v2/users/{userid}/face | Create a Face Biometric for a user |
| createFaceUsingPOST | POST /api/web/v1/users/{userid}/face | Create a Face Biometric for a user |
| deleteFaceUsingDELETE | DELETE /api/web/v1/face/{faceid} | Delete a Face Biometric by UUID |
| getFacesUsingGET | GET /api/web/v1/users/{userid}/faces | Get a list of Face Biometric for a given user |
| getUserFaceSettingsUsingGET | GET /api/web/v1/users/{userid}/settings/face | Get a users Face Biometric settings |
| sendFaceActivationEmailUsingPUT | PUT /api/web/v1/face/{faceid}/activation | Send an activation email for the Face Biometric |
| updateFaceUsingPUT | PUT /api/web/v1/users/{userid}/face | Update the Face Biometric for a given user |
createFaceAuthenticatorUsingPOST
FaceCreateResponse createFaceAuthenticatorUsingPOST(userid, faceCreateParms)
Create a Face Biometric for a user
Create a Face Biometric authenticator for the specified user. Caller requires the FACE:ADD permission.
The Face Biometric can be created using either the web flow or the mobile flow.
If using the web flow, the Face Biometric can optionally use the Onfido applicantId and workflowRunId to link the Face Biometric to the correct Onfido applicant and workflow run.
If using the mobile flow, setting deliverActivationEmail to true will send an activation email to the user with instructions to download the mobile app and complete activation.
Setting returnQRCode to true will include a QR code in the response that can be scanned by the user to start the activation process.
If using the IDaaS stored biometric web flow, the encryptedBiometricToken parameter is required and must include both the encrypted biometric token and the customer user ID used to create the token in Onfido.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | ||
| faceCreateParms | FaceCreateParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
createFaceUsingPOST
FaceAuthenticator createFaceUsingPOST(userid, faceCreateParms)
Create a Face Biometric for a user
Create a Face for the specified user. Caller requires the FACE:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | ||
| faceCreateParms | FaceCreateParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
deleteFaceUsingDELETE
deleteFaceUsingDELETE(faceid)
Delete a Face Biometric by UUID
Delete a Face Biometric authenticator by the specified UUID. Requires the FACE:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| faceid | String | The UUID of the Face Biometric to delete. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getFacesUsingGET
List<FaceAuthenticator> getFacesUsingGET(userid)
Get a list of Face Biometric for a given user
Get a list of Face Biometrics authenticators for the specified user UUID. Requires the FACE:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user to get the Face Biometrics for. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getUserFaceSettingsUsingGET
UserFaceSettings getUserFaceSettingsUsingGET(userid)
Get a users Face Biometric settings
Get Face Biometric settings information for the specified user UUID. Requires the FACE:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user to get the settings for. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
sendFaceActivationEmailUsingPUT
sendFaceActivationEmailUsingPUT(faceid)
Send an activation email for the Face Biometric
Send an activation email for the Face Biometric authenticator by the specified UUID. Requires the FACE:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| faceid | String | The UUID of the Face Biometric authenticator to send an activation email for. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateFaceUsingPUT
updateFaceUsingPUT(userid, faceUpdateParms)
Update the Face Biometric for a given user
Update the Face Biometric authenticator for the specified user UUID. Requires the FACE:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user to update the Face Biometric for. | |
| faceUpdateParms | FaceUpdateParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |