Update an individual

patch

https://sandbox-api.prioritycommerce.com/v1/individuals/{id}

Updates the details of an individual. Send only the fields you want to change. The change applies to every business the person is linked to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the individual, for example ind_2b7e4f13-6c9a-4d51-8a3e-9d0f2c6b8e74.

Body Params

Individual fields to update. Send only the fields you want to change.

externalId

string

length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

firstName

string

The person's legal first name.

middleName

string

The person's middle name.

lastName

string

The person's legal last name.

dateOfBirth

date

Date of birth in YYYY-MM-DD format. The person must be at least 18 years old. Needed before the person can be approved as an owner or signatory.

nationality

string

^[A-Z]{2}$

Country of citizenship, as a two-letter ISO 3166-1 code, for example US. Needed before the person can be approved as an owner or signatory.

string

Main contact email address.

phone

string

^\+[1-9]\d{1,14}$

Main contact phone number in international E.164 format: a +, the country code, then the number, with no spaces. Example: +15125550142.

taxId

object

The person's tax ID, masked.

governmentIds

array of objects

The person's government-issued IDs, masked.

governmentIds

addresses

array of objects

Addresses of the business. Include the registered address. Needed to activate card processing (payin.card).

addresses

Responses

200Updated. The response contains the updated record.

401The API key is missing or invalid.

404No record exists with the ID in the path.

422The request failed validation. errors lists each field to fix.