Skip to main content
POST
Query the bank-specific bad actor list for a consumer

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.

Minimum array length: 1
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_identity_id
string<uuid> | null

Consumer identity id, as returned by entity search. Use instead of consent_id, not with it.

Response

Successful Response

provenance_event_id
string<uuid>
required
consumer_identity_id
string<uuid>
required
is_listed
boolean
required

Whether any bad actor listing for the consumer is visible within the queried networks.

furnishing_entity_id
string<uuid> | null

Institution that placed the most recent listing. Null when not listed.

furnishing_entity_name
string | null

Name of the institution that placed the most recent listing. Null when not listed.

bad_actor_reason_code
string | null

Reason code of the most recent listing (account_abuse, fraud or policy_violation). Null when not listed.

bad_actor_reason_definition
string | null

The documented bank policy the consumer violated. Null when not listed.

bad_actor_list_placement_date
string<date> | null

Date the consumer was placed on the list by the most recent listing. Null when not listed.