List

List

Use this endpoint to obtain the list of businesses created within a specified date range. In the request JSON, you must provide the date range and the number of businesses you want to be listed on each page.

GET Business/List 

Run in Postman

Request Params

Field	Type	Description
Page	int	Selected page number to be listed.
PageSize	int	Number of businesses to be listed in each page. Note: PageSize can be maximum of 100.
FromDate	string	List Businesses created from in MM/DD/YYYY Format.
ToDate	string	List Businesses created upto in MM/DD/YYYY Format.

Response Body

Field	Type	Description
StatusCode	number	Returns the status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message
Business	object[]	Business Details of all the business
BusinessId	Guid	Business Identifier (Autogenerated)
PayerRef	string	Unique identifier of the payer. Set by the client.
BusinessNm	string	Name of the Business.
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
EINorSSN	string	Employer Identification Number or Social Security Number
Email	string	Optional Employer's email address.
ContactNm	string	Optional Name of a person who could be contacted by the IRS if needed.
BusinessType	string	Type of business entity.
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
Page	number	Requested Page Number.
TotalRecords	number	Total number of records returned in the response.
TotalPages	number	Number of pages with the records.
PageSize	number	Requested Page Size.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Payload

Request Params

"Business/List?Page=1&PageSize=10&FromDate=08/01/2024&ToDate=08/02/2024"

Response Json

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

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "Businesses": [
      {
          "BusinessId": "69b9461c-c107-41d4-9582-1ef544a4a961",
          "PayerRef": "Snow123",
          "BusinessNm": null,
          "FirstNm": "James",
          "MiddleNm": null,
          "LastNm": "Smith",
          "Suffix": null,
          "EINorSSN": "XXX-XX-0999",
          "Email": "james@sample.com",
          "ContactNm": "James Smith",
          "BusinessType": "PART",
          "IsBusinessTerminated": false
      },
      {
          "BusinessId": "519a84f4-5e56-496a-82f3-18f51fdf3d75",
          "PayerRef": "Snow123",
          "BusinessNm": "SnowDaze LLC",
          "FirstNm": null,
          "LastNm": null,
          "MiddleNm": null,
          "Suffix": null,
          "EINorSSN": "XX-XXX0999",
          "Email": "james@sample.com",
          "ContactNm": "James Smith",
          "BusinessType": "PART",
          "IsBusinessTerminated": false
      }
  ],
  "Page": 1,
  "TotalRecords": 2,
  "TotalPages": 1,
  "PageSize": 10,
  "Errors": null
}

Node.js

Python

Java

.NET C#