Query the cross-bank financial crimes watch list for a consumer or business

curl --request POST \ --url https://api.example.com/v1/products/cross_bank_financial_crimes_watch_list/query \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "network_ids": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "furnishing_entity_ids": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "consent_id": "<string>", "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } '

{ "query_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "is_listed": true, "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "entity_level_adverse_action_eligible_indicator": true, "watch_list_placement_date": "2023-12-25" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

network_ids

string<uuid>[]

required

Networks to query across; the single policy is applied to all of them.

Minimum array length: 1

policy_id

string<uuid> | null

Querying policy applied across every network in network_ids. If omitted, each network's default policy is used.

furnishing_entity_ids

string<uuid>[] | null

Optional furnishing-entity scope. When omitted or empty, data from all furnishers is considered.

Consent token — system resolves identity + applies field access filtering.

consumer_id

string<uuid> | null

Consumer profile primary key (Consumer.id) for permissible-purpose queries.

Response

Successful Response

query_event_id

string<uuid>

required

consumer_id

string<uuid>

required

is_listed

boolean

required

furnishing_entity_id

string<uuid> | null

entity_level_adverse_action_eligible_indicator

boolean | null

watch_list_placement_date

string<date> | null