Skip to main content

​
Our APIs

The ezyshield API is split into two APIs, each designed for a specific function.

Management API

Manage your organization, entities and API keys.

Verification API

Verify business/banking details and check for compromises.

​
Headers

All API requests must include the following headers: 
Accept: application/json
Content-Type: application/json

​
Errors

The ezyshield API uses standard HTTP status codes to indicate the success or failure of an API request. Common status codes include:
CodeDescription
200Success
201Created
204No content
400Bad request
401Unauthorized (API key is invalid)
403Forbidden
404Not found
422Unprocessable entity (validation error)
429Too many requests
500Internal server error
503Service unavailable (API offline for maintenance)