How to re-enroll, deactivate or delete a user?

Manage users on the system.

This page explains how to manage users in our system, covering:

1. Re-enrollment

2. Deactivation (Blocking)

3. Flagging and re-enabling suspicious users

4. Permanent deletion

The unique user_id sent with each job is central to these operations.

Overview

1. Re-enroll: Allows an existing user to submit a new enrollment job i.e. Biometric KYC, Document Verification, Enhanced Document Verification , SmartSelfie™ Registration.

2. Deactivate/Block: Temporarily prevents a user from running new jobs.

3. Flag/Unflag Fraud: Mark a user as fraudulent to fail all future authentication jobs ran by the user.

4. Delete: Permanently removes a user_id and all enrolment information (this cannot be undone).

Use the same endpoint with different flags to manage each type of action.

Endpoint

POST https://[env].smileidentity.com/api/v2/partner/enrollee

Replace [env] with either:

• portal for sandbox environment i.e. https://portal.smileidentity.com/api/v2/partner/enrollee

• prod for production environment i.e. https://prod.smileidentity.com/api/v2/partner/enrollee

Re-enroll a User ID

To re-enroll a user (i.e., allow them to submit a new enrollment job under the same user_id):

{
  "allow_new_enroll": true,
  "email": "<Your email address>",
  "environment": "<test | production>",
  "partner_id": "<Your partner ID>",
  "signature": "<Your signature>",
  "timestamp": "<Timestamp from generate_signature()>",
  "user_id": "<User ID>"
}

• allow_new_enroll: Set to true to enable enrollment for an existing user.

Deactivate (Block) a User ID

To temporarily deactivate a user_id, so they can't run new jobs:

{
  "active": false,
  "email": "<Your email address>",
  "environment": "<test | production>",
  "partner_id": "<Your partner ID>",
  "signature": "<Your signature>",
  "timestamp": "<Timestamp from generate_signature()>",
  "user_id": "<User ID>"
}

• active: Set to false to block the user. Set to true to reactivate the user.

Re-enable a User Flagged for Suspected Fraud

User IDs flagged for suspected fraudulent activity can be re-enabled for authentication by changing the is_fraudulent flag to false. When is_fraudulent is true, the system continues to process jobs and collect data about potential fraudsters, but all jobs will be marked as failed. This allows for continued monitoring while preventing unauthorized actions. To re-enable a user previously flagged as fraudulent:

{
  "is_fraudulent": false,
  "email": "<Your email address>",
  "environment": "<test | production>",
  "partner_id": "<Your partner ID>",
  "signature": "<Your signature>",
  "timestamp": "<Timestamp from generate_signature()>",
  "user_id": "<User ID>"
}

• is_fraudulent: Set to true to flag the user. Set to false to re-enable the user for authentication.

Delete or Permanently Block a User ID

Deleting a user is permanent and cannot be reversed. Whenever possible, we recommend re-enrolling users instead of deleting them.

To completely remove a user and free up the user_id for future use:

{
  "delete": true,
  "email": "<Your email address>",
  "environment": "<test | production>",
  "partner_id": "<Your partner ID>",
  "signature": "<Your signature>",
  "timestamp": "<Timestamp from generate_signature()>",
  "user_id": "<User ID>"
}

• delete: Set to true to permanently remove user data.