Skip to main content

Compliance Endpoints

Celar’s compliance engine runs KYT (Know Your Transaction) checks automatically on all pay-ins.
Use these endpoints to fetch individual results or review summaries.

1. Get Risk for a Pay-in​

Retrieve the KYT verdict for a specific payin_id.

curl --request GET \
  --url https://api.sandbox.celar.io/api/v1/risk/payments/<payin_id> \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <your_api_key>'

Example Response

{
  "payment_id": "payin_47cb728afdb91063",
  "kytVerdict": "low",
  "totalScore": 0,
  "flags": [],
  "checked_at": "2025-09-26T12:08:08.840Z"
}

2. List Historical KYT Checks​

Retrieve historical KYT risk evaluations for all pay-ins under your PSP.

Optional Query Parameters

  • level → filter by risk level (low, medium, high).
  • limit → number of results to return.
  • offset → pagination offset.
curl --request GET \
  --url "https://api.sandbox.celar.io/api/v1/risk/checks?level=high&limit=10&offset=0" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <your_api_key>'

3. Get Customer Risk Summary​

Retrieve compliance summary for a specific customer.

curl --request GET \
  --url https://api.sandbox.celar.io/api/v1/risk/summary/customers/<customer_id> \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <your_api_key>'

Example Response

{
  "customer_id": "cr_ef211d4ba9c0",
  "risk_level": "medium",
  "last_check": "2025-09-26T11:55:04.522Z"
}

4. Get PSP Risk Summary​

Retrieve an aggregate compliance summary for your entire PSP account.

curl --request GET \
  --url https://api.sandbox.celar.io/api/v1/risk/summary/total \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <your_api_key>'

Example Response

{
  "psp_id": "psp_3563fdacebcb",
  "total_checks": 245,
  "risk_levels": {
    "low": 220,
    "medium": 20,
    "high": 5
  },
  "last_check": "2025-09-26T12:12:47.733Z"
}

Notes​

  • KYT runs only on pay-ins (incoming stablecoin transactions).
  • Payouts and withdrawals do not trigger KYT checks directly.
  • Customer- and PSP-level summaries help you monitor compliance health across your organization.