Application status
Returned on thestatus field of applications.
| Value | Description |
|---|---|
created | Application created but invite not yet sent |
sent | Invite email sent to primary contact |
in_progress | End user has started filling in the application |
submitted | End user has submitted all requested items |
review | Application is under manual review |
approved | Application approved by admin |
rejected | Application rejected by admin |
Document status
Returned on thestatus field of documents.
| Value | Description |
|---|---|
pending | Document uploaded, awaiting validation |
validating | AI validation in progress |
accepted | Document passed validation |
rejected | Document failed validation |
clarification_needed | Additional information requested from the user |
forced | Document manually accepted by an admin |
skipped | Document requirement manually waived by an admin |
Person source
Returned on thesource field of people in data.people.
| Value | Description |
|---|---|
registry | Person was auto-populated from a company registry (e.g., Companies House) |
user_added | Person was manually added by the end user |
contact_fallback | Person was created from the primary contact when no directors were found in the registry |
Person roles
Returned on theroles array of people in data.people. A person can have multiple roles.
| Value | Description |
|---|---|
director | Company director |
ubo | Ultimate beneficial owner (typically 25%+ ownership) |
shareholder | Shareholder of the company |
Entity type
Returned on thetype field of entities in data.entities.
| Value | Description |
|---|---|
holding_company | A holding company in the ownership structure |
subsidiary | A subsidiary entity |
parent | A parent entity |
other | Other related entity |
Entity source
Returned on thesource field of entities in data.entities.
| Value | Description |
|---|---|
registry | Entity was auto-populated from a company registry |
user_added | Entity was manually added by the end user |
Participant role
Returned on therole field of participants.
| Value | Description |
|---|---|
primary | The main contact responsible for the application |
Ownership relationship [#ownership-relationship]
Returned in thedata.ownership array.
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier |
owner_type | "person" | "entity" | "other" | What type of entity is the owner |
owner_id | string | undefined | ID of the person or entity. Absent when owner_type is "other" |
other_description | string | undefined | Description when owner is “other” (e.g., “Public shareholders”) |
country | string | undefined | Country/jurisdiction for entity owners (ISO 3166-1 alpha-2) |
registration_number | string | undefined | Company registration number for entity owners |
owned_type | "target" | "entity" | Whether this is ownership of the target company or another entity |
owned_id | string | undefined | ID of the owned entity. Absent when owning the target company |
percentage | number | Ownership percentage |
is_direct | boolean | Whether this is direct or indirect ownership |
is_nominee | boolean | Whether this is a nominee arrangement |
beneficial_owner_id | string | undefined | If nominee, the ID of the actual beneficial owner |
Webhook event types
See Webhooks for full payload examples.| Event | Description |
|---|---|
application.opened | End user opened the portal for the first time |
application.submitted | End user submitted the application |
webhook.test | Manual test ping from the dashboard |