/basel/ranking

POST /api/basel/ranking

Price: 10 credits

Basel AML Index Public Edition ranking of jurisdictions by money laundering and terrorist financing risk

How to use it

Returns the Basel AML Index Public Edition: each jurisdiction's overall ML/TF risk score (0-10, higher is riskier) and its rank, rank 1 being the highest risk. Filter by name keyword, World Bank region or income group; results come highest risk first unless sorted otherwise, capped at count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Text matched against the jurisdiction name (examples: "Switz", "guinea")
• regions array nullable — Keep only jurisdictions in any of these World Bank regions (one of: "East Asia & Pacific", "Europe & Central Asia", "Latin America & the Caribbean", "Middle East & North Africa", "North America", "South Asia", "Sub-Saharan Africa")
• income_levels array nullable — Keep only jurisdictions in any of these World Bank income groups (one of: "High income", "Upper middle income", "Lower middle income", "Low income")
• sort_by string — Field the results are ordered by (default: "rank"; one of: "rank", "name", "score")
• sort_order string — Ascending or descending order (default: "asc"; one of: "asc", "desc")
• count integer required — Max number of jurisdictions to return (min: 1)

Response

• @type string (default: "BaselRankingEntry")
• id string required
• rank integer nullable
• name string nullable
• iso2 string nullable
• iso3 string nullable
• score number nullable
• region string nullable
• subregion string nullable
• income_level string nullable
• has_fatf_4th_round_evaluation boolean nullable
• created_at integer nullable
• edition object nullable
  • @type string (default: "BaselEdition")
  • id string required
  • edition_type string nullable
  • release_date string nullable
  • year integer nullable
  • quarter string nullable
  • description string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.