API reference

Organisation

The reporting entity's details, as they appear on filings.

These endpoints need a signed-in person, not an API key. Anyone signed in can read the organisation. Only an admin can change it.

Get the organisation

GET /v1/organisation

Terminal

curl "$SENTINEL_URL/v1/organisation" \
  -H "Authorization: Bearer $SENTINEL_SESSION"

The response has institution, licence (the licence or registration number with the regulator), regulator, officer (the money laundering reporting officer), and ctr_threshold, an amount with a currency. An organisation that has never saved these reads as the defaults: "Your organisation", the Bank of Ghana, and a 50,000 GHS threshold.

Update it

PUT /v1/organisation

Replaces all five fields. institution and regulator are 1 to 120 characters, licence is at most 60, officer at most 120, and ctr_threshold must be more than zero. Every change is written to the audit log with the values before and after.

Edit this pageorReport an issue

Reports

Draft, review and file STRs, nightly CTR batches and evidence packs with the Financial Intelligence Centre.

Setup

The first-run calls that check a licence file and create the organisation's first admin.