Handle Responses

HTTP 200 Ok

Successful request.

{
  "success": true
  // ... Response data 
}

HTTP 400 Bad request

This error is related validation. We use Zod library to validate the request. Check out https://zod.dev/ERROR_HANDLING?id=zodissue

Response:

{
  "success": false,
  "errors": [...] // ZodError list 
}

HTTP 401 - Unauthorized

Reason by invalid or expired api key.

Response:

{
  "success": false,
  "reasons": ["Unauthorized"]
}

HTTP 403 - Forbidden

This could be one of these reasons:

• Your IP was not whitelisted
• For some internal reasons we block your api usage

Response: No response

HTTP 422 - Unprocessable Content

This is logical error. Checkout Docs » Api Reference » Error List section to see more details.

Response:

{
  "success": false,
  "reasons": []  // Array of string with format: [error code]:[message]. 
                 // For e.g: E1000:General Error - Invalid pdf file
}

HTTP 429 - Too many request

You sent more requests to the server than allowed within a certain time frame. Checkout Docs » Api Reference » Rate limit section to the limitation.

Response: No response

HTTP 500 - Internal server error

Response:

{
  "success": false,
  "reasons": ["Internal Server Error"]
}