Error Codes and Responses
Last updated October 8, 2024
Error Codes and Responses in Veriff API
Understanding error codes and responses is crucial for developers working with the Veriff API. The API serves as a powerful tool for integrating identity verification into your applications, and being aware of potential errors can streamline the development process.
In this article, we'll go over common error codes you may encounter while using the Veriff API, what they mean, and how to address them. Being prepared with this information can save you time and improve your application’s functionality.
Common Error Codes
The following are some of the common error codes you might encounter while interfacing with the Veriff API:
- 400 Bad Request: This error indicates that the API request was malformed or invalid.
- 401 Unauthorized: You will see this error if the API key or authentication token is missing or incorrect.
- 403 Forbidden: This code signifies that you do not have permission to access the requested resource.
- 404 Not Found: This error occurs when the requested resource could not be found on the server.
- 500 Internal Server Error: This indicates a server-side error that prevents the request from being fulfilled.
How to Handle Error Codes
When you encounter an error code, follow these steps to troubleshoot and resolve the issue:
- Check the request payload: Ensure that your request body is correctly formatted according to the API specification.
- Verify authentication credentials: Make sure that your API key or authentication token is valid and included in all requests.
- Review API documentation: Consult the Veriff API documentation for further insight into error codes and their meanings.
- Test the API: Use tools like Postman or curl to manually test the API endpoints and observe responses.
Conclusion
By understanding common error codes and following the troubleshooting steps outlined in this article, you can effectively manage issues while working with the Veriff API. This will not only enhance your development process but also lead to a seamless integration of verification services within your applications.