List all Persons

Retrieves list of all persons that belong to a program
Program
List all Persons
 last updated: 
January 12, 2023

ENDPOINT

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

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
idNumber string SSN, Passport, or other ID number
status enum active, inactive, deactivated, or dormant
kycstatus 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)
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)
metadata.query string searches data in the metadata sub-object
query string searches the name field for the query string
dateOfBirth string matches the date of birth (YYYY-MM-DD)


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "per-02e54dd4-e5fb-48ee-9d22-67f98f50cb53",
  6.             "firstName": "Mary",
  7.             "middleName": "",
  8.             "lastName": "Lynn",
  9.             "phone": "+14065958594",
  10.             "phoneVerified": true,
  11.             "email": "katemary@icloud.com",
  12.             "emailVerified": false,
  13.             "dateOfBirth": "1996-09-04",
  14.             "idType": "ssn",
  15.             "idNumber": "516377532",
  16.             "address": {
  17.                 "addressType": "mailing",
  18.                 "line1": "802 N Grand Ave",
  19.                 "line2": "Apt 3A11",
  20.                 "city": "Bozeman",
  21.                 "state": "MT",
  22.                 "country": "US",
  23.                 "postalCode": "59715"
  24.             },
  25.             "kyc": {
  26.                 "id": "kyc-5549db43-fdde-4be4-a857-2c754290fdd7",
  27.                 "personId": "per-02e54dd4-e5fb-48ee-9d22-67f98f50cb53",
  28.                 "status": "approved",
  29.                 "reviewCode": "",
  30.                 "reviewMessage": "",
  31.                 "results": {
  32.                     "idv": "approved",
  33.                     "address": "approved",
  34.                     "dateOfBirth": "approved",
  35.                     "fraud": "approved"
  36.                 },
  37.                 "createdAt": "2021-12-19T17:54:18Z",
  38.                 "modifiedAt": "2021-12-19T18:24:32Z"
  39.             },
  40.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  41.             "createdAt": "2021-12-19T17:54:17Z",
  42.             "modifiedAt": "2021-12-19T19:55:07Z",
  43.             "language": "en",
  44.             "metadata": null,
  45.             "status": "active"
  46.         },
  47.         {
  48.             "id": "per-df7d4338-5f82-4aa6-b636-3cff6440dc22",
  49.             "firstName": "JOSHANDREW ",
  50.             "middleName": "",
  51.             "lastName": "XAVIER",
  52.             "phone": "+12767882643",
  53.             "phoneVerified": true,
  54.             "email": "jakeandrew@gmail.com",
  55.             "emailVerified": false,
  56.             "dateOfBirth": "1994-11-30",
  57.             "idType": "ssn",
  58.             "idNumber": "047530942",
  59.             "address": {
  60.                 "addressType": "mailing",
  61.                 "line1": "5325 Commander Dr",
  62.                 "line2": "Apt 206",
  63.                 "city": "Orlando",
  64.                 "state": "FL",
  65.                 "country": "US",
  66.                 "postalCode": "32822"
  67.             },
  68.             "kyc": {
  69.                 "id": "kyc-1e06a756-9c09-4ef5-9514-b79cd9453f8b",
  70.                 "personId": "per-df7d4338-5f82-4aa6-b636-3cff6440dc22",
  71.                 "status": "declined",
  72.                 "reviewCode": "",
  73.                 "reviewMessage": "",
  74.                 "results": {
  75.                     "idv": "declined",
  76.                     "address": "declined",
  77.                     "dateOfBirth": "declined",
  78.                     "fraud": "declined"
  79.                 },
  80.                 "createdAt": "2021-12-19T15:07:35Z",
  81.                 "modifiedAt": "2021-12-19T15:24:17Z"
  82.             },
  83.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  84.             "createdAt": "2021-12-19T15:07:35Z",
  85.             "modifiedAt": "2021-12-19T15:11:14Z",
  86.             "language": "en",
  87.             "metadata": null,
  88.             "status": "active"
  89.         }
  90.     ]
  91. }