List all owners
curl --request GET \
--url https://api.yorlet.com/v1/owners \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "owner",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"company": {
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"tax_id": "<string>",
"vat_id": "<string>"
},
"country": "<string>",
"email": "<string>",
"external_account": {
"id": "<string>",
"created": 123,
"object": "external_account",
"available_payout_methods": [
"<string>"
],
"confirmation_of_payee": {},
"type": "bank_account",
"account": "<string>",
"deleted": false,
"bank_account": {
"account_holder_name": "<string>",
"bank_name": "<string>",
"country": "<string>",
"last4": "<string>",
"routing_number": "<string>",
"swift_bic": "<string>"
},
"metadata": {}
},
"individual": {
"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": {}
},
"name": "<string>",
"requirements": {
"currently_due": [
"<string>"
],
"disabled_reason": "<string>",
"eventually_due": [
"<string>"
]
},
"settings": {
"account_collections": {
"platform_fee": 0
},
"maintenance": {
"issue_categories": [
"<string>"
],
"issue_preferred_categories": [
"<string>"
]
},
"payout_receipts": {
"email_to": "<string>",
"statement_descriptor": "<string>",
"email_cc": [],
"send_emails": true
},
"payout_schedule": {
"monthly_anchor": 31,
"weekly_anchor": 5
},
"payouts": {
"automatic_approval": false,
"instant_payouts": false,
"negative_payouts": false
}
},
"tax_residency": "<string>",
"account": "<string>",
"deleted": false,
"balance": 0,
"metadata": {},
"payouts_enabled": false
}
]
}Owners
List all owners
GET
/
v1
/
owners
List all owners
curl --request GET \
--url https://api.yorlet.com/v1/owners \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "owner",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"company": {
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"tax_id": "<string>",
"vat_id": "<string>"
},
"country": "<string>",
"email": "<string>",
"external_account": {
"id": "<string>",
"created": 123,
"object": "external_account",
"available_payout_methods": [
"<string>"
],
"confirmation_of_payee": {},
"type": "bank_account",
"account": "<string>",
"deleted": false,
"bank_account": {
"account_holder_name": "<string>",
"bank_name": "<string>",
"country": "<string>",
"last4": "<string>",
"routing_number": "<string>",
"swift_bic": "<string>"
},
"metadata": {}
},
"individual": {
"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": {}
},
"name": "<string>",
"requirements": {
"currently_due": [
"<string>"
],
"disabled_reason": "<string>",
"eventually_due": [
"<string>"
]
},
"settings": {
"account_collections": {
"platform_fee": 0
},
"maintenance": {
"issue_categories": [
"<string>"
],
"issue_preferred_categories": [
"<string>"
]
},
"payout_receipts": {
"email_to": "<string>",
"statement_descriptor": "<string>",
"email_cc": [],
"send_emails": true
},
"payout_schedule": {
"monthly_anchor": 31,
"weekly_anchor": 5
},
"payouts": {
"automatic_approval": false,
"instant_payouts": false,
"negative_payouts": false
}
},
"tax_residency": "<string>",
"account": "<string>",
"deleted": false,
"balance": 0,
"metadata": {},
"payouts_enabled": false
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of owners.
Was this page helpful?
⌘I