Aller au contenu

Jurisdictions API

Ce contenu n’est pas encore disponible dans votre langue.

A jurisdiction is a country’s reporting format and codes, cash thresholds, identifier formats, FATF lists, record keeping, regulators and recommended rule packs. This page covers reading them and changing the one your workspace follows.

Endpoint Does Permission
GET /api/v1/jurisdictions Every definition, and your workspace’s current jurisdiction settings.manage or settings.view
GET /api/v1/settings/workspace Includes jurisdiction, jurisdiction_picked and identifier_validation settings.manage or settings.view
PUT /api/v1/settings/workspace Changes them, possibly through approval settings.manage

Signed jurisdiction bundles are imported from the command line, not the API, and each import is audited as jurisdiction.import. See Jurisdictions: for operators.

{
"current": "gh",
"jurisdictions": [
{
"code": "ng",
"version": "1.1.1",
"kind": "country",
"extends": "global",
"name": "Nigeria",
"name_fr": "Nigeria",
"country": "NG",
"region": "ECOWAS",
"currency": "NGN",
"timezone": "Africa/Lagos",
"locale": "en",
"fiu": { "name": "Nigerian Financial Intelligence Unit", "short_name": "NFIU", "url": "https://www.nfiu.gov.ng", "format": "goaml", "notes": "…" },
"reporting": { "report_codes": { "str": "STR", "ctr": "CTR", "sar": "SAR", "ftr": "FTR" }, "submission_code": "E", "id_types": { "bvn": "O", "nin": "B" } },
"thresholds": { "ctr_individual": 5000000, "ctr_business": 10000000, "ctr_aggregate": false, "ctr_comparison": "gt", "fx_report": 10000, "fx_report_currency": "USD", "notes": "…" },
"identifier_types": [
{ "key": "bvn", "label": "Bank Verification Number (BVN)", "label_fr": "Numéro de vérification bancaire (BVN)", "pattern": "\\d{11}", "example": "22123456789", "applies_to": "individual", "issuer": "CBN / NIBSS" }
],
"high_risk_lists": [
{ "id": "fatf-call-for-action", "name": "FATF high-risk jurisdictions subject to a call for action", "source": "FATF plenary, June 2026", "as_of": "2026-06-19", "countries": ["KP", "IR", "MM"] }
],
"sanctions_lists": ["un-sc", "us-ofac-sdn", "us-ofac-cons", "eu-fsf", "gb-uksl", "ng-nigsac"],
"record_keeping_years": 5,
"regulators": [{ "name": "Central Bank of Nigeria", "short_name": "CBN", "role": "…", "url": "https://www.cbn.gov.ng" }],
"recommended_packs": { "psp": ["core", "fraud", "ng-psp", "global-fatf"], "default": ["core", "fraud", "global-fatf"] },
"confirm": ["CTR thresholds NGN 5,000,000 (individual) and NGN 10,000,000 (body corporate)…"],
"sources": [{ "title": "Money Laundering (Prevention and Prohibition) Act, 2022 (ss. 2, 3, 4, 7, 8, 11)", "url": "…" }]
}
]
}

(The example is shortened.) current is your workspace’s jurisdiction code. The list holds every definition, after inheritance: countries by name, then regions, then global.

Field Meaning
code Lower-case id: a country’s ISO code (gh, ng, ci, sl, lr, gm, gn, ke…), a region (uemoa), or global
kind country (a workspace can pick it), region (shared rules that countries extend; can’t be picked) or global (the fallback)
extends The definition this one builds on. A UEMOA state extends uemoa, which extends global
members A region’s member countries
currency, timezone, locale Defaults for a workspace created for this jurisdiction. global has no currency: the workspace’s own applies
fiu.format The report exporter: goaml, or centif-uemoa (the CENTIF declaration, for the UEMOA states and Guinea)
fiu.address The FIU’s postal address, lines separated by newlines. The CENTIF declaration prints it. Today the definitions that have one give only the city (Dakar, Abidjan, Conakry…): the full address is on each definition’s confirm list
fiu.legal_basis The law reports are made under, in the FIU’s language, as it reads on a declaration (Déclaration faite en application de…). Set for uemoa (inherited by its eight states) and gn; its exact reference is to confirm
reporting The FIU’s report codes and lookup codes, which become the defaults of your reporting settings
thresholds In whole units of the jurisdiction’s currency (naira, francs CFA): ctr_individual, ctr_business, ctr_aggregate (whether same-day or linked cash adds up), ctr_comparison (gte: cash at or above the threshold is reported, the default when left out; gt: only cash above it, as in Nigeria), fx_report with fx_report_currency (a foreign transfer threshold; for Liberia and Kenya, the US-dollar figure their cash threshold is written in), occasional_cdd, and notes with the legal basis
identifier_types Each identifier’s key (the national_id.type you send), label, pattern (a regular expression the normalised value must match whole), example, applies_to (individual, business or any) and issuer
high_risk_lists FATF lists with their source and as_of date
sanctions_lists The sanctions lists that apply, by id. The ids are the screening list keys, and they are the lists a workspace of this jurisdiction screens against until it saves its own choice. See Default lists by jurisdiction
record_keeping_years The AML minimum for keeping records
recommended_packs Packs by kind of institution (bank, psp, mobile_money, fintech, microfinance, emi, other); default covers any kind not listed
confirm Values to confirm with the FIU or regulator before relying on them. In the definitions for Sierra Leone, Liberia, The Gambia, Guinea and Kenya (sl, lr, gm, ke at version 1.0.1 and gn at 1.0.2), every researched threshold, deadline and FIU detail appears here as To verify with counsel: …, and fiu.notes and thresholds.notes say the same. Treat those values as unverified

Send the workspace settings back with a new jurisdiction, identifier_validation, or both. See Workspace settings API.

Field Values Meaning
jurisdiction A code from the list The jurisdiction to follow. Empty or left out: unchanged
jurisdiction_picked Read-only false while nobody has picked one. The workspace then follows its country’s definition when its base currency is that definition’s, and global otherwise (a US-dollar workspace in Liberia, for example). Its default sanctions lists follow the country either way
identifier_validation warn (default), reject, off What ingest does with an identifier that doesn’t fit its format. Empty or left out: unchanged

Changing either is the settings.jurisdiction change type. When the workspace requires approval for it, the answer is 202 with a change request instead of the new settings; see Change requests API.

Status detail
422 invalid setting: unknown jurisdiction "xx"
422 invalid setting: UEMOA (West African Economic and Monetary Union) is a region: pick one of its countries (bj, bf, ci, gw, ml, ne, sn, tg)
422 invalid setting: Nigeria uses NGN, but this workspace's base currency is GHS

The change is recorded in the tenant.settings audit entry, with the jurisdiction before and after.