PATCH
/
v1
/
person
/
{personId}
curl --request PATCH \
  --url https://qa-api.sbx.solidfi.com/v1/person/{personId} \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "johndoe@solidfi.com"
}'
{
  "address": {
    "addressType": "mailing",
    "city": "Los Gatos",
    "country": "US",
    "line1": "1 Broadway",
    "line2": "",
    "postalCode": "95030",
    "state": "CA"
  },
  "createdAt": "2023-11-20T05:32:11Z",
  "dateOfBirth": "1974-01-25",
  "email": "johndoe@solidfi.com",
  "emailVerified": false,
  "firstName": "John",
  "id": "per-e6553324-1db8-49a8-a0d3-29132280b838",
  "idNumber": "999999999",
  "idType": "ssn",
  "kyc": {
    "createdAt": "2023-11-20T05:31:48Z",
    "id": "kyc-69760d03-7957-46d5-b34f-ff820fd66520",
    "modifiedAt": "2023-11-20T05:31:48Z",
    "personId": "per-e6553324-1db8-49a8-a0d3-29132280b838",
    "results": {
      "address": "notStarted",
      "bank": "notStarted",
      "dateOfBirth": "notStarted",
      "fraud": "notStarted",
      "idv": "notStarted"
    },
    "reviewCode": "",
    "reviewMessage": "",
    "reviewReasons": {
      "address": [],
      "bank": [],
      "dateOfBirth": [],
      "fraud": [],
      "idv": [],
      "other": []
    },
    "status": "notStarted"
  },
  "language": "en",
  "lastName": "Doe",
  "metadata": null,
  "middleName": "",
  "modifiedAt": "2023-11-20T05:57:56Z",
  "phone": "+15555555555",
  "phoneVerified": true,
  "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
  "status": "active"
}

Headers

​
sd-api-key
string
Example:

"{{sd-api-key}}"

​
sd-person-id
string
Example:

"{{sd-person-id}}"

Path Parameters

​
personId
string
required

Body

application/json
​
email
string
Example:

"johndoe@solidfi.com"

Response

200 - application/json
Update a Person
​
address
object
​
createdAt
string
Example:

"2023-11-20T05:32:11Z"

​
dateOfBirth
string
Example:

"1974-01-25"

​
email
string
Example:

"johndoe@solidfi.com"

​
emailVerified
boolean
Example:

false

​
firstName
string
Example:

"John"

​
id
string
Example:

"per-e6553324-1db8-49a8-a0d3-29132280b838"

​
idNumber
string
Example:

"999999999"

​
idType
string
Example:

"ssn"

​
kyc
object
​
language
string
Example:

"en"

​
lastName
string
Example:

"Doe"

​
metadata
any | null
​
middleName
string
Example:

""

​
modifiedAt
string
Example:

"2023-11-20T05:57:56Z"

​
phone
string
Example:

"+15555555555"

​
phoneVerified
boolean
Example:

true

​
programId
string
Example:

"prg-ffa511da-1adc-4603-b845-173b895a33f6"

​
status
string
Example:

"active"

Retrieve a PersonRetrieve a KYC