Authentication function

This method is used to get the authorization token in order to communicate with LCS API. This authorization token will be used for the web services functions calls and it will be valid for an hour from the generation time.
API function usage type: Standard

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Token lifecycle

Each authorization token is valid for 1 hour from the time it is generated.

To limit unnecessary token generation, the authentication endpoint reuses an existing token when possible:

  • More than 5 minutes of validity remaining: the existing token is returned with its original expires_at.
  • No active token, or 5 minutes or less of validity remaining: a new token is generated with a new 1-hour validity period.

Integrations should store both authorization_token and expires_at, and reuse the current token until it approaches expiration.

👍

Recommended renewal strategy

Request authentication again approximately 4 minutes before expires_at. This ensures the request falls within the renewal window while avoiding unnecessary authentication calls.

📘

Early authentication calls

Calling the authentication endpoint before the renewal window does not extend the validity of the current token. The existing token and its original expires_at are returned.

Body Params

Authentication Secret Key Request Body

string
required

email address (used on LCS subscription)

string
required

secret key associated to the username

string
required

web service developer key (provided by Liveconsent Support)

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json