List all persons 

Connect
Person
List all 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

  • relationshipobject

    Filters on the list of people returned based on the person’s relationship to the account’s company.

    • relationship.authorizerboolean

      A filter on the list of people returned based on whether these people are authorizers of the account’s representative.

    • relationship.directorboolean

      A filter on the list of people returned based on whether these people are directors of the account’s company.

    • relationship.executiveboolean

      A filter on the list of people returned based on whether these people are executives of the account’s company.

    • relationship.legal_guardianboolean

      A filter on the list of people returned based on whether these people are legal guardians of the account’s representative.

    • relationship.ownerboolean

      A filter on the list of people returned based on whether these people are owners of the account’s company.

    • relationship.representativeboolean

      A filter on the list of people returned based on whether these people are the representative of the account’s company.

More parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

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.

GET /v1/accounts/:id/persons
curl -G https://api.stripe.com/v1/accounts/acct_1032D82eZvKYlo2C/persons \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d limit=3
Response
{
"object": "list",
"url": "/v1/accounts/acct_1032D82eZvKYlo2C/persons",
"has_more": false,
"data": [
{
"id": "person_1MqjB62eZvKYlo2CaeEJzKVR",
"person": "person_1MqjB62eZvKYlo2CaeEJzKVR",
"object": "person",
"account": "acct_1032D82eZvKYlo2C",
"created": 1680035496,
"dob": {
"day": null,
"month": null,
"year": null
},
"first_name": "Jane",
"future_requirements": {
"alternatives": [],
"currently_due": [],
"errors": [],
"eventually_due": [],
"past_due": [],
"pending_verification": []
},
"id_number_provided": false,
"last_name": "Diaz",
"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"
}
}
]
}