Generate and run new a pipeline from bank account preset input

Queue a bulk export of compromised bank account records scoped to your organization.

What this endpoint does

This endpoint submits a bulk data request for compromised bank account records from Payment Fraud Intelligence (PFI). Bank account data includes routing numbers, account numbers, and associated personally identifiable information observed in underground markets and forums. Records are scoped to your organization's data. Specify a queryRange with DSL date math for periodic collection — the queryRange uses timeStampAdded as its datetime field. Use the dryRun option at the root level of the request body to preview the record count without creating a task. After submission, use the PFI: Task Status endpoint to poll for completion, then the PFI: Pickup Data endpoint to retrieve results. To download images associated with bank account records, use the PFI: Bank Account Images endpoint. Refer to the PFI: Bank Account Data dictionary for available fields.

Response data

A successful response returns the count of matching records and, when records exist and dryRun is not set, a taskId for tracking the asynchronous collection task. If the count is zero, no task is created.

Body Params

preset config

preset config

boolean
input
object

Client configuration for bank accounts data preset.

output
object

Output configuration for preset data delivery.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json