/wolfsberg/resources/search

POST /api/wolfsberg/resources/search

Price: 20 credits

Search the Wolfsberg Group publications library, including the CBDDQ and FCCQ questionnaires, guidance, FAQs and consultation responses, with download links per language

How to use it

Returns publications newest first, each with its English text and one document link per available language, so pass query to narrow by title or body words and focus_area for one work stream. The questionnaires are blank templates, so do not expect any bank's completed CBDDQ here.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Text matched against the publication title and body (examples: "CBDDQ", "sanctions")
• focus_area string nullable — Keep only publications filed under this focus area (one of: "effectiveness", "innovation", "correspondent-banking", "rba", "digital-assets", "general")
• count integer required — Max number of publications to return (min: 1)

Response

• @type string (default: "WolfsbergResource")
• id string required
• publication_type string nullable
• document_category string nullable
• document_subcategory string nullable
• focus_areas array (default: [])
  • @type string (default: "WolfsbergFocusAreaRef")
  • id string required
  • alias string nullable
  • name string nullable
  • description string nullable
• year integer nullable
• publication_date string nullable
• text string nullable
• additional_text string nullable
• documents array (default: [])
  • @type string (default: "WolfsbergDocument")
  • language string nullable
  • url string nullable
  • file_title string nullable
  • file_name string nullable
  • mime_type string nullable
  • file_size integer nullable
  • uploaded_at integer nullable
  • translated_text string nullable
  • translated_additional_text string nullable
• image string nullable
• is_timeline_milestone boolean nullable
• timeline object nullable
  • @type string (default: "WolfsbergTimelineEntry")
  • id string required
  • year integer nullable
  • text string nullable
  • milestones array (default: [])
  • image string nullable
• created_at integer nullable
• updated_at integer 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.