---
description: >-
  Welcome to the API documentation! On this page, you will find everything you
  need to know to improve the security and quality of your apps using our API.
---

# Overview

### Integration

The CAF API follows the [REST ](https://en.wikipedia.org/wiki/Representational_state_transfer)standard. Therefore, our API has predictable resource-oriented URLs that accept and return data in JSON format while also using standard HTTP code in the response.

### Responses <a href="#czs" id="czs"></a>

We use conventional response codes to indicate success or failure in a request. In short, codes in the `2xx` range represent success. Codes in the `4xx` range indicate validation error types with the information provided or mapped failures. Finally, codes in the `5xx` range indicate an error with the servers or some other unforeseen failure.

In addition, all responses have an identifier for the request, the `requestId` field. This field is helpful for us to find the exact request in case of investigation.
