Response Codes

Top-level overview of Response objects & codes used within API

ID Analyzer API uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • 200 OK indicates a successful transaction.
  • 403 Forbidden relates to access clearance.
  • 401 Unauthorized occurs when invalid API key are provided.
  • 400 Bad Request is for invalid JSON structure or missing parameters for your request body.


Graceful Error Handling

Our libraries raise exceptions for many reasons, such as parameter issues, authentication errors, and network unavailability. We recommend writing code that gracefully handles all possible API exceptions.

Error Response Object

A typical Error response object looks like this. Please refer to Validations & Warnings for more details on custom errors implemented throughout the API.

	"success": false,
	"error": {
		"status": 401,
		"message": "Failed to authenticate user, make sure valid credentials are set in Authorization header."