Update a person

PATCH

/persons/:person_id

Path parameters

person_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

addressobjectOptional

The person's address

date_of_birthstringOptional

The person's date of birth

emailstringOptional

The person's email address

first_namestringOptional

The person's first name

id_numberstringOptional

The person's ID number, as appropriate for their country

last_namestringOptional

The person's last name

phonestringOptional

The person's phone number

relationshipobjectOptional

Describes the person's relationship to the entity

ssn_last_4stringOptional

The last four digits of the person's Social Security number

Response

This endpoint returns an object.

idstring

The person's unique identifier

created_atdatetime

Time at which the person was created

updated_atdatetime

Time at which the person was updated

emailstring

The person's email address

entity_idstring

Entity ID

first_namestring

The person's first name

last_namestring

The person's last name

relationshipobject

Describes the person's relationship to the entity

addressobjectOptional

The person's address

date_of_birthstringOptional

The person's date of birth

id_numberstringOptional

The person's ID number, as appropriate for their country

phonestringOptional

The person's phone number

ssn_last_4stringOptional

The last four digits of the person's Social Security number

Errors

PATCH

1 curl -X PATCH https://api.sandbox.monite.com/v1/persons/person_id \
2      -H "x-monite-version: 2023-09-01" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{}'

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "email": "email",
6   "entity_id": "entity_id",
7   "first_name": "first_name",
8   "last_name": "last_name",
9   "relationship": {
10     "director": true,
11     "executive": true,
12     "owner": true,
13     "percent_ownership": 1.1,
14     "representative": true,
15     "title": "title"
16   },
17   "address": {
18     "city": "city",
19     "country": "country",
20     "line1": "line1",
21     "postal_code": "postal_code",
22     "line2": "line2",
23     "state": "state"
24   },
25   "date_of_birth": "date_of_birth",
26   "id_number": "id_number",
27   "phone": "phone",
28   "ssn_last_4": "ssn_last_4"
29 }