List all Businesses

Retrieves list of all the businesses associated to the person ID
Business
List all Businesses
 last updated: 
August 29, 2022

ENDPOINT

  1. GET /v1/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)
personId string person ID
status enum active, inactive, deactivated, or dormant
kybstatus enum notStarted, submitted, approved, declined, or inReview
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)
externalId string Matches the externalId key if set in the object's metadata


RESPONSE

  1. {
  2.     "total": 1,
  3.     "data": [
  4.         {
  5.             "id": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  6.             "legalName": "Acme Business LLC",
  7.             "entityType": "limitedLiabilityCompany",
  8.             "dba": "Acme Corp",
  9.             "email": "john@acme.com",
  10.             "idNumber": "187654321",
  11.             "idType": "ein",
  12.             "phone": "+16604491146",
  13.             "formationDate": "2018-02-18",
  14.             "website": "acme.com",
  15.             "about": "clinic for health issues",
  16.             "industry": "healthServices",
  17.             "address": {
  18.                 "addressType": "mailing",
  19.                 "line1": "456 Main St",
  20.                 "line2": "",
  21.                 "city": "New York",
  22.                 "state": "NY",
  23.                 "country": "US",
  24.                 "postalCode": "10001"
  25.             },
  26.             "kyb": {
  27.                 "id": "kyb-f9e32837-19d8-4f66-923b-18648169a8eb",
  28.                 "businessId": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  29.                 "status": "notStarted",
  30.                 "reviewCode": "",
  31.                 "reviewMessage": "",
  32.                 "results": {
  33.                     "fraud": "notStarted",
  34.                     "address": "notStarted",
  35.                     "businessName": "notStarted",
  36.                     "personName": "notStarted"
  37.                 },
  38.                 "createdAt": "2021-12-14T23:35:28Z",
  39.                 "modifiedAt": "2021-12-14T23:35:28Z"
  40.             },
  41.             "disclosureStatus": "notStarted",
  42.             "createdAt": "2021-12-14T23:35:27Z",
  43.             "modifiedAt": "2021-12-14T23:50:26Z",
  44.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  45.             "createdPersonId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  46.             "metadata": null,
  47.             "status": "active"
  48.         }
  49.     ]
  50. }