Owners represent the legal owners of units and are used to route payments collected on behalf of owners.

1. Create an owner

The minimum information required to create an owner is:

• Their email.

• The business_type, which can be either company or individual.

curl https://api.yorlet.com/v1/owners \
-H "Authorization: {{API_KEY}}" \
-H "Content-Type: application/json" \
-d '{
      "email": "[email protected]",
      "business_type": "individual"
    }'

If you want to pre-fill information, you can provide more details when creating the Owner. See the create an owner API for a full list of parameters you can send.

Step 2: Create an onboarding link

curl https://api.yorlet.com/v1/owners/{{OWNER_ID}}/onboarding \
-H "Authorization: {{API_KEY}}" \
-H "Content-Type: application/json" \
-d '{
      "type": "owner_onboarding"
    }'

Step 3: Redirect to URL

The response includes a url. Redirect to this link to send your user into the flow. URLs from the Onboarding Links are temporary and can only be used once because they grant access to the account holder’s personal information. Authenticate the user in your application before redirecting them to this URL.

Step 4: User returns to your site

After the user completes the onboarding flow they will be redirected back to your site.

Step 5: Handle users that still require information

Check the Owner status and create another onboarding link to complete onboarding if needed.