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

The user ID set in the PartnerParams JSON must be unique. It is used to connect future jobs to the correct user. It can also be used to re-enroll a user if there is a problem with their first try. You can also deactivate a user so they can't do any other jobs. An example of this use case if if you want to temporarily block a user from authenticating. You can also permanently block a user from any future actions.

Re-enroll a user ID
To allow a user ID to re-enroll, it is necessary that you enable a re-enrollment before it occurs on that specific user ID. This is done by making a call to:
POST https://[env].smileidentity.com/api/v2/partner/enrollee
Where [env] is either "portal" or "prod"
With a JSON body shown below and the allow_re_enroll flags set to true:
1
		{
2
	      'user_id': '<Put User ID here>',
3
	      'allow_re_enroll': true,
4
	      'partner_id': '<Put your partner ID here>',
5
	      'timestamp': <Put the timestamp recieved from generate_sec_key() call here>,
6
	      'sec_key': '<Put sec_key recieved from generate_sec_key() call here>',
7
	      'email': '<Put your email address here>',
8
	      'environment': '<test | production>'
9
	   }
Copied!
​
Deactivate a user ID
To temporarily deactivate a user ID, use the same endpoint as above with the active flag set to false as in the following example body.
1
		{
2
	      'user_id': '<Put User ID here>',
3
	      'active': false,
4
	      'partner_id': '<Put your partner ID here>',
5
	      'timestamp': <Put the timestamp recieved from generate_sec_key() call here>,
6
	      'sec_key': '<Put sec_key recieved from generate_sec_key() call here>',
7
	      'email': '<Put your email address here>',
8
		    'environment': '<test | production>'
9
	   }
Copied!
​
Delete or permanently block a user ID
To permanently block a user ID, use the same endpoint as above with delete flag set to true as in the following example body.
1
		{
2
	      'user_id': '<Put User ID here>',
3
	      'delete': true,
4
	      'partner_id': '<Put your partner ID here>',
5
	      'timestamp': <Put the timestamp recieved from generate_sec_key() call here>,
6
	      'sec_key': '<Put sec_key recieved from generate_sec_key() call here>',
7
	      'email': '<Put your email address here>',
8
	      'environment': '<test | production>'
9
	   }
Copied!

What are Top-Level Keys?

Is there an API I can query to check the status of an ID authority?

Last modified 6mo ago

Copy link

Contents

Re-enroll a user ID

​

Deactivate a user ID

​

Delete or permanently block a user ID