Retrieve a person v2
GET / v2 / core / accounts /:account_id / persons /:id
Retrieves a Person associated with an Account.
Learn more about calling API v2 endpoints.
Parameters
No parameters.
Returns
Returns a Person object.
Error Codes
400 account _ not _ yet _ compatible _ with _ v2
Account is not yet compatible with V2 APIs.
400 accounts _ v2 _ access _ blocked
Accounts v2 is not enabled for your merchant.
400 non _ connect _ platform _ accounts _ v2 _ access _ blocked
Needs to use the newer API version or onboard to Connect.
400 v1 _ account _ instead _ of _ v2 _ account
V1 Account ID cannot be used in V2 Account APIs.
400 v1 _ customer _ instead _ of _ v2 _ account
V1 Customer ID cannot be used in V2 Account APIs.
404 not _ found
The resource wasn’t found.
429 account _ rate _ limit _ exceeded
Account cannot exceed a configured concurrency rate limit on updates.
Response
{ "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"}
List persons v2
GET / v2 / core / accounts /:account_id / persons
Returns a paginated list of Persons associated with an Account.
Learn more about calling API v2 endpoints.
Parameters
- limit integer The upper limit on the number of accounts returned by the List Account request.
- page string The page token to navigate to next or previous batch of accounts given by the list request.
Returns
Response attributes
- data array of objects A list of retrieved Person objects.
- next _ page _ url nullable string URL to fetch the next page of the list. If there are no more pages, the value is null.
- previous _ page _ url nullable string URL to fetch the previous page of the list. If there are no previous pages, the value is null.
Error Codes
400 account _ not _ yet _ compatible _ with _ v2
Account is not yet compatible with V2 APIs.
400 accounts _ v2 _ access _ blocked
Accounts v2 is not enabled for your merchant.
400 non _ connect _ platform _ accounts _ v2 _ access _ blocked
Needs to use the newer API version or onboard to Connect.
400 v1 _ account _ instead _ of _ v2 _ account
V1 Account ID cannot be used in V2 Account APIs.
400 v1 _ customer _ instead _ of _ v2 _ account
V1 Customer ID cannot be used in V2 Account APIs.
429 account _ rate _ limit _ exceeded
Account cannot exceed a configured concurrency rate limit on updates.
Response
{ "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 v2
DELETE / v2 / core / accounts /:account_id / persons /:id
Delete a Person associated with an Account.
Learn more about calling API v2 endpoints.
Parameters
No parameters.
Returns
Response attributes
- id string The ID of the object that’s being deleted.
- object nullable string String representing the type of the object that has been deleted. Objects of the same type share the same value of the object field.
Error Codes
400 account _ not _ yet _ compatible _ with _ v2
Account is not yet compatible with V2 APIs.
400 accounts _ v2 _ access _ blocked
Accounts v2 is not enabled for your merchant.
400 non _ connect _ platform _ accounts _ v2 _ access _ blocked
Needs to use the newer API version or onboard to Connect.
400 v1 _ account _ instead _ of _ v2 _ account
V1 Account ID cannot be used in V2 Account APIs.
400 v1 _ customer _ instead _ of _ v2 _ account
V1 Customer ID cannot be used in V2 Account APIs.
404 not _ found
The resource wasn’t found.
429 account _ rate _ limit _ exceeded
Account cannot exceed a configured concurrency rate limit on updates.
Response
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "deleted": true}