Developers

Verification API

Check AUDEDU certification status programmatically — for example from AUDCOM Marketing Monitoring or a firm's own compliance systems. The API returns no more than the public register and honours the same consent rules.

Base URL

https://audedu.auditiams.com/api/v1

Authentication

Every request needs an API key, issued by an AUDEDU administrator. Send it as a bearer token. Keys are secret — store them server-side.

curl https://audedu.auditiams.com/api/v1/certificates/AUDEDU-7K3P-9QRT-M4XZ \
  -H "Authorization: Bearer aud_live_your_key_here"

Missing or invalid/revoked keys return 401.

Rate limits

Each key has a per-minute limit (default 60). Responses include X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Exceeding the limit returns 429 with a Retry-After header.

GET /certificates/{code}

Verify a single certificate or certification credential by its code. Status, dates and the certification title are always returned; the holder is named only if that person consented to the register (otherwise holder is null). Unknown codes return 404.

{
  "code": "AUDEDU-7K3P-9QRT-M4XZ",
  "kind": "CERTIFICATION",
  "status": "VALID",              // VALID | EXPIRED | REVOKED
  "certification": "Introducing Broker Certification",
  "issuedAt": "2026-08-10T00:00:00.000Z",
  "expiresAt": "2027-08-10T00:00:00.000Z",
  "holder": {                      // null if the holder hasn't consented
    "name": "Jane Q. Broker",
    "firm": "Acme Broking Ltd",    // null unless opted in
    "jurisdiction": "CY"           // null unless opted in
  }
}

GET /register

Search the register. Only consented individuals are returned, and a field can only be searched among people who made it public. Query params: name, id (certificate code), firm, jurisdiction, limit (max 100), offset.

GET /api/v1/register?firm=acme&jurisdiction=CY&limit=20

{
  "total": 1,
  "limit": 20,
  "offset": 0,
  "count": 1,
  "results": [
    {
      "name": "Jane Q. Broker",
      "firm": "Acme Broking Ltd",
      "jurisdiction": "CY",
      "certifications": [
        {
          "certification": "Introducing Broker Certification",
          "status": "VALID",
          "issuedAt": "2026-08-10T00:00:00.000Z",
          "expiresAt": "2027-08-10T00:00:00.000Z",
          "code": "AUDEDU-7K3P-9QRT-M4XZ"
        }
      ]
    }
  ]
}

Status values

  • VALID — active and within its validity window.
  • EXPIRED — past its expiry date.
  • REVOKED — withdrawn by an administrator.