The owner object
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
owner The owner's address.
Show child attributes
Show child attributes
The identifier of the user the owner is assigned to.
The legal type of the owner.
individual, company A secret token used to authenticate owner-scoped requests, such as generating PDF statements.
Information about the company. Only present when business_type is company.
Show child attributes
Show child attributes
Two-letter ISO code representing the country of the owner.
The owner's contact email address.
The external account to which payouts are sent.
Show child attributes
Show child attributes
Information about the individual. Only present when business_type is individual.
Show child attributes
Show child attributes
Display name of the owner.
Outstanding requirements for the owner.
Show child attributes
Show child attributes
Configurable settings for the owner.
Show child attributes
Show child attributes
Where the owner stands with portal access. Only suppliers can be invited today.
Show child attributes
Show child attributes
The current status of the owner.
complete, incomplete, disabled, archived Two-letter ISO code representing the owner's tax residency country.
The type of the owner.
landlord, leaseholder, platform, supplier The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The owner's current balance, in the smallest currency unit.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Whether the owner is currently able to receive payouts.
Was this page helpful?
{
"id": "<string>",
"created": 123,
"object": "owner",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"assignee": "<string>",
"client_secret": "<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,
"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,
"year": 5949
},
"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_email": true
},
"payout_schedule": {
"monthly_anchor": 31,
"weekly_anchor": 5
},
"payouts": {
"automatic_approval": false,
"instant_payouts": false,
"negative_payouts": false
}
},
"portal": {
"invite_sent_at": 123,
"linked_at": 123
},
"tax_residency": "<string>",
"account": "<string>",
"deleted": false,
"balance": 0,
"metadata": {},
"payouts_enabled": false
}