Create a Family Member

Creates a family member by passing the required member information.
Family
Create a Family Member
 last updated: 
July 18, 2022

ENDPOINT

  1. POST /v1/member

Once a person created, you just need to pass the personId in lieu of the person object.

REQUEST

  1. {
  2.   "familyId": "{{familyId}}",
  3.   "personId": "per-eda50166-0697-4e27-abf5-9fc1f2be2e95"
  4. }

RESPONSE

  1. {
  2.     "id": "mem-7ab2679c-3ab1-466b-a111-ef441bd9f460",
  3.     "familyId": "fam-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  4.     "isControlPerson": false,
  5.     "person": {
  6.         "id": "per-eda50166-0697-4e27-abf5-9fc1f2be2e95",
  7.         "firstName": "Jane",
  8.         "middleName": "",
  9.         "lastName": "Doe",
  10.         "phone": "+19418405939",
  11.         "phoneVerified": false,
  12.         "email": "jane.doe@gmail.com",
  13.         "emailVerified": false,
  14.         "dateOfBirth": "1974-04-22",
  15.         "idType": "ssn",
  16.         "idNumber": "287654321",
  17.         "address": {
  18.             "addressType": "mailing",
  19.             "line1": "789 Main St",
  20.             "line2": "",
  21.             "city": "New York",
  22.             "state": "NY",
  23.             "country": "US",
  24.             "postalCode": "10001"
  25.         },
  26.         "kyc": {
  27.             "id": "kyc-dceff412-342b-46ef-994f-662a3b45a7eb",
  28.             "personId": "per-eda50166-0697-4e27-abf5-9fc1f2be2e95",
  29.             "status": "notStarted",
  30.             "reviewCode": "",
  31.             "reviewMessage": "",
  32.             "results": {
  33.                 "idv": "notStarted",
  34.                 "address": "notStarted",
  35.                 "dateOfBirth": "notStarted",
  36.                 "fraud": "notStarted"
  37.             },
  38.             "createdAt": "2021-12-15T17:58:12Z",
  39.             "modifiedAt": "2021-12-15T17:58:12Z"
  40.         },
  41.         "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  42.         "createdAt": "2021-12-15T17:58:11Z",
  43.         "modifiedAt": "2021-12-15T17:58:11Z",
  44.         "language": "",
  45.         "metadata": null,
  46.         "status": "active"
  47.     },
  48.     "createdAt": "2021-12-15T17:58:11Z",
  49.     "modifiedAt": "2021-12-15T17:58:11Z"
  50. }