The HTTP "GET" method can request specific data from the server. To verify authentication, make an HTTP GET request.

Vendy authenticates your API request using JWT token generated upon successful authentication of your (email|username) and password. To use any Vendy API, you must first call the /auth endpoint with your base 64 encoded username and password to form a basic authorization header entry. Upon successful authentication, a time bound JWT token will be generated and sent back to you in the token response attribute

You will be required to include the JWT token in subsequent request to the API as part of;

Authorization: Bearer <token>

When architecting your system please be aware that the generated JWT tokens have a 7day expiry time, as indicated in the expiryTime response attribute.


We require that all requests are sent server-to-server. Your app or website should never be directly communicating with the Vendy APIs, as your private connection keys may be exposed in transit. All request are required to be made via an HTTPS connection; requests made over plain HTTP will fail.

Verify Auth

API endpoint to verify auth;



Example request

curl --location --request GET ''

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
  "status": true,
  "code": 200,
  "msg": "User logged in",
  "data": {}

This specifies if a user has been able to log in successfully.

The possible errors are;

Error CodeDescription
400 (Bad Request)Required fields were invalid, and not specified. With an error message that says "User not logged in".
Click Try It! to start a request and see the response here!