Skip to main content
PATCH
Update Person

Headers

source
string | null
X-API-SIGNATURE
string
required

Signature header

X-API-TIMESTAMP
integer
required

Timestamp header

X-API-NONCE
string
required

Nonce header

X-API-SUBSCRIPTION-KEY
string
required

Account ID header

Path Parameters

person_id
string<uuid>
required

Body

application/json

Sparse person update schema for PATCH person endpoint.

first_name
string | null
Minimum string length: 1
middle_name
string | null
Required string length: 1 - 60
last_name
string | null
Minimum string length: 1
date_of_birth
string<date> | null
home_address
UpdatePersonAddressRequest · object | null

Sparse address update schema for PATCH person endpoint.

tin
string | null
Minimum string length: 1
email
string<email> | null
Minimum string length: 1
phone
string | null
Minimum string length: 1
employer_name
string | null
Minimum string length: 1
employment_status
enum<string> | null

Enum for employment status.

Available options:
employed,
retired,
unemployed
occupation
string | null
Minimum string length: 1
ownership_percentage
integer | null
Required range: 0 <= x <= 100
work_title
string | null
Minimum string length: 1
controller
boolean | null

Response

Successful Response

Generic API response.

message
string
required
data
unknown