BI Search Recipients Results

After performing a Business Insights (BI) Recipient Accounts Search, use this API to query the search status and retrieve a download URL for the search results.

Endpoint

GET /v1/search/recipients/{queryId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

queryId REQUIRED

string (UUID)

ID returned by the BI Search Recipient Accounts API.

Request Body

None

Returns

Returns the search status. If the search status is FINISHED, also returns a download URL and filename for the search results.

The following fields are returned.

status

string enum, values: SUBMITTED, PICKED, STARTED, FINISHED, ABORTED, FAILED, ALL

Transaction search status.

downloadUrl

string

Link to download the search results. The link is available for approximately 60 minutes.

fileName

string

Search results filename.

SAMPLE RESPONSE

				
					{
  "status": "SUBMITTED",
  "downloadUrl": "https://rktbi-dev-datastore.s3.amazonaws.com/transaction_search_fSRzcBwPjn000.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjECIaCXVzLWVhc3QtMSJHMEUCIGd%2FocB%2BrSFeuxd8XqPB4%2Fy17RXxjV3vRbepnypH55DPAiEA7tK%2Fr%2BCH2CjVXz3fVs6NG2CkIZ0n4J%2F9BGy5ZVL2J6",
  "fileName": "results.csv"
}