Skip to main content

Get OAuth access token

POST 

/oauth/token

Generates a short-lived JWT bearer token for accessing the Customer API on behalf of a specific client.

How It Works:

  1. Authenticate with your referral partner API key (X-API-Key header)
  2. Provide the externalTenantId of the client you want to access
  3. Receive a Bearer token valid for 30 minutes
  4. Use the token in the Customer API: Authorization: Bearer {access_token}

Requirements:

  • The externalTenantId must match an active ReferralPartnerClientLink for your partner account
  • The client must be fully onboarded (SDCA signed)

Token Details:

  • Type: Bearer (JWT)
  • Lifetime: 30 minutes
  • Scope: Customer API access for the specified client only

Usage Example:

POST /oauth/token
{ "externalTenantId": "your-client-id" }

Response:
{ "access_token": "eyJ...", "token_type": "Bearer", "expires_in": 1800 }

Request

Responses

OK