List persons v2
Returns a paginated list of Persons associated with an Account.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired Account the Persons are associated with.
- limitinteger
The upper limit on the number of accounts returned by the List Account request.
- pagestring
The page token to navigate to next or previous batch of accounts given by the list request.
Returns
Response attributes
- dataarray of objects
A list of retrieved Person objects.
- next_
page_ urlnullable string URL with page token to navigate to next batch of Persons given by the list request.
- previous_
page_ urlnullable string URL with page token to previous to next batch of Persons given by the list request.
Account is not yet compatible with V2 APIs.
Accounts v2 is not enabled for your platform.
V1 Account ID cannot be used in V2 Account APIs.
V1 Customer ID cannot be used in V2 Account APIs.
Account cannot exceed a configured concurrency rate limit on updates.
{ "data": [ { "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "account": "acct_1Nv0FGQ9RKHgCVdK", "additional_addresses": [], "additional_names": [], "address": { "city": "Brothers", "country": "us", "line1": "27 Fredrick Ave", "postal_code": "97712", "state": "OR" }, "created": "2024-11-26T17:10:07.000Z", "date_of_birth": { "day": 28, "month": 1, "year": 2000 }, "email": "jenny.rosen@example.com", "given_name": "Jenny", "id_numbers": [ { "type": "us_ssn_last_4" } ], "livemode": true, "metadata": {}, "nationalities": [], "relationship": { "owner": true, "percent_ownership": "0.8", "representative": true, "title": "CEO" }, "surname": "Rosen", "updated": "2024-11-26T17:12:55.000Z" } ]}Delete a Person associated with an Account.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired The Account the Person is associated with.
- idstringRequired
The ID of the Person to delete.
Returns
Response attributes
- idstring
Person deleted.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- deletedboolean
Always true for a deleted object.
Account is not yet compatible with V2 APIs.
Accounts v2 is not enabled for your platform.
V1 Account ID cannot be used in V2 Account APIs.
V1 Customer ID cannot be used in V2 Account APIs.
The resource wasn’t found.
Account cannot exceed a configured concurrency rate limit on updates.
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "deleted": true}This is a list of all public thin events we currently send for updates to Person, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.