v1

latestOpenAPI 3.0.42026-08-042281222.0 KB
OAuth

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:

  1. Authenticate with your referral partner API key (XApiKey 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:
{ "accessToken": "eyJ...", "tokenType": "Bearer", "expiresIn": 1800 }
post/oauth/token

Request body

externalTenantIdstring required

The partner's external identifier for the client/tenant. This must match an active ReferralPartnerClientLink.

Response

Token generated successfully

accessTokenstring nullable

The JWT bearer token to use in Authorization header. Format: "Bearer {access_token}"

expiresIninteger

Token lifetime in seconds (typically 1800 for 30 minutes).

creditorIdstring uuid

The Debitura creditor ID that this token grants access to.

externalTenantIdstring nullable

The partner's external tenant ID for reference.

tokenTypestring nullable

Token type - always "Bearer" for JWT tokens.