The invite workflow, also known as the pre-register journey, empowers applications to invite users to activate their accounts when self-registration isn't the preferred or supported registration method.

The typical invite workflow comprises the following steps:

In this stage, your application team creates the user account, which is pre-filled with a limited set of known data, such as the email address, first name, and last name. Upon successful pre-registration, an email or SMS with account activation information is sent to the user.

If a user record already exists and the application is not configured to resend the invite, the following will occur:

1. The user record will be linked to the requesting application/property using the client ID.

2. The response code for this scenario will be 200, and the UUID of the user will be provided as the response to the pre-register call.

3. The pre-register endpoint will ignore any form fields passed into the call. This ensures that existing user details, such as names and other information, will not be overwritten by this call.

Once the account has been successfully pre-registered, the user receives an email or SMS containing instructions to activate their account.

For users who receive the link via email:

• Clicking or tapping the link in the email will direct the user to a screen with a button to "Activate Account."
  

  The user will proceed to the next step after clicking the "Activate Account" button.

For users who receive the link via SMS or for those who have clicked the "Activate Account" button:

• The user will be directed to the activation screen. This screen requests additional user information necessary to finalize account registration, such as address and password.

• The user will also be prompted to review and accept relevant terms and conditions or privacy notices.
  

This updated flow ensures a seamless and user-friendly experience for all users, regardless of how they receive their activation link.

/pre-register

 curl --location 'https:///id.eu.nextreason.com/idp/v1/account/pre-register' \
--header 'Content-Type: application/json' \
--header 'Authorization: REDACTED \
--data-raw '{
   "client_id": "{{client_id}}",
   "scope": "openid",
   "auth_type": "email",
   "redirect_uri": "{{redirect_uri}}",
   "grant_type": "password",
   "profile_fields": {
       "emailAddress": "{{email}}",
       "firstName": "{{first_name}}",
       "lastName": "{{last_name}}"
   },
   "locale": "en-US"
}'

The following parameters must be included on every request.

Upon execution of the /pre-register endpoint, two possible responses may occur:

• 201 Created: The user is successfully created, and an activation email or SMS will be sent to the user.

• 200 OK: The user already exists in the database, and no activation email will be sent.

Additionally, a UUID will be returned after a successful /pre-register call.

The profile_fields are customizable based on the requirement.

Basic Authorization is needed in order to perform /pre-register endpoints. It is crucial to secure the Basic Authorization credentials (Client ID and Secret) to prevent unauthorized access. Ensure that the responses that are considered as personally identifiable information (PII) is transmitted securely over HTTPS to prevent interception by unauthorized parties.