Profile

Retrieve and update user profile details with the Next Identity API

📘

API reference for /profile endpoint

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

Introduction

The /profile API endpoint will allow your application to get (GET) and update (PUT) user profile information. The data retrieved or updated is scoped for your specific application and the API call is authenticated using an access token.

Assumptions

  • Application is hosting the registration screen (no use of the Next Identity Journey screens).
  • Application is responsible for securely sending these API calls to the Next Identity.
  • Application will need to handle range of responses from the service.
  • 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 for /profile

  • Get user profile values
  • Update user profile values

Get user profile

Introduction

The /profile API endpoint will allow your application to get and update (GET) user profile information. The information that is retrieved and updated is scoped for your specific client and are authenticated using an access token.

Sample API Call

This is an example of getting the profile information that has a specific set of attributes.

curl --location --request GET 'https://id.eu.nextreason.com/idp/v1/account/profile?client_id=c8462jyq9dnupu2q4j7sfjzvn6c87j92' \
--header 'authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json'

Update user profile

Introduction

The /profile API endpoint will allow your application to update (PUT) user profile information. The information that is retrieved and updated is scoped for your specific client and are authenticated using an access token.

Sample API Call

This is an example of updating the profile information that has a specific set of attributes.

curl --location --request PUT 'https://id.eu.nextreason.com/idp/v1/account/profile' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw '{
    "client_id": "c8462jyq9dnupu2q4j7sfjzvn6c87j92",
    "profile_fields": {
        "firstName": "John",
        "lastName": "Smith"
    },
    "locale": "en_US"
}'

What’s Next