Skip to main content

Base URL

The base URL for the Verification API is
https://api.ezyshield.com.au/verification/v1

Authentication

The Verification API uses API keys for authentication. See Authentication for details. API keys are scoped to a specific workspace, and all requests are automatically scoped to that workspace through the Authorization header.
API key tokens always start with wrk_sk_.
To create an API key, use the Management API to first create a workspace and then create an API key.

Rate limits

The Verification API has a rate limit of 60 requests per minute per workspace. See the Rate Limiting documentation for more information.

OpenAPI specification

The Verification API is documented in the OpenAPI 3.1.0 format and can be viewed here.