> For the complete documentation index, see [llms.txt](https://docs.vida.id/vida-identity-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/vida-identity-platform/integration-methods/api.md).

# API

The VIDA API is built on the principles of Representational State Transfer (REST) and uses standard HTTP methods and JSON responses, allowing for easy integration and flexibility.

### Authentication:

Vida API uses token-based authentication for secure communication with client applications. Each user is issued a unique JWT token that is passed in the header of each request, and the API also uses advanced security protocols such as signing the JWT token with a secret and expiration time for tokens.

### HTTP Status Codes & Error Handling

The VIDA API follows standard HTTP status codes and error codes, and the documentation includes information on how to handle and troubleshoot any errors that may occur when using the API. This includes details about the different status codes and error codes that the API may return, as well as guidance on how to diagnose and resolve any issues that may arise. 

If a request to our API is successful, it will return an HTTP status code `200 (OK)`

{% hint style="info" %}
For a complete list of error codes and their meanings, refer to the [HTTP Error Codes](broken://pages/vCkwm7pxL7eTV1AMdVEy) section.
{% endhint %}

### Rate Limiting

The API has rate limiting enabled to ensure fair usage for all users. If the number of API requests exceeds the allotted rate limit, the VIDA API will return an error with status code `429 (Too Many Requests)`. This indicates that the user has exceeded the assigned quota limit for API requests and must wait before making further requests.