Gather Business Insights (BI) by analyzing one or more Recipient Accounts.
Use this API to search Recipient Accounts based on filters such as the account status, Recipient name, and Recipient contact details. The API returns a queryId that can be used to query the search status and retrieve the results.
POST /v1/search/recipients
Authorization: Bearer <access_token>
businessAccountIds REQUIRED
string (UUID)
Provide a list of one or more Business Account IDs. Recipient Accounts belonging to these Business Accounts will be included in the search.
fromCreatedAt
string (date), required 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), required 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:
recipientType
string enum, values: INDIVIDUAL, BUSINESS
Type of Recipient Account.firstName
string, max length: 40, min length: 1
Recipient’s first name.
middleName
string, max length: 40, min length: 1
Recipient’s middle name.
lastName
string, max length: 40, min length: 1
Recipient’s last name.
doingAsBusinessName
string, max length: 40, min length: 1
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
format: [+] [country code] [phone number including area code]
Recipient’s phone number. The phone number can be entered in any of the following formats:
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 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
{
"businessAccountIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"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"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.