v1
latestOpenAPI 3.0.42026-08-042281222.0 KBOAuth
Get OAuth access token
Generates a short-lived JWT bearer token for accessing the Customer API on behalf of a specific client.
How It Works:
- Authenticate with your referral partner API key (XApiKey header)
- Provide the externalTenantId of the client you want to access
- Receive a Bearer token valid for 30 minutes
- 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:
{ "accessToken": "eyJ...", "tokenType": "Bearer", "expiresIn": 1800 }
post/oauth/token
Request body
Response
Token generated successfully