API Overview
You can test the API endpoints in this document on our Swagger API page.
To begin using the Compliance AML API, you will need a valid API Key.
If you already have a Compliance AML platform account, you can view and manage your API Key directly within the platform.
If you do not have an account, please contact bd@certik.com to request access.
Once issued, your API Key must be kept secure and never shared in public channels or with unauthorized parties.
API Directory
Section titled “API Directory”Appendix
Section titled “Appendix”BASE URL
Section titled “BASE URL”https://api.compliance.certik.com/v4Authentication
Section titled “Authentication”Required Request Headers
Section titled “Required Request Headers”To authenticate a request, include the following two headers with valid credentials:
| Header Field | Description | Example Value |
|---|---|---|
X-API-Key | Unique identifier for the customer’s API access | hubbuxihpvznyrdfpsosmkghgegvdavn |
X-API-Secret | Secret key paired with the API Key for secure authentication | TTYAVYAZJYABBTLDHHPEBVDPRFRRCDMY |
Authentication Failure Consequences
Section titled “Authentication Failure Consequences”- Missing, invalid, or expired
X-API-KeyorX-API-Secretwill result in a401 Unauthorizederror (see Errors for details). - Credentials that have been revoked by CertiK (e.g., due to non-compliance with terms of service) will also trigger a
401 Unauthorizederror.
Universal Response Format
Section titled “Universal Response Format”All API endpoints follow this top-level response structure. Only the data field varies by endpoint:
| Top-Level Field | Type | Description |
|---|---|---|
code | Number | Status code: - 200: Success - 400: Bad Request - 401: Unauthorized - 404: Not Found - 429: Too Many Requests - 500: Internal Server Error |
message | String | Human-readable outcome (e.g., “success”, “invalid chain”) |
data | Null/Object/Array | Business-specific response content (only returned on success; structure varies by endpoint) |
Success Response Template
Section titled “Success Response Template”{ "code": 200, "message": "success", "data": { // Endpoint-specific content }}Error Response Template:
Section titled “Error Response Template:”{ "code": 400, "message": "invalid chain", "data": null}