List all Members

‍Retrieves all the members of the business by passing the businessId or the familyId parameter
Member
List all Members
 last updated: 
September 8, 2022

ENDPOINT

  1. GET /v1/member

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)
familyId string family ID
businessId string business ID


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "mem-7ab2679c-3ab1-466b-a111-ef441bd9f460",
  6.             "businessId": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  7.             "isControlPerson": true,
  8.             "ownership": "60",
  9.             "title": "Senior Manager",
  10.             "person": {
  11.                 "id": "per-eda50166-0697-4e27-abf5-9fc1f2be2e95",
  12.                 "firstName": "Jane",
  13.                 "middleName": "",
  14.                 "lastName": "Doe",
  15.                 "phone": "+19418405939",
  16.                 "phoneVerified": false,
  17.                 "email": "jane.doe@gmail.com",
  18.                 "emailVerified": false,
  19.                 "dateOfBirth": "1974-04-22",
  20.                 "idType": "ssn",
  21.                 "idNumber": "287654321",
  22.                 "address": {
  23.                     "addressType": "mailing",
  24.                     "line1": "789 Main St",
  25.                     "line2": "",
  26.                     "city": "New York",
  27.                     "state": "NY",
  28.                     "country": "US",
  29.                     "postalCode": "10001"
  30.                 },
  31.                 "kyc": {
  32.                     "id": "kyc-dceff412-342b-46ef-994f-662a3b45a7eb",
  33.                     "personId": "per-eda50166-0697-4e27-abf5-9fc1f2be2e95",
  34.                     "status": "notStarted",
  35.                     "reviewCode": "",
  36.                     "reviewMessage": "",
  37.                     "results": {
  38.                         "idv": "notStarted",
  39.                         "address": "notStarted",
  40.                         "dateOfBirth": "notStarted",
  41.                         "fraud": "notStarted"
  42.                     },
  43.                     "createdAt": "2021-12-15T17:58:12Z",
  44.                     "modifiedAt": "2021-12-15T17:58:12Z"
  45.                 },
  46.                 "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  47.                 "createdAt": "2021-12-15T17:58:11Z",
  48.                 "modifiedAt": "2021-12-15T19:39:39Z",
  49.                 "language": "",
  50.                 "metadata": null,
  51.                 "status": "active"
  52.             },
  53.             "createdAt": "2021-12-15T17:58:11Z",
  54.             "modifiedAt": "2021-12-15T19:39:39Z"
  55.         },
  56.         {
  57.             "id": "mem-0ef22370-70f3-4943-8afc-3fe7e69a1352",
  58.             "businessId": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  59.             "isControlPerson": true,
  60.             "ownership": "0",
  61.             "title": "",
  62.             "person": {
  63.                 "id": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  64.                 "firstName": "John",
  65.                 "middleName": "",
  66.                 "lastName": "Doe",
  67.                 "phone": "+19418405843",
  68.                 "phoneVerified": false,
  69.                 "email": "johndoe@gmail.com",
  70.                 "emailVerified": false,
  71.                 "dateOfBirth": "1974-01-25",
  72.                 "idType": "ssn",
  73.                 "idNumber": "223902234",
  74.                 "address": {
  75.                     "addressType": "mailing",
  76.                     "line1": "123 Main St",
  77.                     "line2": "",
  78.                     "city": "New York",
  79.                     "state": "NY",
  80.                     "country": "US",
  81.                     "postalCode": "10001"
  82.                 },
  83.                 "kyc": {
  84.                     "id": "kyc-d40f6bdd-6e12-446e-a3a8-7bd3b2dbb182",
  85.                     "personId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  86.                     "status": "approved",
  87.                     "reviewCode": "",
  88.                     "reviewMessage": "",
  89.                     "results": {
  90.                         "idv": "approved",
  91.                         "address": "approved",
  92.                         "dateOfBirth": "approved",
  93.                         "fraud": "approved"
  94.                     },
  95.                     "createdAt": "2021-12-14T21:25:19Z",
  96.                     "modifiedAt": "2021-12-14T22:02:40Z"
  97.                 },
  98.                 "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  99.                 "createdAt": "2021-12-14T23:35:28Z",
  100.                 "modifiedAt": "2021-12-14T23:35:28Z",
  101.                 "language": "",
  102.                 "metadata": null,
  103.                 "status": "active"
  104.             },
  105.             "createdAt": "2021-12-14T23:35:28Z",
  106.             "modifiedAt": "2021-12-14T23:35:28Z"
  107.         }
  108.     ]
  109. }