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

This guide explains how to manage user accounts in our system, including re-enrollment, deactivation, and blocking. The unique user ID in the PartnerParams JSON is crucial to these processes.

Re-enroll a User ID

To re-enroll a user, activate this feature for their user ID using the following API endpoint:

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

Where [env] is either "portal" or "prod" “portal” (test environment) - "https://portal.usesmileid.com/api/v2/partner/enrollee" “prod” (production environment) - "https://prod.usesmileid.com/api/v2/partner/enrollee"

Submit a JSON request as follows, setting the allow_new_enroll flag to true:

{
  "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>"
}

Deactivate a User ID

To temporarily deactivate a user ID, use the same endpoint with the active flag set to false:

{
  "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>"
}

Delete or Permanently Block a User ID

For permanent removal or blocking of a user ID, use the same endpoint, setting the delete flag to true:

{
  "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>"
}

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. Use the following JSON structure to modify the flag:

{
  "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>"
}