Create a Person

Creates a person by passing the required person information
Person
Create a Person
 last updated: 
September 26, 2022

Note: If KYC is not needed, the only fields that are required to create a person are firstName, lastName, phone, and email.

ENDPOINT

  1. POST /v1/person

REQUEST

  1. {
  2.    "firstName": "John",
  3.    "middleName": "",
  4.    "lastName": "Doe",
  5.    "phone": "+19418405843",
  6.    "email": "john.doe@gmail.com",
  7.    "dateOfBirth": "1974-01-25",
  8.    "idNumber": "223902234",
  9.    "idType": "ssn",
  10.    "address": {
  11.        "addressType": "mailing",
  12.        "line1": "123 Main St",
  13.        "line2": "",
  14.        "city": "New York",
  15.        "state": "NY",
  16.        "country": "US",
  17.        "postalCode": "10001"
  18.    }
  19. }

RESPONSE

  1. {
  2.    "id": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  3.    "firstName": "John",
  4.    "middleName": "",
  5.    "lastName": "Doe",
  6.    "phone": "+19418405843",
  7.    "phoneVerified": true,
  8.    "email": "john.doe@gmail.com",
  9.    "emailVerified": false,
  10.    "dateOfBirth": "1974-01-25",
  11.    "idType": "ssn",
  12.    "idNumber": "223902234",
  13.    "address": {
  14.        "addressType": "mailing",
  15.        "line1": "123 Main St",
  16.        "line2": "",
  17.        "city": "New York",
  18.        "state": "NY",
  19.        "country": "US",
  20.        "postalCode": "10001"
  21.    },
  22.    "kyc": {
  23.        "id": "kyc-d40f6bdd-6e12-446e-a3a8-7bd3b2dbb182",
  24.        "personId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  25.        "status": "notStarted",
  26.        "reviewCode": "",
  27.        "reviewMessage": "",
  28.        "results": {
  29.            "idv": "notStarted",
  30.            "address": "notStarted",
  31.            "dateOfBirth": "notStarted",
  32.            "fraud": "notStarted"
  33.        },
  34.        "createdAt": "2021-12-14T21:25:19Z",
  35.        "modifiedAt": "2021-12-14T21:25:19Z"
  36.    },
  37.    "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  38.    "createdAt": "2021-12-14T21:25:19Z",
  39.    "modifiedAt": "2021-12-14T21:25:19Z",
  40.    "language": "en",
  41.    "metadata": null,
  42.    "status": "active"
  43. }