Upload a selfie image and performs a face match with the ID Document photo image.

PUT 
/api/web/v1/idproofing/:requestId/completeselfie

Returns the document authentication result and the face match result. This ID Proofing API call consumes two transactions and the ID Proofing request status is marked as COMPLETED. Any subsequent ID Proofing API calls using the same requestId will return an error. Caller requires the IDPROOFING:EDIT permission.

Request

Path Parameters

requestId stringrequired

The UUID of the ID Proofing request.

application/octet-stream

Body

required

string

Responses

200

Successful

application/json

Schema

Schema

documentAuthenticationResult stringrequired

Possible values: [UNKNOWN, PASSED, FAILED, SKIPPED, ATTENTION]

The ID document authentication result.

documentDataFields

object[]

The list of fields extracted from the ID document.

Array [

description string

The data field description.

name string

The data field name.

type string

Possible values: [STRING, BOOLEAN, DATETIME]

The data type of data field value .

value string

The data field value extracted from the ID document.

]

documentTestResults

object[]

The result of individual tests performed on the ID document.

Array [

actions string

A longer description with possible actions to performed on the document.

description string

The description of the check performed on the document.

disposition string

A short description with result of the check performed on the document.

information string

A longer description with result of the check performed on the document.

name string

Identifies the check performed.

result stringrequired

Possible values: [UNKNOWN, PASSED, FAILED, SKIPPED, CAUTION, ATTENTION]

The ID classification result.

]

faceMatch boolean

Returns true if the document photo and the selfie image matched.

faceMatchScore int32

Face match score normalized to the range 0-100, where 80 or higher is considered a match. Clients should rely on the isFaceMatch property rather than the raw score.

Example (from schema)

{
  "documentAuthenticationResult": "ATTENTION",
  "documentDataFields": [
    {
      "description": "The middle name of the bearer of the document.",
      "name": "Middle Name",
      "type": "STRING",
      "value": "JANE"
    }
  ],
  "documentTestResults": [
    {
      "actions": "The expiration date on the document may have been misread.  Confirm that it is legible and occurs on or after the current date. Also confirm that the current date and time of the host computer is correctly set.",
      "description": "Checked if the document is expired.",
      "disposition": "The document has expired.",
      "information": "Verified that the birth date is valid, in the expected format, and occurs on or before the current date and not outside a reasonable range.",
      "name": "Document Expired",
      "result": "PASSED"
    }
  ],
  "faceMatch": true,
  "faceMatchScore": 85
}

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...