Register

🚧

About the API Use Cases

The instructions in the API Use Cases guide are intended to be used by application teams with API integrations. These instructions are not intended to be used for integration with Next Identity Journeys.

If you need any technical support after reading through the API Use Cases, please contact your Next Reason integration consultant.

Introduction

The /register API endpoint will allow your application to create new users. Depending on the authentication method used (email address or mobile phone number), the end user will get a verification message after registration is complete.

Assumptions

• Application is hosting the registration screen (no use of the Next Identity Journey screens)
• Application is allowing users to self-register
• Application is responsible for securely sending these API calls to the Next Identity
• Application will need to handle range of responses from the service
• Application will need to handle showing relevant legal agreements (including privacy policy and terms and conditions)
• API calls will be rate limited for each client ID; please consult with your Next Reason integration consultant to change these limits if needed

Supported Use Cases

• Register user by email address
• Register user by mobile phone number

These are discussed in the sections below.

📘

API reference for /register endpoint

In addition to the migration documentation in this section, refer to the API Reference for the /register endpoint for more details.

Register users by email address

Sample API Call

This is what a registration with email via API call would look like. Please contact your Next Reason integration consultant if you need to use this API call to ensure it is being used with the correct workflow.

If you are pre-registering or inviting new users, please use the /pre-register endpoint instead.

curl --location --request POST 'https://id.eu.nextreason.com/idp/v1/account/register' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "profile_fields": {
        "emailAddress": "[email protected]",
        "firstName": "John",
        "lastName": "Smith",
        "newPassword": "[email protected]%s^GB"
    },
    "client_id": "c8462jyq9dnupu2q4j7sfjzvn6c87j92",
    "auth_type": "email",
    "grant_type": "password",
    "locale": "en-US",
    "redirect_uri": "https://localhost.com"
}'

Register user by mobile phone number

Sample API Call

This is what a registration with mobile phone number via API call would look like. Please contact your solutions architect if you need to use this API call to ensure it is being used with the correct workflow.

If you are pre-registering or inviting new users, please use the Pre-Register endpoint instead.

curl --location --request POST 'https://id.eu.nextreason.com/v1/idp/account/register' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "profile_fields": {
        "mobilePrimary": "+15417543010",
        "firstName": "John",
        "lastName": "Smith",
        "newPassword": "[email protected]%s^GB"
    },
    "client_id": "c8462jyq9dnupu2q4j7sfjzvn6c87j92",
    "auth_type": "sms",
    "grant_type": "password",
    "locale": "en-US",
    "redirect_uri": "https://localhost.com"
}'