Create a Face Biometric for a user

POST 
/api/web/v1/users/:userid/face

Create a Face for the specified user. Caller requires the FACE:ADD permission.

Request

Path Parameters

userid stringrequired

application/json

Body

required

applicantId string

The ID of the applicant that was created in Onfido.

workflowRunId string

The workflow run ID used to register the user in Onfido.

Responses

200

Successful

application/json

Schema

Schema

applicantId string

The ID of the applicant in Onfido.

expiry date-time

Date the authenticator will expire.

id string

The ID of the Face Biometric.

status string

Possible values: [ACTIVATING, ACTIVE, FAILED, EXPIRED, REVIEW, DISABLED]

The status of the authenticator.

Example (from schema)

{
  "applicantId": "string",
  "expiry": "2019-02-19T13:15:27Z",
  "id": "string",
  "status": "ACTIVATING"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...