Manage an individual
Read and update a shared person record; the change applies everywhere the individual is linked.
A person's details change over time, such as a new phone number or a renewed driver's license. Read a person back to confirm their details, and update them in place so Priority checks the right information. An individual is shared, so a change applies everywhere they're linked. For the full field list, see Create an individual.
Common use cases
- Read a person's details.
- Update a person's contact or identity details in one place.
- Reuse a person across another business by their
id.
Scenarios
An individual is standalone and shared. Read and update happen on the person's own resource.
A person can be linked to more than one business. When you update the person, the change applies to every business they own or sign for.
Before you begin (all scenarios)
- You have a sandbox API key. See Getting started.
- You have the
individualId(or theexternalIdyou set on create).
Scenario 1: Read an individual
Read a person by their id. Make a GET request to /v1/individuals/{individualId} (or resolve by your own reference with ?externalId=).
curl https://sandbox-api.prioritycommerce.com/v1/individuals/ind_2c9e51 \
-H "x-api-key: <your-key>"PCE returns the person with the tax ID and government IDs masked. An individual carries no status field of its own; identity is verified as part of the business's underwriting.
Scenario 2: Update an individual
Update a person's details in place, sending only the fields you're changing. Make a PATCH request to /v1/individuals/{individualId}.
curl -X PATCH https://sandbox-api.prioritycommerce.com/v1/individuals/ind_2c9e51 \
-H "x-api-key: <your-key>" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"phone": "+15555550199"
}'Response: 200 OK with the full updated record. Because an individual is shared, the update applies to every business the person is linked to as an owner or signatory.
Manage individuals
| Action | Call |
|---|---|
| List | GET /v1/individuals |
| Read one | GET /v1/individuals/{individualId} |
| Update | PATCH /v1/individuals/{individualId} |
Filter the list by externalId to find a person using your own reference. Changing a person's identity details does not trigger a re-verification flow.
Next steps
See also
- Businesses: how individuals relate to owners and signatories
- Create a business: create and link people inline in the composite create
Updated 9 days ago