Partial update a person by id

Update individual fields on person object.


This endpoint allows you to make partial updates to a person's information - you only have to pass the field(s) you wish to update. This means that end-users will not have to re-enter all fields if they want to update their information.

Required fields:

  • If you update address or contact information, the type is required.

Removing fields

To remove a field from the resource, pass the field with an empty string as the value. Only the following fields can be removed from the person resource:

  • middle_name
  • address2

Updating metadata

  • If you do not pass the metadata field, the metadata will not be updated in any way
  • To update an existing metadata key’s value, pass the existing key with the new value along with any existing key-value pair(s)
  • To remove metadata, pass any key-values pair you want to maintain, and omit the ones you want to delete. To remove all metadata, pass the metadata key with an empty object
  • To add new key-value pair(s), pass any existing metadata key-value pair(s) with the new key(s) and new value(s)

Impact on KYC status

Changing the below fields will re-trigger the KYC process. You will receive a person_unverified webhook and the person's status will be set to "created" until re-verification is complete.

  • first_name
  • last_name
  • date_of_birth
  • social_security_number
  • address1
  • city
  • state
  • country
  • zip5
Click Try It! to start a request and see the response here!