Create an owner

Create an owner

curl --request POST \
  --url https://api.yorlet.com/v1/owners \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "assignee": "<string>",
  "bank_account": {},
  "business_type": "individual",
  "company": {
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "tax_id": "<string>",
    "vat_id": "<string>"
  },
  "email": "[email protected]",
  "individual": {
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "metadata": {},
    "phone": "<string>",
    "relationship": {
      "director": true,
      "executive": true,
      "owner": true,
      "percent_ownership": 50,
      "representative": true,
      "title": "<string>"
    },
    "title": "<string>"
  },
  "labels": [
    "<string>"
  ],
  "metadata": {},
  "next_statement_sequence": 2,
  "non_resident_tax_details": {
    "certificate": "<string>",
    "certificate_date": 123,
    "country": "<string>"
  },
  "phone": "<string>",
  "settings": {
    "account_collections": {
      "platform_fee": 123
    },
    "maintenance": {
      "issue_categories": [
        "<string>"
      ],
      "issue_preferred_categories": [
        "<string>"
      ]
    },
    "payout_receipts": {
      "email_cc": [
        "<string>"
      ],
      "email_to": "<string>",
      "statement_descriptor": "<string>",
      "send_email": true
    },
    "payout_schedule": {
      "monthly_anchor": 123,
      "weekly_anchor": 123
    },
    "payouts": {
      "automatic_approval": true,
      "instant_payouts": true,
      "negative_payouts": true
    }
  },
  "statement_prefix": "<string>",
  "tax_residency": "<string>",
  "trading_as_name": "<string>",
  "type": "landlord",
  "workspace": "<string>"
}
'

import requests

url = "https://api.yorlet.com/v1/owners"

payload = {
    "archived": True,
    "assignee": "<string>",
    "bank_account": {},
    "business_type": "individual",
    "company": {
        "email": "<string>",
        "name": "<string>",
        "phone": "<string>",
        "tax_id": "<string>",
        "vat_id": "<string>"
    },
    "email": "[email protected]",
    "individual": {
        "email": "[email protected]",
        "first_name": "<string>",
        "last_name": "<string>",
        "metadata": {},
        "phone": "<string>",
        "relationship": {
            "director": True,
            "executive": True,
            "owner": True,
            "percent_ownership": 50,
            "representative": True,
            "title": "<string>"
        },
        "title": "<string>"
    },
    "labels": ["<string>"],
    "metadata": {},
    "next_statement_sequence": 2,
    "non_resident_tax_details": {
        "certificate": "<string>",
        "certificate_date": 123,
        "country": "<string>"
    },
    "phone": "<string>",
    "settings": {
        "account_collections": { "platform_fee": 123 },
        "maintenance": {
            "issue_categories": ["<string>"],
            "issue_preferred_categories": ["<string>"]
        },
        "payout_receipts": {
            "email_cc": ["<string>"],
            "email_to": "<string>",
            "statement_descriptor": "<string>",
            "send_email": True
        },
        "payout_schedule": {
            "monthly_anchor": 123,
            "weekly_anchor": 123
        },
        "payouts": {
            "automatic_approval": True,
            "instant_payouts": True,
            "negative_payouts": True
        }
    },
    "statement_prefix": "<string>",
    "tax_residency": "<string>",
    "trading_as_name": "<string>",
    "type": "landlord",
    "workspace": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    archived: true,
    assignee: '<string>',
    bank_account: {},
    business_type: 'individual',
    company: {
      email: '<string>',
      name: '<string>',
      phone: '<string>',
      tax_id: '<string>',
      vat_id: '<string>'
    },
    email: '[email protected]',
    individual: {
      email: '[email protected]',
      first_name: '<string>',
      last_name: '<string>',
      metadata: {},
      phone: '<string>',
      relationship: {
        director: true,
        executive: true,
        owner: true,
        percent_ownership: 50,
        representative: true,
        title: '<string>'
      },
      title: '<string>'
    },
    labels: ['<string>'],
    metadata: {},
    next_statement_sequence: 2,
    non_resident_tax_details: {certificate: '<string>', certificate_date: 123, country: '<string>'},
    phone: '<string>',
    settings: {
      account_collections: {platform_fee: 123},
      maintenance: {issue_categories: ['<string>'], issue_preferred_categories: ['<string>']},
      payout_receipts: {
        email_cc: ['<string>'],
        email_to: '<string>',
        statement_descriptor: '<string>',
        send_email: true
      },
      payout_schedule: {monthly_anchor: 123, weekly_anchor: 123},
      payouts: {automatic_approval: true, instant_payouts: true, negative_payouts: true}
    },
    statement_prefix: '<string>',
    tax_residency: '<string>',
    trading_as_name: '<string>',
    type: 'landlord',
    workspace: '<string>'
  })
};

fetch('https://api.yorlet.com/v1/owners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yorlet.com/v1/owners",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'archived' => true,
    'assignee' => '<string>',
    'bank_account' => [
        
    ],
    'business_type' => 'individual',
    'company' => [
        'email' => '<string>',
        'name' => '<string>',
        'phone' => '<string>',
        'tax_id' => '<string>',
        'vat_id' => '<string>'
    ],
    'email' => '[email protected]',
    'individual' => [
        'email' => '[email protected]',
        'first_name' => '<string>',
        'last_name' => '<string>',
        'metadata' => [
                
        ],
        'phone' => '<string>',
        'relationship' => [
                'director' => true,
                'executive' => true,
                'owner' => true,
                'percent_ownership' => 50,
                'representative' => true,
                'title' => '<string>'
        ],
        'title' => '<string>'
    ],
    'labels' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'next_statement_sequence' => 2,
    'non_resident_tax_details' => [
        'certificate' => '<string>',
        'certificate_date' => 123,
        'country' => '<string>'
    ],
    'phone' => '<string>',
    'settings' => [
        'account_collections' => [
                'platform_fee' => 123
        ],
        'maintenance' => [
                'issue_categories' => [
                                '<string>'
                ],
                'issue_preferred_categories' => [
                                '<string>'
                ]
        ],
        'payout_receipts' => [
                'email_cc' => [
                                '<string>'
                ],
                'email_to' => '<string>',
                'statement_descriptor' => '<string>',
                'send_email' => true
        ],
        'payout_schedule' => [
                'monthly_anchor' => 123,
                'weekly_anchor' => 123
        ],
        'payouts' => [
                'automatic_approval' => true,
                'instant_payouts' => true,
                'negative_payouts' => true
        ]
    ],
    'statement_prefix' => '<string>',
    'tax_residency' => '<string>',
    'trading_as_name' => '<string>',
    'type' => 'landlord',
    'workspace' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yorlet.com/v1/owners"

	payload := strings.NewReader("{\n  \"archived\": true,\n  \"assignee\": \"<string>\",\n  \"bank_account\": {},\n  \"business_type\": \"individual\",\n  \"company\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"vat_id\": \"<string>\"\n  },\n  \"email\": \"[email protected]\",\n  \"individual\": {\n    \"email\": \"[email protected]\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"metadata\": {},\n    \"phone\": \"<string>\",\n    \"relationship\": {\n      \"director\": true,\n      \"executive\": true,\n      \"owner\": true,\n      \"percent_ownership\": 50,\n      \"representative\": true,\n      \"title\": \"<string>\"\n    },\n    \"title\": \"<string>\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"next_statement_sequence\": 2,\n  \"non_resident_tax_details\": {\n    \"certificate\": \"<string>\",\n    \"certificate_date\": 123,\n    \"country\": \"<string>\"\n  },\n  \"phone\": \"<string>\",\n  \"settings\": {\n    \"account_collections\": {\n      \"platform_fee\": 123\n    },\n    \"maintenance\": {\n      \"issue_categories\": [\n        \"<string>\"\n      ],\n      \"issue_preferred_categories\": [\n        \"<string>\"\n      ]\n    },\n    \"payout_receipts\": {\n      \"email_cc\": [\n        \"<string>\"\n      ],\n      \"email_to\": \"<string>\",\n      \"statement_descriptor\": \"<string>\",\n      \"send_email\": true\n    },\n    \"payout_schedule\": {\n      \"monthly_anchor\": 123,\n      \"weekly_anchor\": 123\n    },\n    \"payouts\": {\n      \"automatic_approval\": true,\n      \"instant_payouts\": true,\n      \"negative_payouts\": true\n    }\n  },\n  \"statement_prefix\": \"<string>\",\n  \"tax_residency\": \"<string>\",\n  \"trading_as_name\": \"<string>\",\n  \"type\": \"landlord\",\n  \"workspace\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/owners")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"archived\": true,\n  \"assignee\": \"<string>\",\n  \"bank_account\": {},\n  \"business_type\": \"individual\",\n  \"company\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"vat_id\": \"<string>\"\n  },\n  \"email\": \"[email protected]\",\n  \"individual\": {\n    \"email\": \"[email protected]\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"metadata\": {},\n    \"phone\": \"<string>\",\n    \"relationship\": {\n      \"director\": true,\n      \"executive\": true,\n      \"owner\": true,\n      \"percent_ownership\": 50,\n      \"representative\": true,\n      \"title\": \"<string>\"\n    },\n    \"title\": \"<string>\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"next_statement_sequence\": 2,\n  \"non_resident_tax_details\": {\n    \"certificate\": \"<string>\",\n    \"certificate_date\": 123,\n    \"country\": \"<string>\"\n  },\n  \"phone\": \"<string>\",\n  \"settings\": {\n    \"account_collections\": {\n      \"platform_fee\": 123\n    },\n    \"maintenance\": {\n      \"issue_categories\": [\n        \"<string>\"\n      ],\n      \"issue_preferred_categories\": [\n        \"<string>\"\n      ]\n    },\n    \"payout_receipts\": {\n      \"email_cc\": [\n        \"<string>\"\n      ],\n      \"email_to\": \"<string>\",\n      \"statement_descriptor\": \"<string>\",\n      \"send_email\": true\n    },\n    \"payout_schedule\": {\n      \"monthly_anchor\": 123,\n      \"weekly_anchor\": 123\n    },\n    \"payouts\": {\n      \"automatic_approval\": true,\n      \"instant_payouts\": true,\n      \"negative_payouts\": true\n    }\n  },\n  \"statement_prefix\": \"<string>\",\n  \"tax_residency\": \"<string>\",\n  \"trading_as_name\": \"<string>\",\n  \"type\": \"landlord\",\n  \"workspace\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/owners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"archived\": true,\n  \"assignee\": \"<string>\",\n  \"bank_account\": {},\n  \"business_type\": \"individual\",\n  \"company\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"vat_id\": \"<string>\"\n  },\n  \"email\": \"[email protected]\",\n  \"individual\": {\n    \"email\": \"[email protected]\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"metadata\": {},\n    \"phone\": \"<string>\",\n    \"relationship\": {\n      \"director\": true,\n      \"executive\": true,\n      \"owner\": true,\n      \"percent_ownership\": 50,\n      \"representative\": true,\n      \"title\": \"<string>\"\n    },\n    \"title\": \"<string>\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"next_statement_sequence\": 2,\n  \"non_resident_tax_details\": {\n    \"certificate\": \"<string>\",\n    \"certificate_date\": 123,\n    \"country\": \"<string>\"\n  },\n  \"phone\": \"<string>\",\n  \"settings\": {\n    \"account_collections\": {\n      \"platform_fee\": 123\n    },\n    \"maintenance\": {\n      \"issue_categories\": [\n        \"<string>\"\n      ],\n      \"issue_preferred_categories\": [\n        \"<string>\"\n      ]\n    },\n    \"payout_receipts\": {\n      \"email_cc\": [\n        \"<string>\"\n      ],\n      \"email_to\": \"<string>\",\n      \"statement_descriptor\": \"<string>\",\n      \"send_email\": true\n    },\n    \"payout_schedule\": {\n      \"monthly_anchor\": 123,\n      \"weekly_anchor\": 123\n    },\n    \"payouts\": {\n      \"automatic_approval\": true,\n      \"instant_payouts\": true,\n      \"negative_payouts\": true\n    }\n  },\n  \"statement_prefix\": \"<string>\",\n  \"tax_residency\": \"<string>\",\n  \"trading_as_name\": \"<string>\",\n  \"type\": \"landlord\",\n  \"workspace\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created": 123,
  "object": "owner",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<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,
    "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,
      "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
    }
  },
  "tax_residency": "<string>",
  "account": "<string>",
  "deleted": false,
  "balance": 0,
  "metadata": {},
  "payouts_enabled": false
}

POST

owners

Create an owner

curl --request POST \
  --url https://api.yorlet.com/v1/owners \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "assignee": "<string>",
  "bank_account": {},
  "business_type": "individual",
  "company": {
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "tax_id": "<string>",
    "vat_id": "<string>"
  },
  "email": "[email protected]",
  "individual": {
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "metadata": {},
    "phone": "<string>",
    "relationship": {
      "director": true,
      "executive": true,
      "owner": true,
      "percent_ownership": 50,
      "representative": true,
      "title": "<string>"
    },
    "title": "<string>"
  },
  "labels": [
    "<string>"
  ],
  "metadata": {},
  "next_statement_sequence": 2,
  "non_resident_tax_details": {
    "certificate": "<string>",
    "certificate_date": 123,
    "country": "<string>"
  },
  "phone": "<string>",
  "settings": {
    "account_collections": {
      "platform_fee": 123
    },
    "maintenance": {
      "issue_categories": [
        "<string>"
      ],
      "issue_preferred_categories": [
        "<string>"
      ]
    },
    "payout_receipts": {
      "email_cc": [
        "<string>"
      ],
      "email_to": "<string>",
      "statement_descriptor": "<string>",
      "send_email": true
    },
    "payout_schedule": {
      "monthly_anchor": 123,
      "weekly_anchor": 123
    },
    "payouts": {
      "automatic_approval": true,
      "instant_payouts": true,
      "negative_payouts": true
    }
  },
  "statement_prefix": "<string>",
  "tax_residency": "<string>",
  "trading_as_name": "<string>",
  "type": "landlord",
  "workspace": "<string>"
}
'

import requests

url = "https://api.yorlet.com/v1/owners"

payload = {
    "archived": True,
    "assignee": "<string>",
    "bank_account": {},
    "business_type": "individual",
    "company": {
        "email": "<string>",
        "name": "<string>",
        "phone": "<string>",
        "tax_id": "<string>",
        "vat_id": "<string>"
    },
    "email": "[email protected]",
    "individual": {
        "email": "[email protected]",
        "first_name": "<string>",
        "last_name": "<string>",
        "metadata": {},
        "phone": "<string>",
        "relationship": {
            "director": True,
            "executive": True,
            "owner": True,
            "percent_ownership": 50,
            "representative": True,
            "title": "<string>"
        },
        "title": "<string>"
    },
    "labels": ["<string>"],
    "metadata": {},
    "next_statement_sequence": 2,
    "non_resident_tax_details": {
        "certificate": "<string>",
        "certificate_date": 123,
        "country": "<string>"
    },
    "phone": "<string>",
    "settings": {
        "account_collections": { "platform_fee": 123 },
        "maintenance": {
            "issue_categories": ["<string>"],
            "issue_preferred_categories": ["<string>"]
        },
        "payout_receipts": {
            "email_cc": ["<string>"],
            "email_to": "<string>",
            "statement_descriptor": "<string>",
            "send_email": True
        },
        "payout_schedule": {
            "monthly_anchor": 123,
            "weekly_anchor": 123
        },
        "payouts": {
            "automatic_approval": True,
            "instant_payouts": True,
            "negative_payouts": True
        }
    },
    "statement_prefix": "<string>",
    "tax_residency": "<string>",
    "trading_as_name": "<string>",
    "type": "landlord",
    "workspace": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    archived: true,
    assignee: '<string>',
    bank_account: {},
    business_type: 'individual',
    company: {
      email: '<string>',
      name: '<string>',
      phone: '<string>',
      tax_id: '<string>',
      vat_id: '<string>'
    },
    email: '[email protected]',
    individual: {
      email: '[email protected]',
      first_name: '<string>',
      last_name: '<string>',
      metadata: {},
      phone: '<string>',
      relationship: {
        director: true,
        executive: true,
        owner: true,
        percent_ownership: 50,
        representative: true,
        title: '<string>'
      },
      title: '<string>'
    },
    labels: ['<string>'],
    metadata: {},
    next_statement_sequence: 2,
    non_resident_tax_details: {certificate: '<string>', certificate_date: 123, country: '<string>'},
    phone: '<string>',
    settings: {
      account_collections: {platform_fee: 123},
      maintenance: {issue_categories: ['<string>'], issue_preferred_categories: ['<string>']},
      payout_receipts: {
        email_cc: ['<string>'],
        email_to: '<string>',
        statement_descriptor: '<string>',
        send_email: true
      },
      payout_schedule: {monthly_anchor: 123, weekly_anchor: 123},
      payouts: {automatic_approval: true, instant_payouts: true, negative_payouts: true}
    },
    statement_prefix: '<string>',
    tax_residency: '<string>',
    trading_as_name: '<string>',
    type: 'landlord',
    workspace: '<string>'
  })
};

fetch('https://api.yorlet.com/v1/owners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yorlet.com/v1/owners",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'archived' => true,
    'assignee' => '<string>',
    'bank_account' => [
        
    ],
    'business_type' => 'individual',
    'company' => [
        'email' => '<string>',
        'name' => '<string>',
        'phone' => '<string>',
        'tax_id' => '<string>',
        'vat_id' => '<string>'
    ],
    'email' => '[email protected]',
    'individual' => [
        'email' => '[email protected]',
        'first_name' => '<string>',
        'last_name' => '<string>',
        'metadata' => [
                
        ],
        'phone' => '<string>',
        'relationship' => [
                'director' => true,
                'executive' => true,
                'owner' => true,
                'percent_ownership' => 50,
                'representative' => true,
                'title' => '<string>'
        ],
        'title' => '<string>'
    ],
    'labels' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'next_statement_sequence' => 2,
    'non_resident_tax_details' => [
        'certificate' => '<string>',
        'certificate_date' => 123,
        'country' => '<string>'
    ],
    'phone' => '<string>',
    'settings' => [
        'account_collections' => [
                'platform_fee' => 123
        ],
        'maintenance' => [
                'issue_categories' => [
                                '<string>'
                ],
                'issue_preferred_categories' => [
                                '<string>'
                ]
        ],
        'payout_receipts' => [
                'email_cc' => [
                                '<string>'
                ],
                'email_to' => '<string>',
                'statement_descriptor' => '<string>',
                'send_email' => true
        ],
        'payout_schedule' => [
                'monthly_anchor' => 123,
                'weekly_anchor' => 123
        ],
        'payouts' => [
                'automatic_approval' => true,
                'instant_payouts' => true,
                'negative_payouts' => true
        ]
    ],
    'statement_prefix' => '<string>',
    'tax_residency' => '<string>',
    'trading_as_name' => '<string>',
    'type' => 'landlord',
    'workspace' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yorlet.com/v1/owners"

	payload := strings.NewReader("{\n  \"archived\": true,\n  \"assignee\": \"<string>\",\n  \"bank_account\": {},\n  \"business_type\": \"individual\",\n  \"company\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"vat_id\": \"<string>\"\n  },\n  \"email\": \"[email protected]\",\n  \"individual\": {\n    \"email\": \"[email protected]\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"metadata\": {},\n    \"phone\": \"<string>\",\n    \"relationship\": {\n      \"director\": true,\n      \"executive\": true,\n      \"owner\": true,\n      \"percent_ownership\": 50,\n      \"representative\": true,\n      \"title\": \"<string>\"\n    },\n    \"title\": \"<string>\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"next_statement_sequence\": 2,\n  \"non_resident_tax_details\": {\n    \"certificate\": \"<string>\",\n    \"certificate_date\": 123,\n    \"country\": \"<string>\"\n  },\n  \"phone\": \"<string>\",\n  \"settings\": {\n    \"account_collections\": {\n      \"platform_fee\": 123\n    },\n    \"maintenance\": {\n      \"issue_categories\": [\n        \"<string>\"\n      ],\n      \"issue_preferred_categories\": [\n        \"<string>\"\n      ]\n    },\n    \"payout_receipts\": {\n      \"email_cc\": [\n        \"<string>\"\n      ],\n      \"email_to\": \"<string>\",\n      \"statement_descriptor\": \"<string>\",\n      \"send_email\": true\n    },\n    \"payout_schedule\": {\n      \"monthly_anchor\": 123,\n      \"weekly_anchor\": 123\n    },\n    \"payouts\": {\n      \"automatic_approval\": true,\n      \"instant_payouts\": true,\n      \"negative_payouts\": true\n    }\n  },\n  \"statement_prefix\": \"<string>\",\n  \"tax_residency\": \"<string>\",\n  \"trading_as_name\": \"<string>\",\n  \"type\": \"landlord\",\n  \"workspace\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/owners")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"archived\": true,\n  \"assignee\": \"<string>\",\n  \"bank_account\": {},\n  \"business_type\": \"individual\",\n  \"company\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"vat_id\": \"<string>\"\n  },\n  \"email\": \"[email protected]\",\n  \"individual\": {\n    \"email\": \"[email protected]\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"metadata\": {},\n    \"phone\": \"<string>\",\n    \"relationship\": {\n      \"director\": true,\n      \"executive\": true,\n      \"owner\": true,\n      \"percent_ownership\": 50,\n      \"representative\": true,\n      \"title\": \"<string>\"\n    },\n    \"title\": \"<string>\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"next_statement_sequence\": 2,\n  \"non_resident_tax_details\": {\n    \"certificate\": \"<string>\",\n    \"certificate_date\": 123,\n    \"country\": \"<string>\"\n  },\n  \"phone\": \"<string>\",\n  \"settings\": {\n    \"account_collections\": {\n      \"platform_fee\": 123\n    },\n    \"maintenance\": {\n      \"issue_categories\": [\n        \"<string>\"\n      ],\n      \"issue_preferred_categories\": [\n        \"<string>\"\n      ]\n    },\n    \"payout_receipts\": {\n      \"email_cc\": [\n        \"<string>\"\n      ],\n      \"email_to\": \"<string>\",\n      \"statement_descriptor\": \"<string>\",\n      \"send_email\": true\n    },\n    \"payout_schedule\": {\n      \"monthly_anchor\": 123,\n      \"weekly_anchor\": 123\n    },\n    \"payouts\": {\n      \"automatic_approval\": true,\n      \"instant_payouts\": true,\n      \"negative_payouts\": true\n    }\n  },\n  \"statement_prefix\": \"<string>\",\n  \"tax_residency\": \"<string>\",\n  \"trading_as_name\": \"<string>\",\n  \"type\": \"landlord\",\n  \"workspace\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/owners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"archived\": true,\n  \"assignee\": \"<string>\",\n  \"bank_account\": {},\n  \"business_type\": \"individual\",\n  \"company\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"vat_id\": \"<string>\"\n  },\n  \"email\": \"[email protected]\",\n  \"individual\": {\n    \"email\": \"[email protected]\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"metadata\": {},\n    \"phone\": \"<string>\",\n    \"relationship\": {\n      \"director\": true,\n      \"executive\": true,\n      \"owner\": true,\n      \"percent_ownership\": 50,\n      \"representative\": true,\n      \"title\": \"<string>\"\n    },\n    \"title\": \"<string>\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"next_statement_sequence\": 2,\n  \"non_resident_tax_details\": {\n    \"certificate\": \"<string>\",\n    \"certificate_date\": 123,\n    \"country\": \"<string>\"\n  },\n  \"phone\": \"<string>\",\n  \"settings\": {\n    \"account_collections\": {\n      \"platform_fee\": 123\n    },\n    \"maintenance\": {\n      \"issue_categories\": [\n        \"<string>\"\n      ],\n      \"issue_preferred_categories\": [\n        \"<string>\"\n      ]\n    },\n    \"payout_receipts\": {\n      \"email_cc\": [\n        \"<string>\"\n      ],\n      \"email_to\": \"<string>\",\n      \"statement_descriptor\": \"<string>\",\n      \"send_email\": true\n    },\n    \"payout_schedule\": {\n      \"monthly_anchor\": 123,\n      \"weekly_anchor\": 123\n    },\n    \"payouts\": {\n      \"automatic_approval\": true,\n      \"instant_payouts\": true,\n      \"negative_payouts\": true\n    }\n  },\n  \"statement_prefix\": \"<string>\",\n  \"tax_residency\": \"<string>\",\n  \"trading_as_name\": \"<string>\",\n  \"type\": \"landlord\",\n  \"workspace\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created": 123,
  "object": "owner",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<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,
    "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,
      "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
    }
  },
  "tax_residency": "<string>",
  "account": "<string>",
  "deleted": false,
  "balance": 0,
  "metadata": {},
  "payouts_enabled": false
}

Authorizations

Authorization

string

header

required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json

archived

boolean

Whether the owner has been archived.

assignee

string | null

The identifier of the user the owner is assigned to.

bank_account

object | null

Bank account information to attach to the owner.

Show child attributes

business_type

enum<string>

default:individual

The legal type of the owner.

Available options:

individual,

company

company

object

Information about the company. Required when business_type is company.

Show child attributes

string<email>

The owner's contact email address.

individual

object

Information about the individual. Required when business_type is individual.

Show child attributes

labels

string[] | null

Labels applied to the owner for organizational purposes.

metadata

object | null

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

next_statement_sequence

integer

The sequence number to use for the next statement.

Required range: x >= 1

non_resident_tax_details

object

Non-resident tax details, if applicable.

Show child attributes

phone

string | null

The owner's contact phone number.

settings

object

Configurable settings for the owner.

Show child attributes

statement_prefix

string

The prefix used on statements generated for this owner.

Required string length: 3 - 12

tax_residency

string | null

Two-letter ISO code representing the owner's tax residency country.

trading_as_name

string | null

The name the owner trades as.

type

enum<string>

default:landlord

The type of the owner.

Available options:

landlord,

leaseholder,

platform,

supplier

workspace

string

The workspace the owner belongs to.

Response

200 - application/json

Returns the owner object if the request succeeded.

string

required

Unique identifier for the object.

created

number

required

Time at which the object was created. Measured in seconds since the Unix epoch.

object

enum<string>

required

Available options:

owner

address

object | null

required

The owner's address.

Show child attributes

business_type

enum<string>

required

The legal type of the owner.

Available options:

individual,

company

client_secret

string

required

A secret token used to authenticate owner-scoped requests, such as generating PDF statements.

company

object | null

required

Information about the company. Only present when business_type is company.

Show child attributes

country

string | null

required

Two-letter ISO code representing the country of the owner.

string | null

required

The owner's contact email address.

external_account

required

The external account to which payouts are sent.

Show child attributes

individual

object | null

required

Information about the individual. Only present when business_type is individual.

Show child attributes

name

string | null

required

Display name of the owner.

requirements

object

required

Outstanding requirements for the owner.

Show child attributes

settings

object

required

Configurable settings for the owner.

Show child attributes

status

enum<string>

required

The current status of the owner.

Available options:

complete,

incomplete,

disabled,

archived

tax_residency

string | null

required

Two-letter ISO code representing the owner's tax residency country.

type

enum<string>

required

The type of the owner.

Available options:

landlord,

leaseholder,

platform,

supplier

account

string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted

boolean

default:false

Only returned if the object has been deleted.

balance

number

default:0

The owner's current balance, in the smallest currency unit.

metadata

object | null

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

payouts_enabled

boolean

default:false

Whether the owner is currently able to receive payouts.

The owner object

Retrieve an owner

Yorlet API

Billing

Checkout

Core

Guardrails

Leads

Leasing

Loyalty

Owners

Payments

Terminal

Test Helpers

Authorizations

Body

Response