KYB (Entities)
The Entities section manages company/entity profiles. It includes an entities list page and individual entity profile pages with documents, shareholders, and entity details.
Routes
- Entities list:
/entities - Entity profile:
/entity/:id - Entity documents (route-controlled):
/entity/:id/documents/:docID?- Archived documents view uses the query parameter:
?archived=true
- Archived documents view uses the query parameter:
Entities List (/entities)
Header Controls
| Control | Description |
|---|---|
| Registration Number search | Filters table by registration number. Submit with Enter or the search button. Clear input to remove filter. |
| Entity Name search | Filters table by entity name. Submit with Enter or the search button. Clear input to remove filter. |
| Show/Hide | Opens a column visibility dialog. Selected columns are persisted to LocalStorage (visibleColumnsEntities). |
| Add New Entity | Opens the entity creation dialog (CreateEntity component). |
Table Columns
The following columns are available. Default visible columns: Registration Number, Entity Name, Status, Incorporation Date, Country, Alerts, Risk, Company Name.
| Column | Field | Notes |
|---|---|---|
| Registration Number | registration_number | Displayed in monospace |
| Entity Name | name | Bold; links to entity profile |
| Status | status | Displayed as a status capsule (see values below) |
| Incorporation Date | incorporation_date | Formatted as DD MMM YYYY; displays — if empty |
| Country | country_name | |
| Alerts | alert | Displayed as a status capsule (see values below) |
| Risk | risk | Displayed as a status capsule (see values below) |
| Company Name | company_name |
Each row links to the entity profile at /entity/:id.
Pagination
Rows per page options: 20, 50, 100. Table uses virtual scroll. Pagination state (page, limit, ordering) is reflected in the URL query string.
Status Values
| Value | Display |
|---|---|
| CREATED | Created |
| INCOMPLETE | Incomplete |
| PENDING_REVIEW | Pending (sub-status: REVIEW) |
| PENDING_APPROVAL | Pending (sub-status: APPROVAL) |
| PENDING_UPLOAD | Pending (sub-status: UPLOAD) |
| APPROVED | Approved |
| REJECTED | Rejected |
| BLACKLISTED | Blacklisted |
| INACTIVE | Inactive |
Risk Values
| Value | Label |
|---|---|
| 0 | Normal |
| 1 | High |
| 2 | Very High |
| 3 | NFC |
| 4 | Unknown |
Alert Values
| Value | Display |
|---|---|
| 0 or 4 | Clear |
| Any other non-null value | Risk |
| null | — (dash) |
Entity Profile (/entity/:id)
The entity profile page is divided into four sections rendered in order:
| Section | What it shows |
|---|---|
| Entity | Key summary information for the business — name, status, registration details |
| Documents | All documents uploaded for this entity (includes archived documents) |
| Shareholders | Individuals or companies listed as shareholders of this entity — used for ownership transparency and compliance review |
| Entity Details | Full detail fields for the entity record |
Use the tab navigation on the left to jump directly to any section.
Entity Documents (/entity/:id/documents/:docID?)
When accessed via the route-controlled documents page:
- A vertical document list is shown.
- Selecting a document opens it in the viewer area (
:docIDparameter). - Appending
?archived=trueto the URL switches to archived documents view. - Upload Document opens the upload dialog to add a new document.
The archived documents view is also available on the entity profile page (/entity/:id) where the EntityDocuments component is rendered with the archived flag enabled by default.