API for products and integrations

A3.Trust supplies verdicts to other systems: A3.HR, A3.Sales, and the company’s HR and procurement systems. The public API and webhooks work from the first release, and the sandbox in the product helps you connect without reading code.

Principles

  • API key with permissions

    A key is issued in the integrations section with a set of permissions: create checks, read checks, monitoring, read subjects, check orders. The key can be reissued without downtime.

  • Idempotency

    Resending a request with the same Idempotency-Key does not create a second check and does not deduct it from the package. The same key with a different body returns an error.

  • Rate limiting

    The limit of requests per minute is set per key. Exceeding it returns a clear error, and the request log shows every call.

  • Verdict, not materials

    The API returns the decision within the requester’s scope: type, restrictions, validity period. Subjects can be found only by identifier, so dossiers cannot be enumerated by surname.

Core operations

The methods are available at the PublicApi address in your organization’s storage region. The full list of fields is in the API documentation.

POSTCreateCheckRequest

Create a check request

GETGetCheckRequestStatus

Request status and verdict

GETGetActiveVerdict

Active verdict without a new check

POSTSetSubjectMonitoring

Put a subject on monitoring

DELETERemoveSubjectMonitoring

Remove a subject from monitoring

GETGetSubjectRiskLabels

Subject risk labels

GETFindSubject

Find a subject by identifier

POSTCheckOrderCompliance

Check an order against the prohibited services registry

Example: active verdict for a subject

The main scenario for consumer systems: get a decision without creating a new check.

GET /PublicApi/GetActiveVerdict?subjectId=1024
API-KEY: a3t_7c41…
Domain: company
{
  "verdictType": "ApprovedWithRestrictions",
  "riskLevel": "Moderate",
  "restrictions": [
    { "type": "FullPrepayment" },
    { "type": "AmountLimit", "amount": 25000000, "currency": "KZT" }
  ],
  "validUntil": "2027-10-14",
  "reasonForRequester": "Налоговая задолженность погашена, судебные споры в работе"
}

Webhooks

Consumer systems do not poll the API in a loop: events arrive on their own. Every call is signed with HMAC-SHA256, the delivery log shows the recipient’s response, and a failed delivery can be retried.

trust.check.accepted

Request accepted for processing

trust.check.rejected

Request rejected with a reason

trust.check.info_requested

Additional information requested

trust.check.completed

Verdict issued

trust.check.verdict_revoked

Verdict revoked or revised

trust.monitoring.alert

Critical monitoring alert

Sandbox in the product

In the integrations section, the administrator picks a key and an operation, edits a ready-made request example and sees the response and the curl command. Operations that change data require separate confirmation.

API contract with A3.HR

Candidate checks work out of the box: the hr.background_check and trust.check events are aligned at the level of the products’ API contracts.