Skip to main content

Onsite Integration

With Onsite verification, Shufti will directly interact with the end user, managing data collection to facilitate 1:1 authentication. Verification status updates are communicated to the client via callback URL and the Shufti back office.

Request Parameters​

The parameters mentioned below are applicable for Onsite 1:1 authentication.

1:1 Authentication Object​

ParametersDescription
customer_unique_idRequired: Yes
Type: String
The customer_unique_id is a unique identifier used to distinguish individual users in the system. The user’s facial template is stored against the unique customer_unique_id.
face_authenticationRequired: Yes
Type: string
Accepted Values: "enroll", "authenticate"
If set to "enroll", the user's face will be enrolled when facial liveness is passed. If set to "authenticate", the user's face will be matched against the stored template for authentication.
proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
Provide valid BASE64 encoded string. Leave empty for an on-site verification.
one-to-one-authentication-sample-object
{
"customer_unique_id":"ABCDEF",
  "face": {
    "proof": "",
    "face_authentication":"authenticate"
  }
}