How to re-enroll or delete a user?

Manage users on the system.

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

  1. Re-enrollment

  2. 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. 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 {{base_url}}/v2/block-user

Request Header

Key
Value
Required
Description

smileid-partner-id

{{your_partner_id eg. 0001}}

Yes

This is your partner id which can be found on the side navigation panel of the Smile ID partner portal

smileid-request-signature

{{your_security_signature eg. aw234..}}

Yes

Your calculated access signature

smileid-timestamp

{{timestamp eg. 2021-08-12T17:57:00.614879}}

Yes

The timestamp that was used to calculate your signature (in ISO date/time format).

To prevent issues with authorisation errors, the timestamp must be in ISO 8601 with a micro-second format of 3-digits. eg. .809Z for this timestamp: 2025-05-23T11:40:07.809Z.

Request Body

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.

Delete or Permanently Block a User ID

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

Last updated

Was this helpful?