Update a Person

Updates the person information by passing the person id.
Person
Update a Person
 last updated: 
July 26, 2022

Please note: when KYC status = approved, you can no longer update these fields:
- firstName
- lastName
- dateOfBirth
- idNumber
- address

ENDPOINT

  1. PATCH /v1/person/:id

REQUEST

  1. {
  2.    "email": "johndoe@gmail.com"
  3. }

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": "johndoe@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:56:16Z",
  40.     "language": "en",
  41.     "metadata": null,
  42.     "status": "active"
  43. }