We use the standard https status codes to indicate the success or failure of all requests made to our APIs.
Following this standard:
To enhance your user experience, we've provided details of the potential errors you may encounter when using our API, along with their meanings.
| StatusCode | Type | Meaning |
|---|---|---|
| 200 | OK | Everything works fine, as expected. |
| 400 | Bad Request | Your request was unacceptable because a parameter was missing. |
| 401 | Unauthorised | You did not provide a valid API key. |
| 402 | Request Failed | Your parameters were valid but the request failed. |
| 403 | Forbidden | Your API key doesn't give you the permissions to perform a request. |
| 404 | Not Found | The resource you requested does not exist. |
| 429 | Too Many Requests | You have sent too many requests in a given amount of time. |
| 500, 502, 503, 504 | Internal Server Errors | Something went wrong on our end. (These are usually rare) |
For errors in the 4xx range, we provide context through the error responses. The response from the API will include a JSON payload with application and human-readable descriptions about the error. Always parse and utilise this information to troubleshoot and resolve issues effectively.
A typical request response from our API is structured like:
{
"responseCode": 0,
"responseText": "An error occurred while creating policy",
"path": "/v1/products/leadway/buy-third-party"
}
{
"responseCode": 1,
"responseText": "[Success message]",
"data": {}
}
If you require assistance with integrations or have any questions, we’re happy to help. You can reach out to us through email .
Testing
During your integration into MyCover.ai, it’s important to check that it works properly before going live. So you don’t have to mess with real data during integration, we provide you with a test environment to imitate real operations from your dashboard.
Go Live Checklist
We've put together a checklist of necessary steps you must take before going live on your MyCover.AI dashboard, which will streamline the integration of our APIs and guarantee a smooth user experience.