v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB

/api/v1/auth

Login

Authenticates a registered provider and returns a Suki access token (suki_token). Use that token as sdp_suki_token on all subsequent API calls. Tokens expire after one hour.

post/api/v1/auth/login

Request body

partner_idstring required

Unique identifier for the partner. This will be shared securely by Suki to the partner through a separate partner registration process.

partner_tokenstring required

JWT token issued by trusted authorization server. The token must include Provider Email.

provider_idstring

Optional for standard partners.

Required for:

Bearer authentication. Send provider_id so Suki can identify the provider during Login or Register.
Single Auth Token authentication. Send provider_id so Suki can identify the clinician during Login or Register.

Example request

{
  "partner_id": "your-partner-id",
  "partner_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "provider_id": "provider-123"
}

Response

Request succeeded.

suki_tokenstring

JWT access token for the authenticated provider. Pass this value as sdp_suki_token on subsequent requests. Expires after one hour.

Example response

{
  "suki_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}