Getting Started

Select a language to begin, enter your credentials and try creating a token.

Body Params

client_id

string

required

length between 12 and 36

Provided upon receiving API access; unique ID for your application associated with your Authvia Account.

audience

string

required

The intended audience for the token, always set to api.authvia.com/v3

timestamp

number

required

UTC time in seconds, must be within 5 seconds of the server's current time (Epoch format).

signature

string

required

HMAC SHA256 encryption of {signature_value}.{signature_value.length}.{timestamp}. see (authentication)[authentication#signature-logic]

signature_value

string

required

length between 16 and 1024

A random string, minimum 16 characters. Used to create the signature hash, excluding length or timestamp.

scope

string

length ≥ 5

Space-separated permissions for the token. Refer to documentation for valid scopes.

expiration

string | number

Overrides default token expiration. Format examples: '5m' for 5 minutes, '1d' for 1 day.

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Popular Endpoints

Last 30 Days