List all Businesses (Program)

Retrieves list of all businesses that belong to a program
List all Businesses (Program)
 last updated: 
August 15, 2022

ENDPOINT

  1. GET /v1/program/:id/business

FILTERS

The table below describes various filters that can be passed as query parameters to narrow the response.

Filter Type Description
offset int start index (default = 0)
limit int number of records to return (default = 25, max = 100)
id string person ID
phone string Phone number in e.164 format
email string email address
createdPersonId string ID of person who created the business
idNumber string SSN, Passport, or other ID number
status enum active, inactive, deactivated, or dormant
kybstatus enum notStarted, submitted, approved, declined, or inReview
entityType enum soleProprietor, singleMemberLLC, limitedLiabilityCompany, generalPartnership, unlistedCorporation, publiclyTradedCorporation, association, nonProfit, governmentOrganization, revocableTrust, irrevocableTrust, estate, limitedPartnership, limitedLiabilityPartnership
industry enum industry the business belongs to: possible values
startTime string Created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
endTime string Created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedStartTime string Modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedEndTime string Modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
externalId string Matches the externalId key if set in the object's metadata
query string searches the legalName field for the query string/td>


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "bus-e51c8e9b-cc76-4806-92fa-e98345d19951",
  6.             "legalName": "Johnston - Kerluke",
  7.             "entityType": "limitedLiabilityCompany",
  8.             "dba": "Wise R&D",
  9.             "email": "",
  10.             "idNumber": "310000099",
  11.             "idType": "ein",
  12.             "phone": "",
  13.             "formationDate": "2020-11-20",
  14.             "website": "",
  15.             "about": "",
  16.             "industry": "softwarePublisher",
  17.             "address": {
  18.                 "addressType": "billing",
  19.                 "line1": "123 Main St",
  20.                 "line2": "",
  21.                 "city": "New York",
  22.                 "state": "NY",
  23.                 "country": "US",
  24.                 "postalCode": "10001"
  25.             },
  26.             "kyb": {
  27.                 "id": "kyb-0a28cf76-bc83-42ac-bc06-64606cc14c78",
  28.                 "businessId": "bus-e51c8e9b-cc76-4806-92fa-e98345d19951",
  29.                 "status": "approved",
  30.                 "reviewCode": "",
  31.                 "reviewMessage": "",
  32.                 "results": {
  33.                     "fraud": "notStarted",
  34.                     "address": "notStarted",
  35.                     "businessName": "notStarted",
  36.                     "personName": "notStarted"
  37.                 },
  38.                 "createdAt": "2021-12-17T08:28:42Z",
  39.                 "modifiedAt": "2021-12-17T08:28:48Z"
  40.             },
  41.             "disclosureStatus": "notStarted",
  42.             "createdAt": "2021-12-17T08:28:41Z",
  43.             "modifiedAt": "2021-12-17T08:28:41Z",
  44.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  45.             "createdPersonId": "per-ac3994a7-5447-4b66-b4bc-80e1e74fd258",
  46.             "metadata": null,
  47.             "status": "active"
  48.         },
  49.         {
  50.             "id": "bus-7b0c95ff-c146-48a7-b5bd-7b346848aa22",
  51.             "legalName": "Acme R&D LLC",
  52.             "entityType": "limitedLiabilityCompany",
  53.             "dba": "",
  54.             "email": "hello@acme.com",
  55.             "idNumber": "886696661",
  56.             "idType": "ein",
  57.             "phone": "+12025961737",
  58.             "formationDate": "",
  59.             "website": "",
  60.             "about": "",
  61.             "industry": "softwarePublisher",
  62.             "address": {
  63.                 "addressType": "mailing",
  64.                 "line1": "123 Main St",
  65.                 "line2": "",
  66.                 "city": "New York",
  67.                 "state": "NY",
  68.                 "country": "US",
  69.                 "postalCode": "10001"
  70.             },
  71.             "kyb": {
  72.                 "id": "kyb-badace66-d74d-482c-b339-21fc7075fd8c",
  73.                 "businessId": "bus-7b0c95ff-c146-48a7-b5bd-7b346848aa22",
  74.                 "status": "approved",
  75.                 "reviewCode": "",
  76.                 "reviewMessage": "",
  77.                 "results": {
  78.                     "fraud": "notStarted",
  79.                     "address": "notStarted",
  80.                     "businessName": "notStarted",
  81.                     "personName": "notStarted"
  82.                 },
  83.                 "createdAt": "2021-12-17T08:15:14Z",
  84.                 "modifiedAt": "2021-12-17T08:17:07Z"
  85.             },
  86.             "disclosureStatus": "pending",
  87.             "createdAt": "2021-12-17T08:15:13Z",
  88.             "modifiedAt": "2021-12-17T08:17:02Z",
  89.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  90.             "createdPersonId": "per-84863aa1-f535-4d95-832c-7e72d852dd5e",
  91.             "metadata": {
  92.                 "DepartmentId": "ITDep",
  93.                 "EmployeeId": "SD001",
  94.                 "Position": "Manager"
  95.             },
  96.             "status": "active"
  97.         }
  98.     ]
  99. }