Authentication

Register Profile using Application Credentials (For SDK Integration)

Creates a new profile and returns a profile token. A profile represents your end user. Required valid <b>AppId</b> and <b>AppSecret</b> in the headers.

post/api/v1/oauth/profile/register/appId

Request

  • Base URL
    https://api.sahha.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Headers

appIdstring
appSecretstring

Request body

externalIdstring

ExternalId used to reference the created Profile

Example request

{
  "externalId": "6980b34e-14f9-47ef-b6f8-80a18b206a8e"
}

Response

Initialises a new Profile and returns a profile token.

profileTokenstring

Profile token used in authorization header as 'profile {token}'

expiresIninteger

When the token expires, as Unix time in seconds.

tokenTypestring

The type of token being returned, will be 'account' or 'profile'

refreshTokenstring nullable

Populated with a token value in response to a refresh token request.

Example response

{
  "profileToken": "hIw0LuHXHZKMD7bWV0DlGWyTAyHqO8EceLmJ5ez96QrXv3Lhf0qoDqrNDp7jx...",
  "tokenType": "Profile",
  "refreshToken": "hIw0LuHXHZKMD7bWV0DlGWyTAyHqO8EceLmJ5ez96QrXv3Lhf0qoDqrNDp7jx..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.