Skip to main content
GET
Get authorization URL
Guide: OAuth 2.0. No API key on this request — only query parameters.

Authorizations

X-API-Key
string
header
required

Query Parameters

client_id
string
required

Your app public key (tyms_pk_...).

redirect_uri
string<uri>
required

HTTPS callback URL on your app.

reference
string
required

Your correlation id for this authorization attempt.

privacy_url
string<uri>
required

Link to your app's privacy policy.

terms_url
string<uri>
required

Link to your app's terms of service.

Response

Authorization URL for user redirect

status
string
Example:

"success"

message
string
data
object