List all Members (Program)

Retrieves list of all members that belong to a program
Program
List all Members (Program)
 last updated: 
September 8, 2022

ENDPOINT

  1. GET /v1/program/:id/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)
id string member ID
personId string Person ID
businessId string Business ID
isControlPerson bool Control person flag
minOwnership int Minimum ownership percentage
maxOwnership int Maximum ownership percentage
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)


RESPONSE

  1. {
  2.   "total": 2,
  3.   "data": [
  4.     {
  5.       "id": "mem-5f9126fc-13e3-4678-969f-810701a2550c",
  6.       "businessId": "",
  7.       "isControlPerson": false,
  8.       "ownership": "0",
  9.       "title": "",
  10.       "person": {
  11.         "id": "per-de343f0d-abc4-43af-b3d0-540e3994f3af",
  12.         "firstName": "John",
  13.         "middleName": "",
  14.         "lastName": "Doe",
  15.         "phone": "+12418401234",
  16.         "phoneVerified": false,
  17.         "email": "john.doe.0331@gmail.com",
  18.         "emailVerified": false,
  19.         "dateOfBirth": "1974-01-25",
  20.         "idType": "ssn",
  21.         "idNumber": "223902234",
  22.         "address": {
  23.           "addressType": "mailing",
  24.           "line1": "1 Broadway",
  25.           "line2": "",
  26.           "city": "Los Gatos",
  27.           "state": "CA",
  28.           "country": "US",
  29.           "postalCode": "95030"
  30.         },
  31.         "kyc": {
  32.           "id": "kyc-5dd8f11d-5477-463f-958e-83d1b1da55e1",
  33.           "personId": "per-de343f0d-abc4-43af-b3d0-540e3994f3af",
  34.           "status": "notStarted",
  35.           "reviewCode": "",
  36.           "reviewMessage": "",
  37.           "results": {
  38.             "idv": "notStarted",
  39.             "address": "notStarted",
  40.             "dateOfBirth": "notStarted",
  41.             "fraud": "notStarted"
  42.           },
  43.           "createdAt": "2022-06-15T22:37:23Z",
  44.           "modifiedAt": "2022-06-15T22:37:23Z"
  45.         },
  46.         "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  47.         "createdAt": "2022-06-15T23:07:18Z",
  48.         "modifiedAt": "2022-06-15T23:07:18Z",
  49.         "language": "en",
  50.         "metadata": null,
  51.         "status": "active"
  52.       },
  53.       "createdAt": "2022-06-15T23:07:18Z",
  54.       "modifiedAt": "2022-06-15T23:07:18Z",
  55.       "familyId": "fam-d8b5d10e-9bc0-4c5d-9ecd-3ef95bf8f2fa"
  56.     },
  57.     {
  58.       "id": "mem-6bb74cbf-58dd-42fc-b953-07ba4d8f8d5a",
  59.       "businessId": "",
  60.       "isControlPerson": true,
  61.       "ownership": "0",
  62.       "title": "",
  63.       "person": {
  64.         "id": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  65.         "firstName": "Jane",
  66.         "middleName": "",
  67.         "lastName": "Doe",
  68.         "phone": "+15555555555",
  69.         "phoneVerified": false,
  70.         "email": "justin@solidfi.com",
  71.         "emailVerified": false,
  72.         "dateOfBirth": "1974-01-25",
  73.         "idType": "ssn",
  74.         "idNumber": "999999999",
  75.         "address": {
  76.           "addressType": "mailing",
  77.           "line1": "123 Main St",
  78.           "line2": "",
  79.           "city": "New York",
  80.           "state": "NY",
  81.           "country": "US",
  82.           "postalCode": "10001"
  83.         },
  84.         "kyc": {
  85.           "id": "kyc-78f35d60-6036-41cf-aba0-4c06cbd46473",
  86.           "personId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  87.           "status": "approved",
  88.           "reviewCode": "",
  89.           "reviewMessage": "",
  90.           "results": {
  91.             "idv": "approved",
  92.             "address": "approved",
  93.             "dateOfBirth": "approved",
  94.             "fraud": "approved"
  95.           },
  96.           "createdAt": "2022-06-15T22:44:55Z",
  97.           "modifiedAt": "2022-06-20T20:05:43Z"
  98.         },
  99.         "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  100.         "createdAt": "2022-06-15T22:57:37Z",
  101.         "modifiedAt": "2022-06-15T22:57:37Z",
  102.         "language": "en",
  103.         "metadata": null,
  104.         "status": "active"
  105.       },
  106.       "createdAt": "2022-06-15T22:57:37Z",
  107.       "modifiedAt": "2022-06-15T22:57:37Z",
  108.       "familyId": "fam-d8b5d10e-9bc0-4c5d-9ecd-3ef95bf8f2fa"
  109.     }
  110.   ]
  111. }