Integrations

One HTTP call from your onboarding or credit workflow — company name in, scored risk report with citations out. This page is the five-minute version; field-level schemas and error codes live in the full API docs.

Need a key first? Book a pilot  ·  Auth & logging: Security  ·  No key yet? Live demo uses the same response shape

Quickstart — one company

Pass the company name in the URL path (URL-encoded). Authenticate with the X-API-Key header issued at onboarding.

curl -s "https://api.bria.co.ke/v1/risk/Acme%20Limited" \
  -H "X-API-Key: YOUR_API_KEY"

Production base URL: https://api.bria.co.ke. PDF export: GET /v1/report/{name}?format=pdf — see API docs.

Response shape (200)

JSON you can store on a customer record, drive rules in your core system, or attach to a compliance file. Truncated example — your live response includes full flags[], optional director network, and evidence references.

{
  "query": "Acme Limited",
  "risk_score": 62,
  "risk_rating": "High",
  "confidence": 0.91,
  "coverage_tier": "full",
  "entity": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Acme Limited",
    "match_confidence": 0.91
  },
  "freshness": {
    "scored_at": "2026-07-04T14:22:00Z",
    "weights_version": "3f2a1b8",
    "sources": ["courts", "procurement", "gazette", "media"]
  },
  "flags": [
    {
      "code": "procurement_debarment_active",
      "category": "Debarment",
      "weight": 12,
      "source": "procurement",
      "detail": "Active procurement debarment",
      "explanation": "Listed on a public procurement debarment register."
    }
  ],
  "positive_signals": [],
  "suggestions": []
}

Fields your workflow will use

Field Use in your stack
risk_score / risk_rating Rules engine thresholds — auto-approve, refer, or block
confidence Route low-confidence matches to manual name review
flags[] Display reasons; each item cites a source family
freshness Audit line — when scored, which model version, sources checked
entity.id Stable key for re-screening the same organisation later

Typical stack

Most pilots wire BRIA into an existing CRM or onboarding workflow — not as a standalone app. A common pattern:

  1. Trigger — new merchant, borrower, supplier, or grantee submitted in your CRM / core banking / procurement portal.
  2. Screen — your middleware calls GET /v1/risk/{name} (sync) or queues a batch job for overnight lists.
  3. Decide — map risk_score and flag categories to your policy (e.g. any debarment → manual review).
  4. File — store JSON on the customer record; optional PDF via /v1/report for KYC / credit committee packs.
  5. Re-screen — scheduled job re-queries on periodic review or limit increase — same API, same schema.

Works alongside registry checks (BRS / company existence) — BRIA adds litigation, debarment, media, licences, and director-network signals on top. See use cases by team type.

Batch & errors

Loop the same endpoint over a CSV or message queue — rate limits apply per API key (Security). Errors return {"error": {"code": "...", "message": "..."}} — full catalogue in API docs.