Skip to main content

Base URL

Production
URL
https://app.ezyshield.com.au/api
Sandbox
URL
https://sandbox.ezyshield.com.au/api

Required headers

Send JSON requests with these headers:
Accept: application/json
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
File upload endpoints, such as ABA file checks, use multipart requests where documented.

OpenAPI specification

The OpenAPI document is available at api.json.

Common behavior

Authentication

Send API keys and understand organization-scoped abilities.

Errors

Handle common HTTP statuses and validation failures.

Pagination

Navigate list endpoints.

Filtering and sorting

Shape list results where endpoint filters and sorts are available.