Begin KYB application process

Submits a request for a know your business (KYB) application

Request
Security:
tilia_auth (write_entities)
path Parameters
account_id
required
string

Tilia account ID with which the business entity will be associated

Example: f1a2d21c-1736-4f9b-997d-2aaf1fc0f50e
Request Body schema: application/json

KYB Entity Onboard Request

user_email
string

Email that will receive the link to the KYB application form

If left blank, the email associated with the account_id in the route will be used.

entity_name
required
string

Entity's legal name

custom_application_id
string

Custom publisher ID used to track the application in the publisher's system

jurisdiction
required
string

Type of application being requested

Possible values:

  • domestic
  • international
Responses
200

A new KYB application process has begun

400

Invalid input

401

Unauthorized access.

500

Service unavailable or server error.

post/v1/entity/{account_id}/onboard
Request samples
application/json
{
  • "user_email": "testing@tilia.com",
  • "entity_name": "Tilia Entity",
  • "custom_application_id": "9a2beeb0-ed09-4c69-9627-786eb6d2df33",
  • "jurisdiction": "domestic"
}
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}