Create a Member

Creates an member by passing the required member information.
Member
Create a Member
 last updated: 
November 30, 2023

ENDPOINT

  1. POST /v1/member

REQUEST

  1. {
  2.     "businessId": "{{businessId}}",
  3.     "person": {
  4.         "firstName": "Jane",
  5.         "middleName": "",
  6.         "lastName": "Doe",
  7.         "phone": "+19418405939",
  8.         "email": "jane.doe@gmail.com",
  9.         "dateOfBirth": "1974-04-22",
  10.         "idType": "ssn",
  11.         "idNumber": "287654321",
  12.         "address": {
  13.             "addressType": "mailing",
  14.             "line1": "789 Main St",
  15.             "line2": "",
  16.             "city": "New York",
  17.             "state": "NY",
  18.             "country": "US",
  19.             "postalCode": "10001"
  20.         }
  21.     },
  22.     "ownership": "50.1",
  23.     "title": "manager"
  24. }

Note: If you already have a person created, you can also pass the personId in lieu of the person object. Example below:

  1. {
  2.   "businessId": "{{businessId}}",
  3.   "personId": "per-eda50166-0697-4e27-abf5-9fc1f2be2e95",
  4.   "ownership": "50.1",
  5.   "title": "manager"
  6. }

RESPONSE

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