Login

Exchange your clientId and apiKey for a bearer token, then use it to authenticate later Verto API requests.

Before you call this endpoint

Complete these steps first:

  1. Retrieve Credentials: Get your clientId and apiKey from the Verto Portal. For sandbox credentials, use the sandbox platform and for production credentials, use the production platform portal. Do not use the two interchangeably.
  2. Generate Public Key: Navigate to Verto API -> Certificates , select Generate Public Key, and download your RSA Public Key(.pem).
  3. Prepare Backend: Ensure your service can generate current UNIX timestamps in milliseconds and has an RSA-compatible crypto library installed.
📘

NOTE:
Always confirm your Base URL: If you are testing in the sandbox environment, ensure your base URL is set to the sandbox base url: https://api-company-sandbox.vertofx.com, and if in production, use the production base URL: https://api-company-beta.vertofx.com. Using them interchangably will result in 403 errors.



📘

This Login API endpoint only accepts encrypted API Key. Raw API Keys will be rejected. For guidance on how to encrypt your raw apiKey please refer to our Certificate Based Authentication guide.

Body Params
string
enum

Pass the mode as apiKey for us to know the request comes from an API customer.

Allowed:
string

A unique 28-digit alpha-numeric identifier assigned to the client generated by the VertoFx portal. To know more, click Authentication.

string

The key generated to access the API. To know more, click Authentication.

Responses

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