List

List

This endpoint returns a paginated list of recipients created within a specified date range. Use this to audit your recipient records or build a directory view within your application.

In the request, you must provide the date range and the number of recipients you want to be listed on each page.

GET Recipient/List

Run in Postman

Request Params

Field	Type	Description
BusinessId	Guid	Optional Unique identifier of a business.
PayeeRef	String	OptionalA unique identifier for each payee completing their information. This identifier can be used in future references of the payee in the API. Size Range: 1-50
BusinessTINType	string	OptionalTIN Type of the Business.
BusinessTIN	string	OptionalTIN of the business.
Page	number	OptionalPulls the records listed in the page selected
PageSize	number	OptionalNumber of recipient records to be listed in each page. Note: PageSize can be maximum of 100.
FromDate	string	OptionalEnter a date from which the Form recipient records need to be listed in MM/DD/YYYY format.
ToDate	string	OptionalEnter a date till which the recipient records created are to be listed in MM/DD/YYYY format.
RecipientId	Guid	OptionalA unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.
RecipientTIN	String	OptionalEnter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9
RecipientTINType	String	OptionalSpecify the TIN type of the recipient. Allowed values "SSN", "EIN", "ITIN", "ATIN"

Response Body

Field	Type	Description
Business	object	Object to identify the Business Details.
BusinessId	Guid	Unique identifier of a Business.
BusinessNm	string	Name of the business.
FirstNm	string	First Name of the Individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PayerRef	string	Unique identifier of a Payer.
TINType	string	TIN type of the business.
TIN	string	TIN of the business.
Recipient	object[]	Returns the recipient details.
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.
TINType	string	TIN type of the Recipient.
TIN	string	TIN of the Recipient.
FirstPayeeNm	string	Returns the name of the recipient.
SecondPayeeNm	string	Returns the name of second recipient.
FirstNm	string	First Name of the Individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PayeeRef	string	A unique identifier for each payee completing their information.
Email	string	Email address for whom the online access to be given.
TotalRecords	number	Total number of records listed in the response.
TotalPages	number	Total number of pages.
Page	number	Returns the page number in which the records are listed.
PageSize	number	Number of records listed in each page.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Payload

Request Params

Recipient/List?BusinessId=77cabe33-ce9f-4d65-83ea-1d3d67d4a11a

Response Json

Response	Description	Action
200	Success Response - This is a sample response for successful API requests.

Response: 200

{
"Business": {
  "BusinessId": "177ca4f6-8bae-4b67-afbc-86a24e759831",
  "BusinessNm": "Snowdaze LLC",
  "FirstNm": null,
  "LastNm": null,
  "MiddleNm": null,
  "Suffix": null,
  "PayerRef": "Snow123",
  "TINType": "EIN",
  "TIN": "03-4624530"
},
"Recipient": [
  {
      "RecipientId": "35b5de7e-64bf-45e1-a782-c16d9d7e72a3",
      "TINType": "SSN",
      "TIN": "327-55-9984",
      "FirstpayeeNm": null,
      "SecondpayeeNm": null,
      "FirstNm": "Shawn",
      "LastNm": "Williams",
      "MiddleNm": "B",
      "Suffix": "IV",
      "PayeeRef": "PayeeRef001",
      "Email": "shawn@sample.com"
  }
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}

Node.js

Python

Java

.NET C#