Skip to main content
GET
/
v1
/
owners
/
{id}
/
persons
List all persons
curl --request GET \
  --url https://api.yorlet.com/v1/owners/{id}/persons \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "owner.person",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "dob": {
        "day": 16,
        "month": 6.5,
        "year": 5949.5
      },
      "email": "[email protected]",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "relationship": {
        "director": true,
        "executive": true,
        "owner": true,
        "percent_ownership": 50,
        "representative": true,
        "title": "<string>"
      },
      "title": "<string>",
      "verification_session": "<string>",
      "verification": {
        "status": "<string>"
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Response

200 - application/json

A object with a data property that contains an array of persons.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required