Retrieve a person
GET / v1 / accounts /:id / persons /:id
Retrieves an existing person.
Parameters
No parameters.
Returns
Returns a person object.
Response
{ "id": "person_1N9XNb2eZvKYlo2CjPX7xF6F", "object": "person", "account": "acct_1032D82eZvKYlo2C", "created": 1684518375, "dob": { "day": null, "month": null, "year": null }, "first_name": null, "future_requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id_number_provided": false, "last_name": null, "metadata": {}, "relationship": { "director": false, "executive": false, "owner": false, "percent_ownership": null, "representative": false, "title": null }, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "ssn_last_4_provided": false, "verification": { "additional_document": { "back": null, "details": null, "details_code": null, "front": null }, "details": null, "details_code": null, "document": { "back": null, "details": null, "details_code": null, "front": null }, "status": "unverified" }}
List all persons
GET / v1 / accounts /:id / persons
Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
Parameters
- relationship object Filters on the list of people returned based on the person’s relationship to the account’s company.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit people, starting after person starting_after. Each entry in the array is a separate person object. If no more people are available, the resulting array will be empty.
Response
Delete a person
DELETE / v1 / accounts /:id / persons /:id
Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the representative. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
Parameters
No parameters.
Returns
Returns the deleted person object.
Response
{ "id": "person_1MqjB62eZvKYlo2CaeEJzKVR", "object": "person", "deleted": true}