# Customer API v2.xBeta

Work In Progress

The Customer API is considered in beta as we build out the functionality to display and maintain customer profiles.

The Customer API provides endpoints to display and maintain customer profiles.

# Authentication

An access token with a scope of Profile.Read or Profile.Write must be provided to access the API on behalf of the customer. Each endpoint will list the scopes required for the particular endpoint.

The access token can be obtained from our Customer SSO solution. Providing an API key is not required when calling the API.

A valid bearer token must be provided in an Authorization header. The format of the header is Authorization: Bearer {accessToken} where accessToken is a valid access token.

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlNKUFNpUi0zOVotcl...

Our Customer SSO solution provides endpoints to obtain access tokens to access the API on behalf of the customer as well as endpoints to refresh the access token when the current token expires.

# Environments

The API is currently deployed to the following environments:

Version Production Staging
Version 2.0 ❌ Not Deployed ✔️ Deployed