BI Search Recipients

Gather Business Insights (BI) by analyzing one or more Recipient Accounts.

Use this API to search Recipient Accounts based on filters such as the Recipient status, name, and contact details. The API returns a queryId that can be used to query the search status and retrieve the results.

Note The search is limited to the Business Account associated with the request access token and its Child Business Accounts.

Endpoint

POST /v1/search/recipients

Authorization Header

Authorization: Bearer <access_token>

Request Body

fromCreatedAt

string (date), format: yyyy-MM-dd

Date the Recipient Account was created in RocketKOR. This filter will return Recipient Accounts created on or after this date.

toCreatedAt

string (date), format: yyyy-MM-dd

Date the Recipient Account was created in RocketKOR. This filter will return Recipient Accounts created on or before this date.

recipientStatus

string enum, values: ACTIVE, SUSPENDED, DELETED

Recipient Account status. The following values are supported:

ACTIVE Recipient Account is active.
SUSPENDED Recipient Account is inactive.
DELETED Recipient Account has been deleted.

recipientType

string enum, values: INDIVIDUAL, BUSINESS

Type of Recipient Account.

firstName

string, min length: 1, max length: 40

Recipient’s first name.

middleName

string, min length: 1, max length: 40

Recipient’s middle name.

lastName

string, min length: 1, max length: 40

Recipient’s last name.

doingAsBusinessName

string, min length: 1, max length: 40

This filter is available for Business Recipient Accounts.

Business operating name. Used by the business in marketing and day-to-day activities.

string (email), max length: 320

Recipient’s email address.

phoneNumber

string

Recipient’s phone number. The phone number can be entered in any of the following formats:

[+][country code][phone number including area code] (example: +14151234)
[country code][phone number including area code] (example: 14151234)
[phone number including area code] (example: 4151234)

RocketKOR will convert the phone number to E.164 format (example: +14151234).

resultFormat

string enum, values: CSV, JSON

Type of file used to store the search results.

Returns

Returns a queryId. Use this queryId to query the search status and retrieve the search results.

queryId

string (UUID)

ID representing the search results.

SAMPLE REQUEST

				
					{
  "fromCreatedAt": "2023-01-01",
  "toCreatedAt": "2023-01-31",
  "recipientStatus": [
    "ACTIVE"
  ],
  "recipientType": [
    "BUSINESS"
  ],
  "firstName": "Jack",
  "middleName": "Fred",
  "lastName": "Smith",
  "doingAsBusinessName": "ACME Corp.",
  "email": "jsmith@acme.com",
  "phoneNumber": "+14151234",
  "resultFormat": "CSV"
}

SAMPLE RESPONSE

				
					{
  "queryId": "88fe3238-8b6c-4de7-a77a-05fe43541d56"
}