Update personal information

Update a person’s personal information including identity documents, date of birth, gender, nationality, and address

PUT /v1/persons/{personId}/personalInfo

Update personal information

cURL

curl --request PUT \
  --url https://api.cadanapay.com/v1/persons/{personId}/personalInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateOfBirth": "1990-05-15",
  "nationalId": {
    "fullId": "T22084535",
    "suffix": "01",
    "type": "tin"
  },
  "taxId": {
    "fullId": "T22084535",
    "suffix": "01",
    "type": "tin"
  },
  "socialSecurityId": {
    "fullId": "T22084535",
    "suffix": "01",
    "type": "tin"
  },
  "gender": "female",
  "nationality": "DE"
}
'

400

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey · string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

personId · string<uuid> · required

The unique identifier for the person

Body

application/json

Update person personal info request payload

dateOfBirth · string<date>

Person's date of birth

Example:

"1990-05-15"

nationalId · object

National identification document

Show child attributes

taxId · object

National identification document

Show child attributes

socialSecurityId · object

National identification document

Show child attributes

gender · enum<string>

Person's gender

Available options: male, female, other

Example:

"female"

nationality · string

ISO 3166-1 alpha-2 country code

Example:

"DE"

address · object

Address

Show child attributes

Response

204

Successful operation