How to re-enroll or delete a user?
Manage users on the system.
This page explains how to manage users in our system, covering:
Re-enrollment
Permanent deletion
The unique user_id sent with each job is central to these operations.
Overview
Re-enroll: Allows an existing user to submit a new enrollment job i.e. Biometric KYC, Document Verification, Enhanced Document Verification , SmartSelfie™ Registration.
Delete: Permanently removes a
user_idand all enrolment information (this cannot be undone).
Endpoint
POST {{base_url}}/v2/block-user
Sandbox base url: https://testapi.smileidentity.com
Prod base url: https://api.smileidentity.com
Request Header
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).
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 totrueto enable enrollment for an existing user.
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.
Once deleted, the user_id cannot be reused.
{
"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 totrueto permanently remove user data.
Last updated
Was this helpful?

