{ "openapi": "3.1.0", "info": { "title": "Entiva API", "version": "2026-10-17", "description": "The API for legal entities: form, run and close companies in Hong Kong, Singapore, the United Kingdom, the Cayman Islands, the British Virgin Islands and every US state." }, "servers": [ { "url": "https://api.entiva.com", "description": "Live" }, { "url": "https://sandbox.api.entiva.com", "description": "Sandbox: filings are simulated" } ], "security": [ { "bearer": [] }, { "oauth": [] } ], "paths": { "/v1/action-types": { "get": { "summary": "Search action types", "tags": [ "Catalog" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" } }, { "name": "entity_type", "in": "query", "schema": { "type": "string" } }, { "name": "stage", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Action" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/action-types/{type}": { "get": { "summary": "Get an action type's parameters, documents, people, signatures and fees", "tags": [ "Catalog" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/jurisdictions": { "get": { "summary": "List jurisdictions", "tags": [ "Catalog" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/jurisdictions/{jurisdiction}": { "get": { "summary": "Get a jurisdiction's entity types, signature rules, verification rules and lifecycles", "tags": [ "Catalog" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "jurisdiction", "in": "path", "required": true, "schema": { "enum": [ "hk", "sg", "uk", "ky", "vg", "us" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/formations": { "post": { "summary": "Form a new entity", "tags": [ "Actions" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "validate_only", "in": "query", "schema": { "type": "boolean" }, "description": "Return every requirement (fields, people, documents, signatures, approvals) without creating anything" }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Action" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionCreate" } } } }, "description": "Instructed by the founders: each confirms in person. The action's requirements list everything still needed; validate_only returns them up front.", "x-entiva-agent": "allowed" } }, "/v1/entities": { "get": { "summary": "List entities", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/import": { "post": { "summary": "Move an existing entity to Entiva (transfer-in)", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "enum": [ "hk", "sg", "uk", "ky", "vg", "us" ] }, "registration_number": { "type": "string" }, "entity_type": { "type": "string" }, "current_provider": { "type": "string" } }, "required": [ "jurisdiction", "registration_number" ] } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}": { "get": { "summary": "Get an entity", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/actions": { "post": { "summary": "Start a corporate action", "tags": [ "Actions" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } }, { "name": "validate_only", "in": "query", "schema": { "type": "boolean" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Action" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionCreate" } } } }, "description": "The caller must act for a person with an active Authority over the entity that covers the action type, directly or through a mandate. Otherwise: permission_error no_authority.", "x-entiva-agent": "allowed" }, "get": { "summary": "List an entity's actions", "tags": [ "Actions" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Action" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/deadlines": { "get": { "summary": "List upcoming deadlines", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Deadline" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/registers/{register}": { "get": { "summary": "Read a statutory register", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } }, { "name": "register", "in": "path", "required": true, "schema": { "enum": [ "members", "directors", "secretaries", "controllers", "charges", "beneficial_owners" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/actions/{action_id}": { "get": { "summary": "Get an action", "tags": [ "Actions" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^act_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Action" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/actions/{action_id}/approve": { "post": { "summary": "Approve an action and its quote", "tags": [ "Actions" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^act_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Action" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "mandate" } }, "/v1/actions/{action_id}/cancel": { "post": { "summary": "Cancel an action", "tags": [ "Actions" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^act_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Action" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "allowed" } }, "/v1/actions/{action_id}/signature-requests": { "get": { "summary": "List signature requests", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^act_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureRequest" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/signature-requests/{sig_id}": { "get": { "summary": "Get a signature request", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "sig_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^sig_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/signature-requests/{sig_id}/send": { "post": { "summary": "Ask the signer to sign", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "sig_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^sig_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "enum": [ "email", "sms", "in_app", "embedded" ] } }, "message": { "type": "string" }, "due_by": { "type": "integer" } } } } } }, "description": "Sends the signer a link to the hosted signing page (or returns sign_url for embedded signing). Wet-ink and notarised methods book the courier or notary instead. An agent may send under any mandate: asking is not signing.", "x-entiva-agent": "allowed" } }, "/v1/signature-requests/{sig_id}/remind": { "post": { "summary": "Remind the signer", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "sig_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^sig_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "x-entiva-agent": "allowed" } }, "/v1/signature-requests/{sig_id}/decline": { "post": { "summary": "Decline to sign", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "sig_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^sig_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string" } } } } } }, "x-entiva-agent": "never" } }, "/v1/signature-requests/{sig_id}/upload": { "post": { "summary": "Upload a signed paper copy", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "sig_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^sig_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "description": "For wet ink: the scan clears the request for review; the original still travels by courier where the registry needs it.", "x-entiva-agent": "never" } }, "/v1/signature-requests/{sig_id}/sign": { "post": { "summary": "Sign, or have an agent sign under a mandate", "tags": [ "Signatures" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "sig_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^sig_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureRequest" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signer": { "type": "string" }, "mandate": { "type": "string" } } } } } }, "x-entiva-agent": "mandate" } }, "/v1/people": { "post": { "summary": "Create a person", "tags": [ "People" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "x-entiva-agent": "allowed" }, "get": { "summary": "List people", "tags": [ "People" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/documents": { "post": { "summary": "Upload a document", "tags": [ "Documents" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "purpose": { "type": "string" } }, "required": [ "file", "purpose" ] } } } }, "x-entiva-agent": "allowed" } }, "/v1/documents/{doc_id}": { "get": { "summary": "Get a document", "tags": [ "Documents" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^doc_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/mandates": { "post": { "summary": "Authorise an AI agent", "tags": [ "Agents" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandate" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandate" } } } }, "x-entiva-agent": "allowed" } }, "/v1/mandates/{mandate_id}/revoke": { "post": { "summary": "Revoke a mandate", "tags": [ "Agents" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "mandate_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^man_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mandate" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "allowed" } }, "/v1/webhook-endpoints": { "post": { "summary": "Create a webhook endpoint", "tags": [ "Webhooks" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } } } }, "x-entiva-agent": "mandate" } }, "/v1/signups": { "post": { "summary": "Sign up. Creates a sandbox account and its owner", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signup" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "The owner's email. Entiva sends a link to confirm it." }, "country": { "type": "string", "description": "ISO 3166 country of the person or business." }, "name": { "type": "string" }, "account_type": { "type": "string", "enum": [ "individual", "business" ] }, "business_name": { "type": "string" }, "agent": { "type": "object", "description": "When an agent signs up for a person: name, client and contact. The response then carries a test key and claim_url." } }, "required": [ "email", "country" ] } } } }, "x-entiva-agent": "allowed", "security": [], "description": "Needs no key. Test mode works at once. Live mode starts when the owner claims the account, verifies their identity and accepts the terms." } }, "/v1/account": { "get": { "summary": "Get your account, its status and requirements", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" }, "post": { "summary": "Update your account's details and settings", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "display_name": { "type": "string" }, "business_profile": { "type": "object" }, "settings": { "type": "object", "description": "approval_policy, default_currency, timezone, notification_email." }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "x-entiva-agent": "never" } }, "/v1/account/close": { "post": { "summary": "Close your account", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "never", "description": "Only the owner. Entities must be closed or transferred out first; Entiva keeps records for as long as the law requires." } }, "/v1/accounts": { "post": { "summary": "Create an account for one of your customers", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "individual", "business" ] }, "country": { "type": "string" }, "email": { "type": "string", "description": "The customer's owner. They receive the onboarding link." }, "business_profile": { "type": "object" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "country", "email" ] } } } }, "x-entiva-agent": "mandate", "description": "Platforms then act for the customer with the Entiva-Account header." }, "get": { "summary": "List your customers' accounts", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/accounts/{account_id}": { "get": { "summary": "Get a customer's account", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^acct_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/account-links": { "post": { "summary": "Create a hosted link for a person to claim, onboard, verify or sign", "tags": [ "Accounts" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLink" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "account_claim", "account_onboarding", "account_update", "identity_verification", "signature" ] }, "account": { "type": "string", "pattern": "^acct_", "description": "Platforms only: the customer's account." }, "person": { "type": "string", "pattern": "^per_" }, "return_url": { "type": "string" }, "refresh_url": { "type": "string" } }, "required": [ "type", "return_url", "refresh_url" ] } } } }, "x-entiva-agent": "allowed", "description": "This is how agents hand a person the steps only the person can do." } }, "/v1/users": { "get": { "summary": "List the account's users and their roles", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/users/{user_id}": { "get": { "summary": "Get a user", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^usr_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" }, "post": { "summary": "Change a user's role or the entities they can see", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^usr_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "approver", "member", "developer", "billing", "viewer" ] }, "entities": { "type": "array", "items": { "type": "string", "pattern": "^ent_" } } } } } } }, "x-entiva-agent": "never" }, "delete": { "summary": "Remove a user from the account", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^usr_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "never" } }, "/v1/invitations": { "post": { "summary": "Invite a teammate with a role", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invitation" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "approver", "member", "developer", "billing", "viewer" ] }, "entities": { "type": "array", "items": { "type": "string", "pattern": "^ent_" } } }, "required": [ "email", "role" ] } } } }, "x-entiva-agent": "mandate", "description": "Approvers verify their identity before their first approval, because approvers sign." }, "get": { "summary": "List invitations", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invitation" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/invitations/{invitation_id}/revoke": { "post": { "summary": "Revoke an invitation", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^inv_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invitation" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "mandate" } }, "/v1/api-keys": { "post": { "summary": "Create a secret, restricted or agent key", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "secret", "restricted", "agent" ] }, "mode": { "type": "string", "enum": [ "test", "live" ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "mandate": { "type": "string", "pattern": "^man_", "description": "Required for agent keys." }, "expires_at": { "type": "integer", "description": "Unix time" } }, "required": [ "type", "mode" ] } } } }, "x-entiva-agent": "never" }, "get": { "summary": "List keys", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/api-keys/{key_id}/roll": { "post": { "summary": "Replace a key's secret", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^key_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expire_current_in": { "type": "integer", "description": "Seconds the old secret keeps working, up to seven days." } } } } } }, "x-entiva-agent": "never" } }, "/v1/api-keys/{key_id}/revoke": { "post": { "summary": "Revoke a key", "tags": [ "Users and keys" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^key_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "never" } }, "/v1/people/{person_id}": { "get": { "summary": "Get a person with their verification status", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^per_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" }, "post": { "summary": "Update a person's details", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^per_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "legal_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "residential_address": { "$ref": "#/components/schemas/Address" }, "service_address": { "$ref": "#/components/schemas/Address" }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "x-entiva-agent": "allowed", "description": "Changing a verified name, date of birth or address starts a new verification." } }, "/v1/people/{person_id}/verifications": { "post": { "summary": "Verify a person for their roles", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^per_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "hk", "sg", "uk", "ky", "vg", "us" ] }, "roles": { "type": "array", "items": { "type": "string" } }, "level": { "type": "string", "enum": [ "identity", "identity_address", "enhanced", "registry_idv" ], "description": "Optional. Defaults to what the strictest role needs." }, "method": { "type": "string", "enum": [ "hosted", "sdk", "government_eid", "document_upload", "video_call" ] }, "send_to": { "type": "string", "enum": [ "none", "email", "sms" ] }, "return_url": { "type": "string" } }, "required": [ "jurisdiction", "roles" ] } } } }, "x-entiva-agent": "allowed", "description": "If the person already holds a verification at this level that is still reusable, it is returned at once." } }, "/v1/verifications": { "get": { "summary": "List verifications", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Verification" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/verifications/{verification_id}": { "get": { "summary": "Get a verification and its checks", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "verification_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ver_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/verifications/{verification_id}/cancel": { "post": { "summary": "Cancel a verification the person has not finished", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "verification_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ver_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "allowed" } }, "/v1/verifications/{verification_id}/redact": { "post": { "summary": "Delete a verification's personal data once the law allows", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "verification_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ver_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "x-entiva-agent": "never", "description": "Anti-money-laundering law requires records to be kept for five to seven years after the relationship ends. Until then redaction is scheduled, not immediate." } }, "/v1/screening-alerts": { "get": { "summary": "List screening alerts", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningAlert" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/screening-alerts/{alert_id}": { "get": { "summary": "Get a screening alert", "tags": [ "Identity" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "alert_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^scr_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningAlert" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/share-classes": { "get": { "summary": "List an entity's share classes", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShareClass" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/share-classes/{share_class_id}": { "get": { "summary": "Get a share class", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "share_class_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^shc_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareClass" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/signing-authority": { "get": { "summary": "How the entity signs", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningAuthority" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" }, "post": { "summary": "Record the signing authority from the constitution or a resolution", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningAuthority" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rule": { "type": "string", "enum": [ "any_one_director", "two_directors", "director_and_secretary", "director_and_witness", "common_seal", "sole_director", "any_general_partner", "any_member", "any_manager", "named_signatories", "as_resolution" ] }, "signatories": { "type": "array", "items": { "type": "string", "pattern": "^per_" } }, "limits": { "type": "object" }, "source": { "type": "string", "enum": [ "constitution", "resolution", "law" ] }, "source_document": { "type": "string", "pattern": "^doc_" } }, "required": [ "rule", "source" ] } } } }, "x-entiva-agent": "mandate", "description": "Creating or changing a share class, or changing who signs, is itself a corporate action where the law requires a resolution or a filing; this records the result." } }, "/v1/entities/{entity_id}/governing-documents": { "post": { "summary": "Add the articles, a shareholders' agreement or another governing document", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoverningDocument" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "articles", "memorandum", "constitution", "bylaws", "llc_agreement", "partnership_agreement", "shareholders_agreement", "investors_rights_agreement", "voting_agreement", "board_resolution" ] }, "document": { "type": "string", "pattern": "^doc_", "description": "Upload the file first with POST /v1/documents." }, "parties": { "type": "array", "items": { "type": "string", "pattern": "^per_" } }, "effective_from": { "type": "string", "format": "date" } }, "required": [ "type", "document" ] } } } }, "x-entiva-agent": "allowed", "description": "Entiva reads it into the governance profile. Nothing applies until a person confirms the extracted rules." }, "get": { "summary": "List the entity's governing documents", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GoverningDocument" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/governance": { "get": { "summary": "The entity's governance profile: share classes, signing, board rules, approval rules, transfer restrictions", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Governance" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/entities/{entity_id}/governance/confirm": { "post": { "summary": "Confirm the rules extracted from a governing document", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Governance" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "governing_document": { "type": "string", "pattern": "^gdoc_" }, "corrections": { "type": "object", "description": "Any rule the reviewer changes, by path." } }, "required": [ "governing_document" ] } } } }, "x-entiva-agent": "never", "description": "People only: a wrong rule would let an action through without the consent it needs." } }, "/v1/entities/{entity_id}/authorities": { "post": { "summary": "Record a person's authority to instruct for an entity", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authority" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_" }, "capacity": { "type": "string", "enum": [ "founder", "director", "officer", "company_secretary", "member", "general_partner", "manager", "trustee", "liquidator", "authorised_representative", "attorney" ] }, "evidence": { "type": "string", "enum": [ "founder_consent", "register_of_directors", "register_of_officers", "register_of_members", "board_resolution", "power_of_attorney", "court_order", "appointment_document" ] }, "document": { "type": "string", "pattern": "^doc_" }, "scope": { "type": "array", "items": { "type": "string" } }, "limit": { "$ref": "#/components/schemas/Money" }, "valid_until": { "type": "string", "format": "date" } }, "required": [ "person", "capacity", "evidence" ] } } } }, "x-entiva-agent": "never", "description": "Directors and officers on the entity's register get an authority automatically when they are verified; this records the others." }, "get": { "summary": "Who may instruct for the entity", "tags": [ "Entities" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^ent_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Authority" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/events": { "get": { "summary": "List events from the last 30 days", "tags": [ "Records" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/events/{event_id}": { "get": { "summary": "Get an event", "tags": [ "Records" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } }, { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^evt_" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } }, "/v1/audit-events": { "get": { "summary": "Who did what, including every agent and the mandate it acted under", "tags": [ "Records" ], "parameters": [ { "name": "Entiva-Version", "in": "header", "required": false, "schema": { "type": "string", "default": "2026-10-17" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEvent" } }, "has_more": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "object", "data", "has_more" ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-entiva-agent": "allowed" } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "sk_test_ or sk_live_ secret keys, rk_ restricted keys, or an agent key (ak_) bound to a mandate" }, "oauth": { "type": "oauth2", "description": "Third-party apps acting for an account", "flows": { "authorizationCode": { "authorizationUrl": "https://connect.entiva.com/oauth/authorize", "tokenUrl": "https://connect.entiva.com/oauth/token", "scopes": { "entities:read": "Read entities", "actions:write": "Start actions", "people:write": "Add and verify people", "account:read": "Read the account" } } } } }, "schemas": { "Money": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Minor units" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "amount", "currency" ] }, "Address": { "type": "object", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "required": [ "line1", "city", "country" ] }, "Metadata": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 50 }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "enum": [ "invalid_request_error", "authentication_error", "permission_error", "requirement_error", "jurisdiction_error", "registry_error", "rate_limit_error", "api_error" ] }, "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "requirement": { "type": "string" }, "doc_url": { "type": "string" } }, "required": [ "type", "message" ] } }, "required": [ "error" ] }, "Requirement": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "enum": [ "verify_person", "upload_document", "collect_signature", "approve", "pay_government_fee", "provide_param" ] }, "description": { "type": "string" }, "person": { "type": "string" }, "document_key": { "type": "string" }, "endpoint": { "type": "string" }, "due_by": { "type": "string", "format": "date-time" } }, "required": [ "id", "kind", "description" ] }, "Quote": { "type": "object", "properties": { "entiva_fee": { "type": "object", "properties": { "basis": { "enum": [ "free", "included", "fixed" ] }, "amount": { "type": "integer" }, "currency": { "type": "string" } }, "required": [ "basis" ] }, "government_fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "amount": { "type": "integer" }, "currency": { "type": "string" }, "at_cost": { "const": true } } } }, "total": { "$ref": "#/components/schemas/Money" } } }, "Action": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^act_" }, "object": { "const": "action" }, "type": { "type": "string" }, "entity": { "type": "string", "pattern": "^ent_" }, "status": { "enum": [ "draft", "requirements_pending", "awaiting_approval", "awaiting_signatures", "in_preparation", "submitted", "completed", "rejected", "cancelled", "failed" ] }, "params": { "type": "object" }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/Requirement" } }, "quote": { "$ref": "#/components/schemas/Quote" }, "instruction": { "type": "object", "properties": { "capacities": { "type": "array", "items": { "type": "string" } }, "evidence": { "type": "array", "items": { "type": "string" } } }, "description": "Who may instruct this action and on what evidence" }, "instructed_by": { "type": "object", "properties": { "user": { "type": "string", "pattern": "^usr_" }, "person": { "type": "string", "pattern": "^per_" }, "capacity": { "type": "string" }, "authority": { "type": "string", "pattern": "^auth_" }, "api_key": { "type": "string" }, "mandate": { "type": "string", "pattern": "^man_" } }, "description": "Who instructed it: a verified person acting under an authority over the entity, directly or through an agent's mandate" }, "approved_by": { "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string" }, "person": { "type": "string" }, "via": { "enum": [ "in_app", "mandate" ] }, "mandate": { "type": "string" }, "at": { "type": "integer" } } } }, "approvals": { "type": "array", "description": "Resolved for this entity: the law's requirement, then stricter rules from its articles, then reserved matters from its shareholders' agreements. A contractual consent blocks the action until it is given, or until an owner waives it on the record.", "items": { "type": "object", "properties": { "body": { "type": "string" }, "threshold": { "type": "string" }, "percent": { "type": "integer" }, "source": { "enum": [ "statute", "articles", "shareholders_agreement", "other_agreement" ] }, "clause": { "type": "string" }, "document": { "type": "string" }, "status": { "enum": [ "pending", "obtained", "waived", "not_required" ] }, "evidence": { "type": "string", "description": "doc_ id of the resolution or consent" } } } }, "documents": { "type": "array", "items": { "type": "string" } }, "outputs": { "type": "array", "items": { "type": "string" } }, "created": { "type": "integer" }, "livemode": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "id", "object", "type", "status" ] }, "Entity": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^ent_" }, "object": { "const": "entity" }, "jurisdiction": { "enum": [ "hk", "sg", "uk", "ky", "vg", "us" ] }, "sub_jurisdiction": { "type": "string" }, "entity_type": { "type": "string" }, "legal_name": { "type": "string" }, "registration_number": { "type": "string" }, "status": { "type": "string", "description": "Lifecycle state, for example forming, active, dormant, in_liquidation, struck_off, dissolved" }, "registered_office": { "$ref": "#/components/schemas/Address" }, "plan": { "enum": [ "run", "group", "platform", "none" ] }, "kind": { "type": "string", "description": "Cross-jurisdiction classification of the entity type" }, "share_classes": { "type": "array", "items": { "type": "string", "pattern": "^shc_" } }, "signing_authority": { "$ref": "#/components/schemas/SigningAuthority" }, "governance": { "$ref": "#/components/schemas/Governance" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "id", "object", "jurisdiction", "entity_type", "status" ] }, "Person": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^per_" }, "object": { "const": "person" }, "kind": { "enum": [ "individual", "corporate" ] }, "legal_name": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "nationality": { "type": "string" }, "residential_address": { "$ref": "#/components/schemas/Address" }, "service_address": { "$ref": "#/components/schemas/Address" }, "email": { "type": "string" }, "phone": { "type": "string" }, "user": { "type": "string", "pattern": "^usr_", "description": "Set when this person also signs in to Entiva" }, "verification_status": { "enum": [ "unverified", "pending", "verified", "failed", "expired" ] }, "verification": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^ver_" }, "level": { "type": "string" }, "reusable_until": { "type": "string", "format": "date" } }, "description": "The person's current verification" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "id", "object", "kind", "legal_name" ] }, "Verification": { "type": "object", "description": "One identity check of one person, to the level their roles need. Entiva routes each check to a specialist provider and returns the same result whichever provider ran it.", "properties": { "id": { "type": "string", "pattern": "^ver_" }, "object": { "const": "verification" }, "person": { "type": "string", "pattern": "^per_" }, "purpose": { "type": "string", "enum": [ "account_owner", "user", "role_holder" ], "description": "Why the person is verified: they own the account, they sign in to it, or they hold a role in an entity." }, "jurisdiction": { "type": "string", "enum": [ "hk", "sg", "uk", "ky", "vg", "us" ], "description": "The rulebook applied: the strictest jurisdiction the roles are in." }, "roles": { "type": "array", "items": { "type": "object" }, "description": "Each role with its entity, and ownership_pct for owners. Owners are identified from 10% everywhere, the strictest threshold (Cayman and the BVI)." }, "level": { "type": "string", "enum": [ "identity", "identity_address", "enhanced", "registry_idv" ], "description": "Chosen from the strictest role. You can ask for a higher level, never a lower one." }, "method": { "type": "string", "enum": [ "hosted", "sdk", "government_eid", "document_upload", "video_call" ], "description": "How the person completes it. hosted is the default." }, "status": { "type": "string", "enum": [ "requires_input", "processing", "needs_review", "verified", "failed", "canceled", "expired" ] }, "checks": { "type": "array", "items": { "$ref": "#/components/schemas/VerificationCheck" }, "description": "Every check the level needs, with its own result." }, "url": { "type": "string", "description": "The hosted page the person completes. Expires after 24 hours; create a new verification to send another." }, "client_secret": { "type": "string", "description": "For the web and mobile SDKs." }, "send_to": { "type": "string", "enum": [ "none", "email", "sms" ], "description": "Entiva sends the person the link." }, "last_error": { "type": "object", "description": "code and reason when the person needs to try again: document_expired, document_unreadable, selfie_mismatch, liveness_failed, address_mismatch, consent_declined or under_age." }, "verified_outputs": { "$ref": "#/components/schemas/VerifiedOutputs", "description": "What was verified. Document numbers are never returned in full." }, "evidence": { "type": "object", "description": "How identity was proven, not just whether: method (chip, visual, database, government_eid, video_call or certified_copy), certification_profile such as GPG45 M1A, liveness_certification such as iBeta PAD level 2, and the provider's reference." }, "next_review_at": { "type": "string", "format": "date", "description": "When the person is checked again. Set by risk: at least yearly for high risk." }, "retention_until": { "type": "string", "format": "date", "description": "Until when the evidence is kept: five years after the relationship ends, seven for Companies House evidence. Deleted after." }, "reusable_until": { "type": "string", "format": "date", "description": "The person is not asked again until this date for roles at the same level. Each jurisdiction sets its own limit." }, "reused_from": { "type": "string", "pattern": "^ver_", "description": "Set when an earlier verification satisfied this one." }, "consent": { "type": "object", "description": "given_at, ip and text_version. The person gives consent themselves in the hosted flow." }, "provider": { "type": "string", "description": "The provider Entiva routed the document and selfie check to. For information only." }, "created": { "type": "integer", "description": "Unix time" }, "completed_at": { "type": "integer", "description": "Unix time" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "id", "object" ] }, "Document": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^doc_" }, "object": { "const": "document" }, "purpose": { "type": "string" }, "filename": { "type": "string" }, "source": { "enum": [ "uploaded", "generated", "registry_issued" ] }, "size": { "type": "integer" }, "sha256": { "type": "string" }, "action": { "type": "string", "pattern": "^act_" }, "document_key": { "type": "string" }, "status": { "enum": [ "draft", "out_for_signature", "executed", "filed", "superseded" ], "description": "executed once every signature request on it is signed; filed once the registry accepts it" }, "version": { "type": "integer", "description": "The draft is version 1. Each signature adds a version; the executed copy is sealed and its sha256 fixed" }, "signatures": { "type": "array", "items": { "type": "string", "pattern": "^sig_" } }, "executed_file": { "type": "string", "description": "Download URL of the executed copy, with every signature and the signing certificate attached" }, "certificate": { "type": "string", "description": "Download URL of the signing certificate: who signed, how they were verified, when, from where, and the document hash at each step" }, "filing": { "type": "object", "properties": { "id": { "type": "string" }, "registry_reference": { "type": "string" }, "submitted_at": { "type": "integer" }, "accepted_at": { "type": "integer" } } } }, "required": [ "id", "object", "purpose" ] }, "SignatureRequest": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^sig_" }, "object": { "const": "signature_request" }, "action": { "type": "string" }, "document": { "type": "string" }, "signer": { "type": "string" }, "method": { "enum": [ "none", "click_consent", "electronic", "advanced_electronic", "qualified_electronic", "registry_authentication", "wet_ink", "wet_ink_witnessed", "wet_ink_notarised", "wet_ink_notarised_apostilled" ] }, "agent_signing": { "enum": [ "agent_may_sign", "agent_may_sign_with_mandate", "human_only_electronic", "human_wet_ink" ] }, "signs_for": { "enum": [ "entity", "self" ], "description": "entity: checked against the entity's signing authority; self: the signer personally" }, "person": { "type": "string", "pattern": "^per_", "description": "Who must sign: resolved from the action's people and the entity's signing authority" }, "requested_by": { "type": "object", "properties": { "user": { "type": "string" }, "api_key": { "type": "string" }, "mandate": { "type": "string" } }, "description": "Who sent it: a user, or an agent under a mandate" }, "delivery": { "type": "object", "properties": { "channels": { "type": "array", "items": { "enum": [ "email", "sms", "in_app", "embedded", "courier", "notary_appointment" ] } }, "message": { "type": "string" }, "sent_at": { "type": "integer" }, "viewed_at": { "type": "integer" }, "reminders": { "type": "array", "items": { "type": "integer" } } } }, "due_by": { "type": "integer", "description": "From the action's statutory deadline; reminders run automatically before it" }, "status": { "enum": [ "pending", "sent", "viewed", "signed", "courier_in_transit", "notarising", "declined", "expired" ] }, "sign_url": { "type": "string", "description": "Hosted signing page. The signer verifies (or re-verifies) at the level the method needs, reviews the document and signs" }, "signed_at": { "type": "integer" }, "signed_by": { "enum": [ "person", "agent", "registered_agent" ] }, "evidence": { "type": "object", "properties": { "verification": { "type": "string", "pattern": "^ver_" }, "ip": { "type": "string" }, "user_agent": { "type": "string" }, "document_sha256": { "type": "string" }, "notary": { "type": "string" }, "courier_tracking": { "type": "string" } }, "description": "What proves the signature; also printed on the document's signing certificate" }, "declined_reason": { "type": "string" } }, "required": [ "id", "object", "method", "agent_signing", "status" ] }, "Mandate": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^man_" }, "object": { "const": "mandate" }, "grantor": { "type": "string", "description": "Person who authorises the agent" }, "entities": { "type": "array", "items": { "type": "string" } }, "action_types": { "type": "array", "items": { "type": "string" }, "description": "Glob patterns, e.g. hk.director.*" }, "spend_limit": { "$ref": "#/components/schemas/Money" }, "approval_required_above": { "$ref": "#/components/schemas/Money" }, "signing_authority": { "enum": [ "none", "electronic_where_permitted" ] }, "expires_at": { "type": "string", "format": "date-time" }, "power_of_attorney": { "type": "string", "description": "Document id when the law needs one" }, "grantor_authority": { "type": "string", "pattern": "^auth_", "description": "The grantor's authority over the entities; a mandate cannot reach beyond it" }, "status": { "enum": [ "pending_signature", "active", "revoked", "expired" ] } }, "required": [ "id", "object", "grantor", "action_types", "status" ] }, "WebhookEndpoint": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^wh_" }, "object": { "const": "webhook_endpoint" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "secret": { "type": "string" } }, "required": [ "id", "object", "url", "events" ] }, "Deadline": { "type": "object", "properties": { "action_type": { "type": "string" }, "title": { "type": "string" }, "due": { "type": "string", "format": "date" }, "penalty": { "type": "string" }, "included_in_plan": { "type": "boolean" } }, "required": [ "action_type", "due" ] }, "Params_hk_business_branch_register": { "type": "object", "properties": { "branch_name_english": { "type": "string", "description": "Name under which the branch is carried on." }, "branch_name_chinese": { "type": "string", "description": "Chinese branch name, traditional characters." }, "branch_address": { "$ref": "#/components/schemas/Address", "description": "Branch address, at most 90 English or 58 Chinese characters including spaces and punctuation." }, "nature_of_business": { "type": "string", "description": "Description and nature of the branch's business." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the branch started; not in the future." }, "signatory": { "type": "string", "pattern": "^per_", "description": "The proprietor, or a partner of the main business, who signs Form 1." } }, "required": [ "branch_address", "nature_of_business", "commencement_date", "signatory" ], "description": "Registers a branch of an existing sole proprietorship or partnership with the Inland Revenue Department on Form 1, within one month of the branch starting. The branch certificate expires with the main business's certificate." }, "Create_hk_business_branch_register": { "type": "object", "properties": { "type": { "const": "hk.business_branch.register" }, "params": { "$ref": "#/components/schemas/Params_hk_business_branch_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a branch of a Hong Kong business", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_1d", "title": "IRD Form 1: application for registration of branch business", "source": "generated", "required": true }, { "key": "branch_registration_certificate", "title": "Branch Registration Certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "form_1d", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Form 1", "channel": "both", "government_fee": { "amount": 230, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_registered", "type": null, "when": "[requirement_error] The main business has no business registration number yet." }, { "code": "commencement_in_future", "type": null, "when": "[invalid_request_error] The branch has not started." }, { "code": "branch_registration_late", "type": null, "when": "[requirement_error] More than one month after commencement." }, { "code": "address_too_long", "type": null, "when": "[invalid_request_error] Over 90 English or 58 Chinese characters." }, { "code": "signatory_not_authorised", "type": null, "when": "[permission_error] The signatory is not the proprietor or a partner of the main business." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert on the entity pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign Form 1 or log in to eTAX." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The IRD rejected the application." } ] } }, "Params_hk_business_registration_particulars_notify": { "type": "object", "properties": { "commencement_date": { "type": "string", "format": "date", "description": "Date business commenced; the one-month deadline runs from it." }, "business_name_en": { "type": "string", "description": "English business name." }, "business_name_zh": { "type": "string", "description": "Chinese business name." }, "business_description": { "type": "string", "description": "Description and nature of the business; the incorporation form's nature of business is not passed to the BR Office." }, "business_address": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address where the business is carried on; may be the registered office." }, "submission_format": { "type": "string", "enum": [ "form_irbr200", "letter" ], "description": "Prescribed form or letter; the CR accepts both." } }, "required": [ "commencement_date", "business_description", "business_address" ], "description": "Notifies the IRD Business Registration Office of a new local company's business name, nature of business, address and start date. The CR issues the BR certificate and number with the certificate of incorporation, so this notice is the only." }, "Create_hk_business_registration_particulars_notify": { "type": "object", "properties": { "type": { "const": "hk.business_registration_particulars.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_business_registration_particulars_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify business particulars to the Business Registration Office", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "business_particulars_notice", "title": "Notification of business particulars", "source": "generated", "required": true }, { "key": "business_registration_certificate", "title": "Business registration certificate issued with the certificate of incorporation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "business_particulars_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Form IRBR200", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "commencement_date_in_future", "type": null, "when": "invalid_request_error: commencement_date is after today." }, { "code": "business_registration_missing", "type": null, "when": "requirement_error: the entity has no BR number because incorporation has not completed." }, { "code": "btp_appointment_missing", "type": null, "when": "requirement_error: Entiva is not appointed on the company's Business Tax Portal; use letter or complete the appointment." }, { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: not a local Cap. 622 company." } ] } }, "Params_hk_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares" ], "description": "Private: restricts share transfers, at most 50 members, no public invitation, needs 1+ director who is a natural person." }, "name_en": { "type": "string", "description": "Proposed English name; must equal the name clause of the articles and end with 'Limited'.", "examples": [ "Lantau Robotics Limited" ] }, "name_zh": { "type": "string", "description": "Proposed Chinese name in traditional characters." }, "nature_of_business": { "type": "string", "description": "{description: string, code: string}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong street address, effective on incorporation." }, "contact_email": { "type": "string", "description": "Company email for CR communications." }, "contact_phone_hk": { "type": "string", "description": "Hong Kong contact telephone in +852 format." }, "share_capital": { "type": "array", "items": {}, "description": "One item per share class: {class: string e.g. 'ordinary', number_of_shares: integer, currency: ISO 4217, amount_subscribed: money, amount_paid_up: money." }, "share_class_rights": { "type": "array", "items": {}, "description": "Required when more than one class: {class, voting_rights, dividend_rights, capital_rights, redeemable: boolean}." }, "founder_members": { "type": "array", "items": {}, "description": "{person: person_ref, shares: [{class, number_of_shares, amount: money}]}." }, "signing_founder_member": { "type": "string", "pattern": "^per_", "description": "The founder member who signs NNC1." }, "directors": { "type": "array", "items": {}, "description": "{person: person_ref, consent_method: 'in_form' | 'nnc3', correspondence_address: address}." }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "{provider: 'entiva_partner' | 'person', person: person_ref, tcsp_licence_number: string, tcsp_exemption_reason: string}." }, "articles": { "type": "object", "description": "{source: 'entiva_sample' | 'custom_upload', document: document_ref}." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "IRBR1 election for the business registration certificate term." }, "controllers": { "type": "array", "items": {}, "description": "Anyone who owns or controls the company beyond what the share allotments show: {person: person_ref, ownership_percent: number, voting_percent: number." }, "uses_nominees": { "type": "boolean", "description": "True if any director or shareholder acts as nominee." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business (AMLO Sch. 2 s.2); drives the customer risk rating." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes of the countries the company will deal with." }, "presentor_reference": { "type": "string", "description": "Free-text reference printed in the NNC1 presentor box." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "contact_email", "share_capital", "founder_members", "directors", "business_purpose", "countries_of_operation" ], "description": "Incorporates a private or public company limited by shares with the Companies Registry on Form NNC1, with the IRBR1 business registration notice and articles of association in one submission. Entiva's Entiva is presentor, company." }, "Create_hk_company_incorporate": { "type": "object", "properties": { "type": { "const": "hk.company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_hk_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Hong Kong company limited by shares", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares", "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "articles_signed_original", "title": "Articles signed by all founder members", "source": "generated", "required": true }, { "key": "incorporation_form_nnc1", "title": "Form NNC1 as filed", "source": "generated", "required": true }, { "key": "pi_nnc1_sheet", "title": "PI-NNC1 protected information sheets", "source": "generated", "required": true }, { "key": "notice_irbr1", "title": "Notice to Business Registration Office", "source": "generated", "required": true }, { "key": "corporate_party_documents", "title": "Corporate founder or director documents", "source": "uploaded", "required": false }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution naming the signatory", "source": "uploaded", "required": false }, { "key": "source_of_wealth", "title": "Source of wealth and source of funds evidence", "source": "uploaded", "required": false }, { "key": "nominee_agreement", "title": "Nominee agreement or declaration of trust", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Certificate of Incorporation", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true }, { "key": "statutory_registers", "title": "Registers of members, directors and secretaries", "source": "generated", "required": true }, { "key": "significant_controllers_register", "title": "Significant controllers register", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true } ], "people": [ { "role": "incorporator", "verification_level": "identity" }, { "role": "incorporator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "incorporation_form_nnc1", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "articles_signed_original", "signer_role": "incorporator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_irbr1", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, e-Services Portal e-Incorporation, with one-stop business registration", "form": "NNC1 with IRBR1, articles of association and PI-NNC1 sheet", "channel": "online", "government_fee": { "amount": 1545, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "[registry_error] The name matches an existing name in the Index of Company Names or a body corporate under an Ordinance, or another applicant registered it first." }, { "code": "name_rule_violation", "type": null, "when": "[invalid_request_error] English name does not end with 'Limited', mixed scripts, simplified Chinese, or names in the form and the articles differ." }, { "code": "name_requires_approval", "type": null, "when": "[requirement_error] Name contains a Cap. 622A restricted word or suggests a government connection; Registrar approval is needed first." }, { "code": "director_requirements_not_met", "type": null, "when": "[invalid_request_error] Private company without a natural-person director, public company with fewer than 2, or a body-corporate director where not allowed." }, { "code": "secretary_requirements_not_met", "type": null, "when": "[invalid_request_error] No secretary, individual secretary not resident in Hong Kong, body corporate without a Hong Kong office, or sole director also named secretary." }, { "code": "tcsp_licence_missing", "type": null, "when": "[jurisdiction_error] A customer-supplied secretary has neither a TCSP licence number nor an exemption reason." }, { "code": "registered_office_invalid", "type": null, "when": "[invalid_request_error] Address is outside Hong Kong, 'care of' or a PO box." }, { "code": "share_capital_inconsistent", "type": null, "when": "[invalid_request_error] Paid up plus unpaid differs from subscribed, or founder allotments differ from the class totals." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] A founder, director, controller or instructing person is not yet verified at the required level." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] An open screening alert on anyone involved pauses the live action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign NNC1, a consent to act, or complete a selfie or government login." }, { "code": "mandate_scope_exceeded", "type": null, "when": "[permission_error] The agent's mandate does not cover hk.company.incorporate or the spend exceeds its limit." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The CR rejected the form." } ] } }, "Params_hk_company_name_check": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "description": "Entity type the name is for." }, "name_en": { "type": "string", "description": "Full proposed English name exactly as it would be registered, including the ending.", "examples": [ "Lantau Robotics Limited" ] }, "name_zh": { "type": "string", "description": "Proposed Chinese name in traditional characters." }, "include_similar_names": { "type": "boolean", "description": "Default true." } }, "required": [ "entity_type" ], "description": "Runs the Companies Registry's free Exact Name Search and Left Partial Search on a proposed English and/or traditional Chinese name and tests it against the published naming rules. Hong Kong has no name reservation: the result is advisory." }, "Create_hk_company_name_check": { "type": "object", "properties": { "type": { "const": "hk.company_name.check" }, "params": { "$ref": "#/components/schemas/Params_hk_company_name_check" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Check a Hong Kong company name", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_check_report", "title": "Name check report", "source": "generated", "required": true } ], "people": [], "approvals": [], "signatures": [ { "document_key": "name_check_report", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "None", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "no_name_supplied", "type": null, "when": "[invalid_request_error] Neither english_name nor chinese_name was provided." }, { "code": "name_rule_violation", "type": null, "when": "[invalid_request_error] The English name does not end with 'Limited', or letters and Chinese characters are mixed in one name, or simplified Chinese was used." }, { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type is not a company type." }, { "code": "registry_unavailable", "type": null, "when": "[registry_error] The Companies Registry search service did not answer." } ] } }, "Params_hk_company_name_approval_request": { "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "incorporation", "change_of_name" ], "description": "New company or change of name." }, "name_en": { "type": "string", "description": "English name; ends in Limited, not Ltd; no Chinese characters in it." }, "name_zh": { "type": "string", "description": "Chinese name in traditional characters." }, "approval_basis": { "type": "string", "enum": [ "listed_word_or_expression", "suggests_government_connection", "other" ], "description": "Why approval is needed; Entiva detects it, set only to override." }, "justification": { "type": "string", "description": "Why the name is appropriate: the business it describes or the authority to use it." }, "applicant": { "type": "string", "pattern": "^per_", "description": "Applicant: founder member, or a director or the secretary of an existing company." }, "applicant_role": { "type": "string", "enum": [ "founder_member", "director", "company_secretary" ], "description": "Applicant's capacity." } }, "required": [ "purpose", "justification", "applicant", "applicant_role" ], "description": "CR guidance describes no name reservation: a name is secured only when the certificate is issued. But a name with a word listed in the Companies Order, or suggesting a connection with the Central People's Government, the HKSAR Government." }, "Create_hk_company_name_approval_request": { "type": "object", "properties": { "type": { "const": "hk.company_name_approval.request" }, "params": { "$ref": "#/components/schemas/Params_hk_company_name_approval_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for the Registrar's approval of a restricted company name (Cap. 622 s.100)", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_approval_application", "title": "Written application to the Registrar for approval of the name", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence supporting use of the word", "source": "uploaded", "required": false }, { "key": "name_approval_letter", "title": "Registrar's written approval", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "name_approval_application", "signer_role": "applicant", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Written application for approval under Companies Ordinance s.100", "channel": "paper", "government_fee": { "amount": 850, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "approval_not_required", "type": null, "when": "invalid_request_error: no listed word and no government connection; refused to save the HK$850 fee." }, { "code": "name_not_available", "type": null, "when": "invalid_request_error: the name equals one in the CR Index of Company Names; approval does not override that." }, { "code": "name_format_invalid", "type": null, "when": "invalid_request_error: mixed English and Chinese characters, Ltd instead of Limited, or simplified Chinese." } ] } }, "Params_hk_cooperative_society_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cooperative_society" ], "description": "Entity type." }, "name_en": { "type": "string", "description": "English name with the required co-operative designation, and Limited if liability is limited." }, "name_zh": { "type": "string", "description": "Chinese name." }, "liability": { "type": "string", "enum": [ "limited", "unlimited" ], "description": "Limited or unlimited liability." }, "society_kind": { "type": "string", "enum": [ "credit", "agricultural", "fishermen", "housing", "other" ], "description": "Kind of co-operative, for the record." }, "objects": { "type": "string", "description": "Objects and the members' economic interests promoted." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Address in Hong Kong." }, "applicants": { "type": "array", "items": {}, "description": "At least 10 qualified persons who sign; or use member_societies." }, "member_societies": { "type": "array", "items": {}, "description": "Registered societies applying as members, each {society, authorised_person} (s.6)." }, "proposed_by_laws": { "type": "string", "pattern": "^doc_", "description": "Proposed by-laws filed with the application (s.6)." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "entity_type", "liability", "objects", "registered_office", "applicants", "proposed_by_laws", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "At least 10 qualified persons, or authorised persons of member societies, apply to the Registrar of Co-operative Societies for registration with or without limited liability, filing proposed by-laws. Registration makes the society a body." }, "Create_hk_cooperative_society_register": { "type": "object", "properties": { "type": { "const": "hk.cooperative_society.register" }, "params": { "$ref": "#/components/schemas/Params_hk_cooperative_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a co-operative society", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Application for registration to the Registrar of Co-operative Societies", "source": "generated", "required": true }, { "key": "proposed_by_laws", "title": "Proposed by-laws", "source": "uploaded", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "applicant", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Co-operative Societies", "form": "Application for registration with proposed by-laws", "channel": "paper", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "applicants_below_minimum", "type": null, "when": "invalid_request_error: fewer than 10 applicants and no member society." }, { "code": "by_laws_missing", "type": null, "when": "requirement_error: no proposed by-laws uploaded." }, { "code": "name_designation_missing", "type": null, "when": "invalid_request_error: the name lacks the co-operative designation, or Limited for limited liability." }, { "code": "government_fee_unconfirmed", "type": null, "when": "requirement_error: the fee under the Rules is unknown; Entiva confirms it with the Registrar before the quote can be approved." } ] } }, "Params_hk_first_director_consent_file": { "type": "object", "properties": { "director": { "type": "string", "pattern": "^per_", "description": "The first director who is giving consent." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Required when the director is a body corporate: its director, company secretary or authorised person, whose full name is stated on the form." } }, "required": [ "director" ], "description": "Files Form NNC3 for a first director who did not sign the consent to act in the incorporation form. It must reach the Companies Registry within 15 days after incorporation." }, "Create_hk_first_director_consent_file": { "type": "object", "properties": { "type": { "const": "hk.first_director_consent.file" }, "params": { "$ref": "#/components/schemas/Params_hk_first_director_consent_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a first director's consent to act", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_nnc3", "title": "Form NNC3: Consent to Act as First Director", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "form_nnc3", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NNC3", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "not_a_first_director", "type": null, "when": "[invalid_request_error] The person was not named as a first director of this company." }, { "code": "consent_already_filed", "type": null, "when": "[invalid_request_error] The director signed in the incorporation form or an NNC3 is already on file." }, { "code": "deadline_passed", "type": null, "when": "[requirement_error] More than 15 days after incorporation." }, { "code": "signatory_required", "type": null, "when": "[invalid_request_error] The director is a body corporate and no signatory is named." }, { "code": "verification_incomplete", "type": null, "when": "" }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign the consent." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The CR rejected NNC3." } ] } }, "Params_hk_general_partnership_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "general_partnership" ], "description": "Always general_partnership." }, "partners": { "type": "array", "items": {}, "description": "{person: person_ref, profit_share_percent: number, capital_share_percent: number}." }, "signing_partner": { "type": "string", "pattern": "^per_", "description": "The partner who signs Form 1 and certifies that all partners are listed." }, "business_name_english": { "type": "string", "description": "Must not suggest limited liability or a government connection." }, "business_name_chinese": { "type": "string", "description": "Chinese business name, traditional characters." }, "place_of_business": { "$ref": "#/components/schemas/Address", "description": "At most 90 English or 58 Chinese characters including spaces and punctuation." }, "nature_of_business": { "type": "string", "description": "Description and nature of the business." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the business started; not in the future." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "Certificate term; default '1'." }, "resident_agent": { "type": "string", "pattern": "^per_", "description": "Required if all partners live outside Hong Kong: a resident individual appointed by IRBR177 or letter signed by a partner and the agent." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." } }, "required": [ "entity_type", "partners", "signing_partner", "place_of_business", "nature_of_business", "commencement_date", "business_purpose", "countries_of_operation" ], "description": "Registers a general partnership with the Inland Revenue Department on Form 1, within one month of the business starting. This creates the partnership as an Entiva entity." }, "Create_hk_general_partnership_register": { "type": "object", "properties": { "type": { "const": "hk.general_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_hk_general_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Hong Kong general partnership for business registration", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_1c", "title": "IRD Form 1: application by a partnership for business registration", "source": "generated", "required": true }, { "key": "partner_identity_document_copies", "title": "Copies of each partner's ID or passport", "source": "uploaded", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "resident_agent_appointment", "title": "IRBR177 or appointment letter", "source": "generated", "required": false }, { "key": "corporate_party_documents", "title": "Corporate partner documents", "source": "uploaded", "required": false }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true }, { "key": "partnership_consent", "title": "Partnership consent", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "identity" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "form_1c", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "partnership_consent", "signer_role": "partner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "resident_agent_appointment", "signer_role": "registered_agent", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Form 1", "channel": "both", "government_fee": { "amount": 2350, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "partners_incomplete", "type": null, "when": "[invalid_request_error] Fewer than two partners, or the shares do not add to 100%." }, { "code": "commencement_in_future", "type": null, "when": "[invalid_request_error] The business has not started." }, { "code": "business_registration_late", "type": null, "when": "[requirement_error] More than one month after commencement; offence; back-year fees after 12 months." }, { "code": "business_name_not_allowed", "type": null, "when": "[invalid_request_error] The name suggests limited liability or a government connection." }, { "code": "address_too_long", "type": null, "when": "[invalid_request_error] Over 90 English or 58 Chinese characters." }, { "code": "resident_agent_required", "type": null, "when": "[requirement_error] All partners are non-resident and no agent is named." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] A partner is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign Form 1 or log in to eTAX." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The IRD rejected the application." } ] } }, "Params_hk_guarantee_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "guarantee_company" ], "description": "Always guarantee_company for this action." }, "name_en": { "type": "string", "description": "Proposed English name; must equal the name clause of the articles and end with 'Limited'." }, "name_zh": { "type": "string", "description": "Proposed Chinese name in traditional characters." }, "nature_of_business": { "type": "string", "description": "{description: string, code: string}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong street address." }, "contact_email": { "type": "string", "description": "Company email for CR communications." }, "contact_phone_hk": { "type": "string", "description": "Hong Kong contact telephone in +852 format." }, "number_of_members": { "type": "integer", "description": "Number of members the company proposes to register with." }, "member_classes": { "type": "array", "items": {}, "description": "{class_name: string, guarantee_amount: money}." }, "founder_members": { "type": "array", "items": {}, "description": "{person: person_ref}." }, "signing_founder_member": { "type": "string", "pattern": "^per_", "description": "Founder who signs NNC1G." }, "directors": { "type": "array", "items": {}, "description": "{person: person_ref, consent_method: 'in_form' | 'nnc3', correspondence_address: address}." }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "{provider: 'entiva_partner' | 'person', person: person_ref, tcsp_licence_number: string, tcsp_exemption_reason: string}." }, "articles": { "type": "object", "description": "{source: 'entiva_sample' | 'custom_upload', document: document_ref}." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "IRBR1 election; default '1'." }, "controllers": { "type": "array", "items": {}, "description": "{person: person_ref, voting_percent: number, appoints_board_majority: boolean, significant_influence_or_control: boolean}." }, "uses_nominees": { "type": "boolean", "description": "True if any director or member acts as nominee." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business or activities (AMLO Sch. 2 s.2)." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "contact_email", "number_of_members", "member_classes", "founder_members", "directors", "business_purpose", "countries_of_operation" ], "description": "Incorporates a company limited by guarantee without a share capital on Form NNC1G with IRBR1 and articles. Members undertake to contribute up to a stated amount on a winding up." }, "Create_hk_guarantee_company_incorporate": { "type": "object", "properties": { "type": { "const": "hk.guarantee_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_hk_guarantee_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Hong Kong company limited by guarantee", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "guarantee_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "articles_signed_original", "title": "Articles signed by all founder members", "source": "generated", "required": true }, { "key": "incorporation_form_nnc1g", "title": "Form NNC1G as filed", "source": "generated", "required": true }, { "key": "pi_nnc1g_sheet", "title": "PI-NNC1G protected information sheets", "source": "generated", "required": true }, { "key": "notice_irbr1", "title": "Notice to Business Registration Office", "source": "generated", "required": true }, { "key": "corporate_party_documents", "title": "Corporate founder documents", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution naming the signatory", "source": "uploaded", "required": false }, { "key": "source_of_wealth", "title": "Source of wealth and funds evidence", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Certificate of Incorporation", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true }, { "key": "statutory_registers", "title": "Registers of members, directors and secretaries", "source": "generated", "required": true }, { "key": "significant_controllers_register", "title": "SCR", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true } ], "people": [ { "role": "incorporator", "verification_level": "identity" }, { "role": "incorporator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "officer", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "incorporation_form_nnc1g", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "articles_signed_original", "signer_role": "incorporator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_irbr1", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, e-Services Portal e-Incorporation, with one-stop business registration", "form": "NNC1G with IRBR1, articles of association and PI-NNC1G sheet", "channel": "online", "government_fee": { "amount": 155, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "[registry_error] Name clashes with the Index of Company Names or a body corporate under an Ordinance." }, { "code": "name_rule_violation", "type": null, "when": "[invalid_request_error] Wrong ending, mixed scripts, simplified Chinese, or form and articles differ." }, { "code": "name_requires_approval", "type": null, "when": "[requirement_error] Cap. 622A restricted word or government-connection name." }, { "code": "director_requirements_not_met", "type": null, "when": "[invalid_request_error] Fewer than 2 directors, or a body-corporate director." }, { "code": "secretary_requirements_not_met", "type": null, "when": "[invalid_request_error] No secretary, non-resident individual secretary, or body corporate without a Hong Kong office." }, { "code": "member_count_invalid", "type": null, "when": "[invalid_request_error] number_of_members is below the number of founder members or is not a number." }, { "code": "guarantee_amount_missing", "type": null, "when": "[invalid_request_error] A member class has no guarantee amount." }, { "code": "registered_office_invalid", "type": null, "when": "[invalid_request_error] Non-Hong Kong, 'care of' or PO box address." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] Someone is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open screening alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign or complete a selfie." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The CR rejected the form." } ] } }, "Params_hk_limited_partnership_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "Always limited_partnership." }, "firm_name": { "type": "string", "description": "The firm name on Form 1." }, "general_nature_of_business": { "type": "string", "description": "General nature of the business, as written on Form 1." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal place of business." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the partnership starts." }, "term_years": { "type": "integer", "description": "Definite term in years, if any." }, "term_conditions": { "type": "string", "description": "If there is no definite term, the conditions of existence of the partnership." }, "general_partners": { "type": "array", "items": {}, "description": "{person: person_ref}." }, "limited_partners": { "type": "array", "items": {}, "description": "{person: person_ref, contribution: money, contribution_form: 'cash' | 'other', contribution_description: string}." }, "register_business": { "type": "boolean", "description": "Default true." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "Business registration certificate term for Form 1; default '1'." }, "signing_partner_for_business_registration": { "type": "string", "pattern": "^per_", "description": "The partner who signs Form 1." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "firm_name", "general_nature_of_business", "principal_place_of_business", "commencement_date", "general_partners", "limited_partners", "business_purpose", "countries_of_operation", "name", "nature_of_business", "beneficial_owners" ], "description": "Registers a limited partnership under the Limited Partnerships Ordinance on Form 1, signed by all partners, and then registers the business with the Inland Revenue Department on Form 1. Fees depend on each limited partner's contribution." }, "Create_hk_limited_partnership_register": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Hong Kong limited partnership", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_1_cap37", "title": "Form 1: Application for registration of a limited partnership", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "corporate_party_documents", "title": "Corporate partner documents", "source": "uploaded", "required": false }, { "key": "form_1c_business_registration", "title": "IRD Form 1 business registration application", "source": "generated", "required": false }, { "key": "certificate_of_registration_lp", "title": "Certificate of Registration of a Limited Partnership", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "partner", "verification_level": "identity" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "form_1_cap37", "signer_role": "partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_1c_business_registration", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form 1", "channel": "both", "government_fee": { "amount": 340, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "partners_incomplete", "type": null, "when": "[invalid_request_error] No general partner or no limited partner." }, { "code": "contribution_missing", "type": null, "when": "[invalid_request_error] A limited partner has no contribution amount or form." }, { "code": "signature_pack_incomplete", "type": null, "when": "[requirement_error] A partner's wet-ink signature has not been received." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] A partner over 25%, or a general partner, is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign Form 1 or Form 1." }, { "code": "business_registration_late", "type": null, "when": "[requirement_error] More than one month after commencement; late business registration is an offence." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The CR rejected Form 1." } ] } }, "Params_hk_limited_partnership_fund_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lpf" ], "description": "Always limited_partnership_fund." }, "name_en": { "type": "string", "description": "Must end with 'Limited Partnership Fund' or 'LPF'.", "examples": [ "Tai Tam Growth LPF" ] }, "name_zh": { "type": "string", "description": "Must end with the six characters 有限合夥基金." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong office for communications and notices; no 'care of' or PO box." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Proposed principal place of business, any country." }, "investment_scope": { "type": "string", "description": "Proposed investment scope of the fund." }, "contact_email": { "type": "string", "description": "Fund email for CR communications." }, "contact_phone_hk": { "type": "string", "description": "Hong Kong contact telephone, +852." }, "general_partner": { "type": "object", "description": "{person: person_ref, gp_type: 'natural_person' | 'hk_private_company' | 'registered_non_hk_company' | 'redomiciled_private_company' |." }, "authorised_representative": { "type": "object", "description": "{person: person_ref}." }, "investment_managers": { "type": "array", "items": {}, "description": "{person: person_ref, sfc_licence: string}." }, "responsible_person": { "type": "object", "description": "{person: person_ref, category: 'authorized_institution' | 'licensed_corporation' | 'accounting_professional' | 'legal_professional'}." }, "limited_partners": { "type": "array", "items": {}, "description": "{person: person_ref, committed_contribution: money}." }, "all_partners_same_group": { "type": "boolean", "description": "True if all partners are corporations in the same group." }, "records_location": { "type": "object", "description": "{mode: 'registered_office' | 'other_hk_address' | 'separate', address: address, per_record: [{record, address}]}." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "IRBR4 election; default '1'." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the fund." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "investment_scope", "contact_email", "general_partner", "investment_managers", "responsible_person", "limited_partners", "business_purpose", "countries_of_operation", "nature_of_business", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a fund as a limited partnership fund under the Limited Partnership Fund Ordinance on Form LPF1 with IRBR4, with simultaneous business registration. The application must be submitted for the general partner by a Hong Kong law firm." }, "Create_hk_limited_partnership_fund_register": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership_fund.register" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_fund_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Hong Kong limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_lpf1", "title": "Form LPF1: Application for Registration of Limited Partnership Fund", "source": "generated", "required": true }, { "key": "notice_irbr4", "title": "Notice to Business Registration Office", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Limited partnership agreement", "source": "uploaded", "required": true }, { "key": "law_firm_engagement_letter", "title": "Law firm engagement letter", "source": "generated", "required": true }, { "key": "corporate_party_documents", "title": "Corporate GP and partner documents", "source": "uploaded", "required": false }, { "key": "licence_evidence", "title": "Investment manager and responsible person status evidence", "source": "uploaded", "required": false }, { "key": "source_of_wealth", "title": "Source of wealth and funds evidence", "source": "uploaded", "required": false }, { "key": "certificate_of_registration_lpf", "title": "Certificate of Registration of the fund", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true }, { "key": "register_of_partners", "title": "Register of partners and controller records", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "form_lpf1", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_lpf1", "signer_role": "authorised_representative", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "law_firm_engagement_letter", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_irbr4", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "LPF1 with IRBR4", "channel": "both", "government_fee": { "amount": 3034, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_rule_violation", "type": null, "when": "[invalid_request_error] English name does not end with 'Limited Partnership Fund' or 'LPF', or Chinese name does not end with 有限合夥基金." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] Name duplicates one in the LPF index, the limited partnership index, or a body corporate name under an Ordinance." }, { "code": "gp_type_not_eligible", "type": null, "when": "[jurisdiction_error] General partner is not one of the eight permitted types, or a natural person under 18." }, { "code": "authorized_representative_required", "type": null, "when": "[invalid_request_error] GP is another LPF or a non-Hong Kong limited partnership without legal personality and no representative is given." }, { "code": "responsible_person_not_eligible", "type": null, "when": "[jurisdiction_error] Responsible person is not an authorised institution, licensed corporation, accounting professional or legal professional." }, { "code": "fund_not_eligible", "type": null, "when": "[jurisdiction_error] Not exactly one GP plus at least one limited partner, or all partners are in one group without the section 10 declaration." }, { "code": "registered_office_invalid", "type": null, "when": "[invalid_request_error] Non-Hong Kong, 'care of' or PO box address." }, { "code": "law_firm_not_engaged", "type": null, "when": "[requirement_error] No signed engagement letter; only a Hong Kong law firm or solicitor may submit." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] A GP, manager, responsible person or owner over 25% is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign LPF1 or give a declaration." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] CR rejected LPF1; the HK$479 lodgement fee is not refunded." } ] } }, "Params_hk_open_ended_fund_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "open_ended_fund_company" ], "description": "Always open_ended_fund_company." }, "name_en": { "type": "string", "description": "Must end with 'Open-ended Fund Company' or 'OFC'." }, "name_zh": { "type": "string", "description": "Must end with 開放式基金型公司." }, "ofc_kind": { "type": "string", "enum": [ "private", "public" ], "description": "Public OFCs also need SFC authorisation, processed together with registration." }, "structure": { "type": "string", "enum": [ "standalone", "umbrella" ], "description": "Umbrella OFCs have sub-funds." }, "sub_funds": { "type": "array", "items": {}, "description": "Required for umbrella: {name_english: string, name_chinese: string}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address; no non-Hong Kong, 'care of' or PO box address." }, "contact_email": { "type": "string", "description": "OFC email for CR communications." }, "contact_phone_hk": { "type": "string", "description": "Hong Kong contact telephone, +852." }, "directors": { "type": "array", "items": {}, "description": "{person: person_ref, usual_residential_address: address}." }, "process_agents": { "type": "array", "items": {}, "description": "Required for any director whose usual residential address is outside Hong Kong: {person: person_ref, directors_served: [person_ref]}." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "The first director who signs OFCNC1 and the Statement of Director, authorised by the others." }, "investment_manager": { "type": "object", "description": "{person: person_ref, sfc_central_entity_number: string}." }, "custodian": { "type": "object", "description": "{person: person_ref, sfc_approval_reference: string}." }, "instrument_of_incorporation": { "type": "object", "description": "{source: 'entiva_template' | 'upload', document: document_ref}." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "IRBR3 election; default '1'." }, "business_purpose": { "type": "string", "description": "Investment objective and intended nature of the fund." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "ofc_kind", "structure", "contact_email", "directors", "signing_director", "investment_manager", "custodian", "business_purpose", "countries_of_operation", "nature_of_business", "shareholders", "share_classes", "beneficial_owners" ], "description": "Forms an open-ended fund company in two registry stages through one SFC-led submission: SFC registration under the Securities and Futures Ordinance, then Companies Registry incorporation on Form OFCNC1 with the instrument of incorporation." }, "Create_hk_open_ended_fund_company_incorporate": { "type": "object", "properties": { "type": { "const": "hk.open_ended_fund_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_hk_open_ended_fund_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register and incorporate a Hong Kong open-ended fund company", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "sfc_application_form", "title": "SFC OFC registration application form and information checklist", "source": "generated", "required": true }, { "key": "instrument_of_incorporation", "title": "Instrument of incorporation", "source": "generated", "required": true }, { "key": "form_ofcnc1_sfc", "title": "Form OFCNC1: Incorporation Form", "source": "generated", "required": true }, { "key": "notice_irbr3", "title": "Notice to Business Registration Office", "source": "generated", "required": true }, { "key": "sfc_authorisation_documents", "title": "SFC authorisation documents", "source": "uploaded", "required": false }, { "key": "manager_custodian_evidence", "title": "Investment manager licence and custodian eligibility evidence", "source": "uploaded", "required": true }, { "key": "corporate_party_documents", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "law_firm_engagement_letter", "title": "Fund counsel engagement letter", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_ofc", "title": "Certificate of Incorporation of OFC", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "process_agent", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity" }, { "role": "custodian", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "form_ofcnc1_sfc", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_ofcnc1_sfc", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "instrument_of_incorporation", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "law_firm_engagement_letter", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_irbr3", "signer_role": "lawyer", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission", "form": "SFC registration application and information checklist, Form OFCNC1", "channel": "both", "government_fee": { "amount": 3034, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_rule_violation", "type": null, "when": "[invalid_request_error] Name does not end with 'Open-ended Fund Company', 'OFC' or 開放式基金型公司." }, { "code": "name_not_approved", "type": null, "when": "[registry_error] The SFC found the name misleading, undesirable or the same as an existing OFC." }, { "code": "director_requirements_not_met", "type": null, "when": "[invalid_request_error] Fewer than 2 directors, a body-corporate director, or a director under 18." }, { "code": "process_agent_required", "type": null, "when": "[invalid_request_error] A director lives outside Hong Kong and no process agent is named." }, { "code": "manager_or_custodian_not_eligible", "type": null, "when": "[jurisdiction_error] Investment manager is not SFC-licensed or registered for asset management, or the custodian is not SFC-approvable." }, { "code": "sub_funds_missing", "type": null, "when": "[invalid_request_error] structure is umbrella and no sub-funds are given." }, { "code": "registered_office_invalid", "type": null, "when": "[invalid_request_error] Non-Hong Kong, 'care of' or PO box address." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] A director, manager or owner over 25% is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign OFCNC1 or the instrument." }, { "code": "sfc_rejected", "type": null, "when": "[registry_error] The SFC refused registration or authorisation." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The CR rejected OFCNC1 after SFC approval." } ] } }, "Params_hk_registered_trustees_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_trustees_corporation" ], "description": "Entity type." }, "title_en": { "type": "string", "description": "English title; must contain Trustees and Incorporated." }, "title_zh": { "type": "string", "description": "Chinese title; must contain 受託人 and 法團." }, "body_name": { "type": "string", "description": "Name of the body of persons or charity." }, "body_kind": { "type": "string", "enum": [ "body_of_persons", "charity" ], "description": "Body of persons or charity." }, "nature_and_objects": { "type": "string", "description": "Nature and objects." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Full address; no 'care of' or PO box." }, "trustees": { "type": "array", "items": {}, "description": "3 to 7 trustees; name, alias, nationality, residential address and occupation come from the person record." }, "property": { "type": "array", "items": {}, "description": "Every kind of property held at the application date, each {kind, description}; one item stating none if none." }, "common_seal_description": { "type": "string", "description": "Proposed common seal; must bear the corporation's name." }, "common_seal_regulations": { "type": "string", "description": "Regulations for custody and use of the seal." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Language for the whole form." } }, "required": [ "entity_type", "body_name", "body_kind", "nature_and_objects", "principal_office", "trustees", "property", "common_seal_description", "common_seal_regulations" ], "description": "The 3 to 7 duly appointed trustees of a body of persons or a charity apply to the Registrar of Companies for a certificate of incorporation, making them a body corporate with a common seal. The paper application is signed by every trustee." }, "Create_hk_registered_trustees_incorporate": { "type": "object", "properties": { "type": { "const": "hk.registered_trustees.incorporate" }, "params": { "$ref": "#/components/schemas/Params_hk_registered_trustees_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate registered trustees", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "registered_trustees_corporation" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Application for Certificate of Incorporation of Registered Trustees Corporation", "source": "generated", "required": true }, { "key": "rules_and_regulations", "title": "Rules and regulations of the body or charity", "source": "uploaded", "required": true }, { "key": "constituting_instruments", "title": "Every deed, will or other instrument creating or regulating the body, if any", "source": "uploaded", "required": false }, { "key": "trustee_appointment_evidence", "title": "Resolution or instrument showing the trustees are duly appointed", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": false } ], "people": [ { "role": "trustee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "trustee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Application for Certificate of Incorporation of Registered Trustees Corporation", "channel": "paper", "government_fee": { "amount": 380, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "trustee_count_invalid", "type": null, "when": "invalid_request_error: fewer than 3 or more than 7 trustees." }, { "code": "title_missing_required_words", "type": null, "when": "invalid_request_error: the title lacks Trustees and Incorporated, or 受託人 and 法團." }, { "code": "address_not_accepted", "type": null, "when": "invalid_request_error: an address is 'care of' or a PO box." }, { "code": "trustee_signature_missing", "type": null, "when": "requirement_error: not every trustee has signed." } ] } }, "Params_hk_society_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "society" ], "description": "Entity type." }, "name_en": { "type": "string", "description": "English name; one of the English and Chinese names is required." }, "name_zh": { "type": "string", "description": "Chinese name." }, "is_branch": { "type": "boolean", "description": "True for a branch of a registered or exempted society (s.5); needs main_society_registration_number and its consent." }, "main_society_registration_number": { "type": "string", "description": "Main society's registration number." }, "objects": { "type": "string", "description": "Objects in as much detail as possible, with activities held or planned." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address, shown on the certificate and open to inspection." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "If different; a PO box is acceptable here." }, "premises": { "type": "array", "items": {}, "description": "Every place or premises owned or occupied (s.5), as addresses." }, "date_of_establishment": { "type": "string", "format": "date", "description": "Date established or deemed established (s.2 or s.4); the month runs from it." }, "late_explanation": { "type": "string", "description": "Required if established more than one month ago." }, "office_bearers": { "type": "array", "items": {}, "description": "At least 3, each {person, post_title, is_person_in_charge, contact_number, correspondence_address}; exactly one person-in-charge; Hong Kong contact details." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "entity_type", "objects", "principal_place_of_business", "premises", "date_of_establishment", "office_bearers", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "A local society or branch applies to the Police Societies Officer for registration within one month of establishment or deemed establishment. Three office-bearers, one the person-in-charge, sign." }, "Create_hk_society_register": { "type": "object", "properties": { "type": { "const": "hk.society.register" }, "params": { "$ref": "#/components/schemas/Params_hk_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a society", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Application for Society Registration / Exemption from Society Registration", "source": "generated", "required": true }, { "key": "constitution", "title": "Constitution, articles or minutes showing objects and purposes", "source": "uploaded", "required": true }, { "key": "office_bearer_id_copies", "title": "Clear copies of HKID or other valid ID of all office-bearers", "source": "uploaded", "required": true }, { "key": "principal_place_proof", "title": "Proof of principal place of business or correspondence address", "source": "uploaded", "required": true }, { "key": "supporting_statements", "title": "Office-bearers' qualifications and activities held or proposed", "source": "uploaded", "required": true }, { "key": "occupier_consent_letter", "title": "Consent letter from the lawful occupier of the premises", "source": "uploaded", "required": false }, { "key": "name_consent_letter", "title": "Consent letter where the name relates to another association or person", "source": "uploaded", "required": false }, { "key": "certificate_registration", "title": "Certificate of Registration of a Society", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "occupier_consent_letter", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "name_consent_letter", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Societies Office, Hong Kong Police Force", "form": "Application for Society Registration / Exemption from Society Registration", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "office_bearers_insufficient", "type": null, "when": "invalid_request_error: fewer than 3 office-bearers, or not exactly one person-in-charge." }, { "code": "principal_place_not_acceptable", "type": null, "when": "invalid_request_error: the principal place is a PO box or outside Hong Kong." }, { "code": "name_conflict", "type": null, "when": "requirement_error: the name is identical or closely similar to a listed society's, or misleading." }, { "code": "establishment_more_than_one_month_ago", "type": null, "when": "requirement_error: established over a month ago with no late_explanation." } ] } }, "Params_hk_society_exemption_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "society" ], "description": "Entity type." }, "exemption_category": { "type": "string", "enum": [ "religious", "charitable", "social", "recreational", "rural_committee", "rural_committee_federation" ], "description": "Sole purpose of the society; exemption is only for these." }, "name_en": { "type": "string", "description": "English name; one of the English and Chinese names is required." }, "name_zh": { "type": "string", "description": "Chinese name." }, "is_branch": { "type": "boolean", "description": "True for a branch of a registered or exempted society (s.5); needs main_society_registration_number and its consent." }, "main_society_registration_number": { "type": "string", "description": "Main society's registration number." }, "objects": { "type": "string", "description": "Objects in as much detail as possible, with activities held or planned." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address, shown on the certificate and open to inspection." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "If different; a PO box is acceptable here." }, "premises": { "type": "array", "items": {}, "description": "Every place or premises owned or occupied (s.5), as addresses." }, "date_of_establishment": { "type": "string", "format": "date", "description": "Date established or deemed established (s.2 or s.4); the month runs from it." }, "late_explanation": { "type": "string", "description": "Required if established more than one month ago." }, "office_bearers": { "type": "array", "items": {}, "description": "At least 3, each {person, post_title, is_person_in_charge, contact_number, correspondence_address}; exactly one person-in-charge; Hong Kong contact details." } }, "required": [ "entity_type", "exemption_category", "objects", "principal_place_of_business", "premises", "date_of_establishment", "office_bearers" ], "description": "A society or branch established solely for religious, charitable, social or recreational purposes, or a rural committee or federation, applies to the Police Societies Officer for exemption within one month of establishment. Three." }, "Create_hk_society_exemption_apply": { "type": "object", "properties": { "type": { "const": "hk.society_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_society_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for exemption from society registration", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Application for Society Registration / Exemption from Society Registration", "source": "generated", "required": true }, { "key": "constitution", "title": "Constitution, articles or minutes showing objects and purposes", "source": "uploaded", "required": true }, { "key": "office_bearer_id_copies", "title": "Clear copies of HKID or other valid ID of all office-bearers", "source": "uploaded", "required": true }, { "key": "principal_place_proof", "title": "Proof of principal place of business or correspondence address", "source": "uploaded", "required": true }, { "key": "supporting_statements", "title": "Office-bearers' qualifications and activities held or proposed", "source": "uploaded", "required": true }, { "key": "occupier_consent_letter", "title": "Consent letter from the lawful occupier of the premises", "source": "uploaded", "required": false }, { "key": "name_consent_letter", "title": "Consent letter where the name relates to another association or person", "source": "uploaded", "required": false }, { "key": "certificate_exemption", "title": "Certificate of Exemption from Registration of a Society", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "occupier_consent_letter", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "name_consent_letter", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Societies Office, Hong Kong Police Force", "form": "Application for Society Registration / Exemption from Society Registration", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "exemption_purpose_not_eligible", "type": null, "when": "invalid_request_error: objects go beyond the exempt purposes; use hk.society.register." }, { "code": "office_bearers_insufficient", "type": null, "when": "invalid_request_error: fewer than 3 office-bearers, or not exactly one person-in-charge." }, { "code": "principal_place_not_acceptable", "type": null, "when": "invalid_request_error: the principal place is a PO box or outside Hong Kong." }, { "code": "name_conflict", "type": null, "when": "requirement_error: the name is identical or closely similar to a listed society's, or misleading." }, { "code": "establishment_more_than_one_month_ago", "type": null, "when": "requirement_error: established over a month ago with no late_explanation." } ] } }, "Params_hk_sole_proprietorship_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship" ], "description": "Always sole_proprietorship." }, "owner": { "type": "string", "pattern": "^per_", "description": "The individual carrying on the business." }, "owner_aliases": { "type": "array", "items": {}, "description": "Aliases of the owner, if any (Form 1)." }, "business_name_english": { "type": "string", "description": "Name under which the business is carried on." }, "business_name_chinese": { "type": "string", "description": "Chinese business name, traditional characters." }, "place_of_business": { "$ref": "#/components/schemas/Address", "description": "Address of place of business, at most 90 characters in English or 58 in Chinese including spaces and punctuation." }, "nature_of_business": { "type": "string", "description": "Description and nature of the business." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the business started." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "Certificate term; the 3-year election is made on the form." }, "resident_agent": { "type": "string", "pattern": "^per_", "description": "Required if the owner does not reside in Hong Kong: a resident individual appointed by IRBR177 or an appointment letter signed by the owner and the agent." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." } }, "required": [ "entity_type", "owner", "place_of_business", "nature_of_business", "commencement_date", "business_purpose", "countries_of_operation" ], "description": "Registers an individual's business with the Inland Revenue Department on Form 1, within one month of the business starting. This creates the sole proprietorship as an Entiva entity." }, "Create_hk_sole_proprietorship_register": { "type": "object", "properties": { "type": { "const": "hk.sole_proprietorship.register" }, "params": { "$ref": "#/components/schemas/Params_hk_sole_proprietorship_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Hong Kong sole proprietorship for business registration", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_1a", "title": "IRD Form 1: application by an individual for business registration", "source": "generated", "required": true }, { "key": "owner_identity_document_copy", "title": "Copy of the owner's Hong Kong ID card or passport", "source": "uploaded", "required": true }, { "key": "resident_agent_appointment", "title": "IRBR177 or appointment letter for the resident agent", "source": "generated", "required": false }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "identity" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "form_1a", "signer_role": "proprietor", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resident_agent_appointment", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Form 1", "channel": "both", "government_fee": { "amount": 2350, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "commencement_in_future", "type": null, "when": "[invalid_request_error] The business has not started; the IRD does not accept early applications." }, { "code": "business_registration_late", "type": null, "when": "[requirement_error] More than one month after commencement." }, { "code": "business_name_not_allowed", "type": null, "when": "[invalid_request_error] The name suggests limited liability or a government connection." }, { "code": "address_too_long", "type": null, "when": "[invalid_request_error] Place of business exceeds 90 English or 58 Chinese characters." }, { "code": "resident_agent_required", "type": null, "when": "[requirement_error] The owner is not resident in Hong Kong and no agent is named." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] The owner is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign Form 1 or log in to eTAX." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The IRD rejected the application." } ] } }, "Params_hk_tcsp_key_person_approve": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "Proposed ultimate owner or director." }, "proposed_role": { "type": "string", "enum": [ "ultimate_owner", "director" ], "description": "Role to be taken." }, "person_kind": { "type": "string", "enum": [ "individual", "corporation" ], "description": "Individual or corporation." }, "proposed_effective_date": { "type": "string", "format": "date", "description": "Date the role starts; after approval." }, "linked_action": { "type": "string", "description": "Id of the hk.director.appoint or share action creating the role." } }, "required": [ "person", "proposed_role", "person_kind", "proposed_effective_date" ], "description": "A licensee needs the Registrar's written approval before a person becomes an ultimate owner or director; acting without it is an offence. Exempt professionals need only a TCSP6 notice." }, "Create_hk_tcsp_key_person_approve": { "type": "object", "properties": { "type": { "const": "hk.tcsp_key_person.approve" }, "params": { "$ref": "#/components/schemas/Params_hk_tcsp_key_person_approve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain the Registrar's prior approval for a new ultimate owner or director of a TCSP licensee", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "tcsp3_form", "title": "Form TCSP3, application for approval", "source": "generated", "required": true }, { "key": "tcsp4_statement", "title": "Form TCSP4, fit-and-proper statement", "source": "generated", "required": true }, { "key": "tcsp5_statement", "title": "Form TCSP5, fit-and-proper statement", "source": "generated", "required": false }, { "key": "registrar_approval", "title": "Registrar's written approval", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tcsp3_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tcsp4_statement", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tcsp5_statement", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Registry for Trust and Company Service Providers", "form": "Form TCSP3 with TCSP4 or TCSP5 for each person", "channel": "both", "government_fee": { "amount": 1140, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "approval_not_required_exempt_person", "type": null, "when": "invalid_request_error: exempt under AMLO s.53B; file hk.tcsp_licence.notify_changes instead." }, { "code": "person_already_in_role", "type": null, "when": "invalid_request_error: the person already holds the role; approval cannot be sought after the fact." }, { "code": "licence_not_active", "type": null, "when": "requirement_error: the entity holds no active TCSP licence." } ] } }, "Params_hk_tcsp_licence_apply": { "type": "object", "properties": { "services": { "type": "string", "enum": [ "forming_legal_persons", "director_or_secretary_or_similar", "partner_or_similar", "address_services", "express_trust_trustee", "nominee_shareholder" ], "description": "Services to be provided." }, "business_address": { "$ref": "#/components/schemas/Address", "description": "Hong Kong business address, printed on the licence and the register." }, "business_email": { "type": "string", "description": "Business email." }, "business_phone": { "type": "string", "description": "Business telephone." }, "directors": { "type": "array", "items": {}, "description": "All directors; each takes the fit-and-proper test unless in exempt_persons." }, "ultimate_owners": { "type": "array", "items": {}, "description": "Individual ultimate owners, looked through holding companies." }, "exempt_persons": { "type": "array", "items": {}, "description": "Exempt persons, each {person, category}; proof replaces TCSP4/5." }, "compliance_officer": { "type": "string", "pattern": "^per_", "description": "Compliance Officer." }, "mlro": { "type": "string", "pattern": "^per_", "description": "Money Laundering Reporting Officer." }, "supplementary_information": { "type": "object" } }, "required": [ "services", "business_address", "business_email", "business_phone", "directors", "ultimate_owners", "compliance_officer", "mlro", "supplementary_information" ], "description": "Applies for the licence needed before carrying on a trust or company service business: forming companies, acting as or arranging a director or secretary, providing a registered office or address, or acting as or arranging a trustee or." }, "Create_hk_tcsp_licence_apply": { "type": "object", "properties": { "type": { "const": "hk.tcsp_licence.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_tcsp_licence_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a trust or company service provider licence", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "tcsp1_form", "title": "Form TCSP1 with Supplementary Information Sheets TCSP1-SIS and TCSP1-SIS2A", "source": "generated", "required": true }, { "key": "tcsp4_statements", "title": "Form TCSP4, fit-and-proper statement", "source": "generated", "required": true }, { "key": "tcsp5_statements", "title": "Form TCSP5, fit-and-proper statement", "source": "generated", "required": false }, { "key": "business_registration_certificate", "title": "Valid business registration certificate", "source": "uploaded", "required": true }, { "key": "exemption_proofs", "title": "Proof of exempt status for each exempt person", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "aml_officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tcsp1_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tcsp4_statements", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tcsp5_statements", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Registry for Trust and Company Service Providers", "form": "Form TCSP1 with TCSP1-SIS, TCSP1-SIS2A and TCSP4 or TCSP5 for each person subject to the t", "channel": "both", "government_fee": { "amount": 3440, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "licence_not_required_exempt", "type": null, "when": "invalid_request_error: the applicant is exempt under AMLO s.53B." }, { "code": "licence_already_active", "type": null, "when": "invalid_request_error: an unexpired licence exists; use hk.tcsp_licence.renew." }, { "code": "compliance_officer_or_mlro_missing", "type": null, "when": "requirement_error: no Compliance Officer or MLRO named." }, { "code": "unlicensed_activity_declared", "type": null, "when": "requirement_error: the customer already provides these services; referred to compliance first." } ] } }, "Params_hk_tcsp_licence_cease": { "type": "object", "properties": { "intended_cessation_date": { "type": "string", "format": "date", "description": "Date the business stops; the form is submitted before it." }, "reason": { "type": "string", "description": "Reason, for the entity record." } }, "required": [ "intended_cessation_date" ], "description": "Tells the Registrar, before the intended date, that the licensee will stop its business. The Registrar cancels the licence from that date and removes the licensee from the register; the licence need not be returned." }, "Create_hk_tcsp_licence_cease": { "type": "object", "properties": { "type": { "const": "hk.tcsp_licence.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_tcsp_licence_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify cessation of trust or company service business", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "tcsp7_form", "title": "Form TCSP7, notification of cessation", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tcsp7_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Registry for Trust and Company Service Providers", "form": "Form TCSP7", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cessation_date_in_past", "type": null, "when": "invalid_request_error: intended_cessation_date is today or earlier." }, { "code": "licence_not_active", "type": null, "when": "requirement_error: the entity holds no active TCSP licence." }, { "code": "active_service_engagements", "type": null, "when": "requirement_error: the entity still serves clients as secretary, director, office or nominee; hand over first." } ] } }, "Params_hk_tcsp_licence_renew": { "type": "object", "properties": { "licence_number": { "type": "string", "description": "TCSP licence number." }, "licence_expiry_date": { "type": "string", "format": "date", "description": "Expiry of the current licence; renewal is due 60 days before." }, "directors": { "type": "array", "items": {}, "description": "All directors; each takes the fit-and-proper test unless in exempt_persons." }, "ultimate_owners": { "type": "array", "items": {}, "description": "Individual ultimate owners, looked through holding companies." }, "exempt_persons": { "type": "array", "items": {}, "description": "Exempt persons, each {person, category}; proof replaces TCSP4/5." }, "compliance_officer": { "type": "string", "pattern": "^per_", "description": "Compliance Officer." }, "mlro": { "type": "string", "pattern": "^per_", "description": "Money Laundering Reporting Officer." } }, "required": [ "licence_number", "licence_expiry_date", "directors", "ultimate_owners", "compliance_officer", "mlro" ], "description": "Renews a TCSP licence. The application must reach the Registrar at least 60 days before expiry with no grace period; a timely application keeps the current licence in force." }, "Create_hk_tcsp_licence_renew": { "type": "object", "properties": { "type": { "const": "hk.tcsp_licence.renew" }, "params": { "$ref": "#/components/schemas/Params_hk_tcsp_licence_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a trust or company service provider licence", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "tcsp2_form", "title": "Form TCSP2 with its checklist of supporting documents", "source": "generated", "required": true }, { "key": "tcsp4_statements", "title": "Form TCSP4, fit-and-proper statement", "source": "generated", "required": true }, { "key": "tcsp5_statements", "title": "Form TCSP5, fit-and-proper statement", "source": "generated", "required": false }, { "key": "business_registration_certificate", "title": "Valid business registration certificate", "source": "uploaded", "required": true }, { "key": "exemption_proofs", "title": "Proof of exempt status", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "aml_officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tcsp2_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tcsp4_statements", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tcsp5_statements", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Registry for Trust and Company Service Providers", "form": "Form TCSP2 with TCSP4 or TCSP5 for each person subject to the test", "channel": "both", "government_fee": { "amount": 2910, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "renewal_window_missed", "type": null, "when": "requirement_error: under 60 days to expiry; the CR refuses renewal." }, { "code": "licence_not_found", "type": null, "when": "invalid_request_error: the licence number is not on the entity or the TCSP register." }, { "code": "unreported_changes_pending", "type": null, "when": "requirement_error: changes not yet on TCSP6, so TCSP2 would not match the CR record." } ] } }, "Params_hk_tcsp_licence_annual_information_file": { "type": "object", "properties": { "exercise_year": { "type": "integer", "description": "Calendar year of the exercise." }, "request_document": { "type": "string", "pattern": "^doc_", "description": "Form SIS2 as emailed by the CR." }, "response_deadline": { "type": "string", "format": "date", "description": "Deadline in the CR email." }, "sis2_responses": { "type": "object" } }, "required": [ "exercise_year", "request_document", "response_deadline", "sis2_responses" ], "description": "The CR emails Form SIS2 to every TCSP licensee each year. Missing the deadline breaches Licensing Condition 3 and risks disciplinary action under AMLO s.53Z." }, "Create_hk_tcsp_licence_annual_information_file": { "type": "object", "properties": { "type": { "const": "hk.tcsp_licence_annual_information.file" }, "params": { "$ref": "#/components/schemas/Params_hk_tcsp_licence_annual_information_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Complete the annual information exercise for TCSP licensees", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_sis2_request", "title": "Form SIS2 as sent by the CR", "source": "uploaded", "required": true }, { "key": "form_sis2_response", "title": "Completed Form SIS2", "source": "generated", "required": true } ], "people": [ { "role": "aml_officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_sis2_response", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Registry for Trust and Company Service Providers", "form": "Form SIS2", "channel": "online", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "response_deadline_passed", "type": null, "when": "requirement_error: response_deadline is past; filed late and flagged to compliance." }, { "code": "licence_not_active", "type": null, "when": "requirement_error: the entity holds no active TCSP licence." } ] } }, "Params_hk_tcsp_licence_changes_notify": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date the change took place; the month runs from it (AMLO s.53W)." }, "changes": { "type": "array", "items": {}, "description": "Each {category, description, effective_date, person}. category: licensee_particulars, ultimate_owner_added, ultimate_owner_ceased, ultimate_owner_particulars." } }, "required": [ "effective_date", "changes" ], "description": "Notifies the Registrar within one month of a change to the licence particulars: business name, address, email or phone; an owner, director, Compliance Officer or MLRO added, removed or changed; a change in a tested person's fit-and-proper." }, "Create_hk_tcsp_licence_changes_notify": { "type": "object", "properties": { "type": { "const": "hk.tcsp_licence_changes.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_tcsp_licence_changes_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify changes in particulars of a TCSP licensee", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "private_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "tcsp6_form", "title": "Form TCSP6, notification of changes in particulars", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "aml_officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tcsp6_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Registry for Trust and Company Service Providers", "form": "Form TCSP6", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "requirement_error: more than a month since change_date; filed late and flagged to compliance." }, { "code": "licence_not_active", "type": null, "when": "requirement_error: the entity holds no active TCSP licence." }, { "code": "approval_missing_for_new_key_person", "type": null, "when": "requirement_error: a new director or owner has no approval from hk.tcsp_key_person.approve." } ] } }, "Params_hk_trust_company_register": { "type": "object", "properties": { "signing_director": { "type": "string", "pattern": "^per_", "description": "Director who signs Form AT." }, "paid_up_cash_capital": { "$ref": "#/components/schemas/Money", "description": "Issued capital paid up for cash; at least HKD 3,000,000.", "examples": [ "{\"amount\": 300000000, \"currency\": \"HKD\"}" ] }, "solvency_confirmation": { "type": "boolean", "description": "Company can meet its obligations, apart from liability to shareholders, without the s.77 deposit." }, "objects_confirmed": { "type": "boolean", "description": "Articles restrict the objects to those Part 8 allows." }, "statutory_deposit_method": { "type": "string", "enum": [ "deposit_with_authorized_institution", "bank_guarantee" ], "description": "How the s.77 deposit is met." }, "statutory_deposit_amount": { "$ref": "#/components/schemas/Money", "description": "Amount deposited or guaranteed; at least HKD 1,500,000.", "examples": [ "{\"amount\": 150000000, \"currency\": \"HKD\"}" ] }, "bank": { "type": "string", "description": "Bank giving the guarantee or authorized institution holding the deposit." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "signing_director", "paid_up_cash_capital", "solvency_confirmation", "objects_confirmed", "statutory_deposit_method", "statutory_deposit_amount", "bank", "name", "nature_of_business", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "A director applies for a Hong Kong public company to be registered as a trust company under Part 8 of the Trustee Ordinance, confirming HK$3,000,000 or more of issued capital is paid up in cash and the company can meet its obligations." }, "Create_hk_trust_company_register": { "type": "object", "properties": { "type": { "const": "hk.trust_company.register" }, "params": { "$ref": "#/components/schemas/Params_hk_trust_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a company as a trust company", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_at", "title": "Form AT, application for registration as a trust company", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Current articles showing the restricted objects", "source": "uploaded", "required": true }, { "key": "bank_guarantee", "title": "Bank Guarantee deed to the Director of Accounting Services", "source": "uploaded", "required": false }, { "key": "deposit_evidence", "title": "Evidence of the HK$1,500,000 deposit", "source": "uploaded", "required": false }, { "key": "trust_company_certificate", "title": "Certificate of registration as a trust company", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_at", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "bank_guarantee", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form AT, application for registration as a trust company under Part 8 of the Trustee Ordin", "channel": "paper", "government_fee": { "amount": 12090, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "public_company_required", "type": null, "when": "jurisdiction_error: the entity is a private company; Part 8 is for a company that is not private." }, { "code": "capital_below_minimum", "type": null, "when": "invalid_request_error: paid_up_cash_capital is below HKD 3,000,000." }, { "code": "deposit_below_minimum", "type": null, "when": "invalid_request_error: statutory_deposit_amount is below HKD 1,500,000." }, { "code": "objects_not_restricted", "type": null, "when": "requirement_error: the articles' objects are wider than Part 8 allows; alter them first." }, { "code": "tcsp_licence_review_needed", "type": null, "when": "requirement_error: trustee business by way of business is a trust or company service and the exemption list omits trust companies; compliance checks whether hk.tcsp_licence.apply." } ] } }, "Params_hk_unlimited_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "unlimited_company" ], "description": "Always unlimited_company." }, "company_class": { "type": "string", "enum": [ "private", "public" ], "description": "Private unlimited: 1+ director who is a natural person." }, "name_en": { "type": "string", "description": "Proposed English name; must equal the articles' name clause." }, "name_zh": { "type": "string", "description": "Traditional Chinese name." }, "nature_of_business": { "type": "string", "description": "{description: string, code: string}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong street address; no 'care of' or PO box." }, "contact_email": { "type": "string", "description": "Company email." }, "contact_phone_hk": { "type": "string", "description": "Hong Kong contact telephone, +852." }, "share_capital": { "type": "array", "items": {}, "description": "As for NNC1: {class, number_of_shares, currency, amount_subscribed: money, amount_paid_up: money, amount_unpaid: money}." }, "share_class_rights": { "type": "array", "items": {}, "description": "Required when more than one class: {class, voting_rights, dividend_rights, capital_rights, redeemable}." }, "founder_members": { "type": "array", "items": {}, "description": "{person: person_ref, shares: [{class, number_of_shares, amount: money}]}." }, "signing_founder_member": { "type": "string", "pattern": "^per_", "description": "Founder who signs NNC1G; required when more than one founder." }, "directors": { "type": "array", "items": {}, "description": "{person: person_ref, consent_method: 'in_form' | 'nnc3', correspondence_address: address}." }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "{provider: 'entiva_partner' | 'person', person: person_ref, tcsp_licence_number: string, tcsp_exemption_reason: string}." }, "articles": { "type": "object", "description": "{source: 'entiva_sample' | 'custom_upload', document: document_ref}." }, "br_certificate_years": { "type": "string", "enum": [ "1", "3" ], "description": "IRBR1 election; default '1'." }, "controllers": { "type": "array", "items": {}, "description": "{person: person_ref, ownership_percent: number, voting_percent: number, appoints_board_majority: boolean, significant_influence_or_control: boolean, held_via." }, "uses_nominees": { "type": "boolean", "description": "True if any director or shareholder is a nominee." }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business." }, "countries_of_operation": { "type": "array", "items": {}, "description": "ISO 3166 codes." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "company_class", "contact_email", "share_capital", "founder_members", "directors", "business_purpose", "countries_of_operation" ], "description": "Incorporates a private or public unlimited company with a share capital on Form NNC1G, with IRBR1 and articles stating that members' liability is unlimited. Founder members acknowledge the unlimited personal liability before signing." }, "Create_hk_unlimited_company_incorporate": { "type": "object", "properties": { "type": { "const": "hk.unlimited_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_hk_unlimited_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Hong Kong unlimited company", "x-entiva": { "jurisdiction": "hk", "stage": "formation", "applies_to": [ "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "articles_signed_original", "title": "Articles signed by all founder members", "source": "generated", "required": true }, { "key": "incorporation_form_nnc1g", "title": "Form NNC1G as filed", "source": "generated", "required": true }, { "key": "pi_nnc1g_sheet", "title": "PI-NNC1G protected information sheets", "source": "generated", "required": true }, { "key": "notice_irbr1", "title": "Notice to Business Registration Office", "source": "generated", "required": true }, { "key": "unlimited_liability_acknowledgement", "title": "Founder acknowledgement of unlimited liability", "source": "generated", "required": true }, { "key": "corporate_party_documents", "title": "Corporate founder or director documents", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution naming the signatory", "source": "uploaded", "required": false }, { "key": "source_of_wealth", "title": "Source of wealth and funds evidence", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Certificate of Incorporation", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true }, { "key": "statutory_registers", "title": "Registers of members, directors, secretaries", "source": "generated", "required": true }, { "key": "significant_controllers_register", "title": "SCR", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true } ], "people": [ { "role": "incorporator", "verification_level": "identity" }, { "role": "incorporator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "incorporation_form_nnc1g", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "articles_signed_original", "signer_role": "incorporator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "unlimited_liability_acknowledgement", "signer_role": "incorporator", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_irbr1", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, e-Services Portal e-Incorporation, with one-stop business registration", "form": "NNC1G with IRBR1, articles and PI-NNC1G sheet", "channel": "online", "government_fee": { "amount": 1545, "currency": "HKD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "[registry_error] Name clashes with the Index of Company Names." }, { "code": "name_rule_violation", "type": null, "when": "[invalid_request_error] Mixed scripts, simplified Chinese, or form and articles differ." }, { "code": "name_requires_approval", "type": null, "when": "[requirement_error] Cap. 622A restricted word or government-connection name." }, { "code": "director_requirements_not_met", "type": null, "when": "[invalid_request_error] Private: no natural-person director." }, { "code": "secretary_requirements_not_met", "type": null, "when": "[invalid_request_error] No secretary, non-resident individual, body corporate without a Hong Kong office, or sole director also secretary." }, { "code": "share_capital_inconsistent", "type": null, "when": "[invalid_request_error] Paid up plus unpaid differs from subscribed, or allotments differ from class totals." }, { "code": "registered_office_invalid", "type": null, "when": "[invalid_request_error] Non-Hong Kong, 'care of' or PO box address." }, { "code": "verification_incomplete", "type": null, "when": "[requirement_error] Someone is not yet verified." }, { "code": "sanctions_alert_open", "type": null, "when": "[requirement_error] Open alert pauses the action." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to sign or give the liability acknowledgement." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The CR rejected the form." } ] } }, "Params_hk_accounting_records_record": { "type": "object", "properties": { "start_date": { "type": "string", "format": "date", "description": "First day Entiva keeps the records." }, "financial_year_end": { "type": "string", "format": "date", "description": "Accounting reference date." }, "records_mode": { "type": "string", "enum": [ "entiva_ledger", "customer_system_sync", "customer_kept_with_review" ], "description": "entiva_ledger; customer_system_sync; customer_kept_with_review." }, "expected_monthly_transactions": { "type": "integer", "description": "Sets the price." }, "records_location": { "type": "string", "enum": [ "entiva_platform_with_hk_partner_access", "registered_office", "other_hong_kong_place" ], "description": "Where records sit." } }, "required": [ "start_date", "financial_year_end", "records_mode", "expected_monthly_transactions", "records_location" ], "description": "Run bookkeeping so the company keeps the accounting records Cap. 622 requires and can support the audit. Nothing is filed." }, "Create_hk_accounting_records_record": { "type": "object", "properties": { "type": { "const": "hk.accounting_records.record" }, "params": { "$ref": "#/components/schemas/Params_hk_accounting_records_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Keep the company's accounting records", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_terms", "title": "Bookkeeping engagement terms", "source": "generated", "required": true }, { "key": "bank_statements", "title": "Bank statements", "source": "uploaded", "required": true }, { "key": "annual_records_attestation", "title": "Director's yearly confirmation that records are kept", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "engagement_terms", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "annual_records_attestation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Accounting records, Cap. 622 ss.373 to 378", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "source_documents_missing", "type": null, "when": "Bank statements or opening balances missing." }, { "code": "opening_balances_unreconciled", "type": null, "when": "Opening balances do not agree to the last audited statements." }, { "code": "records_location_outside_hong_kong", "type": null, "when": "Not accepted: the s.374 conditions were not read." } ] } }, "Params_hk_accounts_revision_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Registered non-Hong Kong company." }, "accounts_period_start": { "type": "string", "format": "date", "description": "Start of the accounting period." }, "accounts_period_end": { "type": "string", "format": "date", "description": "End of the period." }, "original_delivery_date": { "type": "string", "format": "date", "description": "When the accounts were delivered under s.789." }, "decision_date": { "type": "string", "format": "date", "description": "Date the directors decided to revise (s.790); NN15 is due 15 days later." }, "defect_description": { "type": "string", "description": "What is wrong; kept for the file, not on NN15." } }, "required": [ "entity_type", "accounts_period_start", "accounts_period_end", "original_delivery_date", "decision_date", "defect_description" ], "description": "Files NN15 within 15 days after a registered non-HK company's directors decide to revise accounts already delivered. It only warns that a revision is coming." }, "Create_hk_accounts_revision_notify": { "type": "object", "properties": { "type": { "const": "hk.accounts_revision.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_accounts_revision_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give the warning statement that delivered accounts will be revised", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_decision", "title": "Directors' decision to revise", "source": "generated", "required": true }, { "key": "warning_statement", "title": "Form NN15", "source": "generated", "required": true }, { "key": "revised_accounts", "title": "Revised accounts", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "warning_statement", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN15 - Statement of Revision of Accounts", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 15 days after decision_date; filed and flagged late" }, { "code": "accounts_not_delivered", "type": null, "when": "No s.789 delivery on record" } ] } }, "Params_hk_annual_return_file": { "type": "object", "properties": { "anniversary_date": { "type": "string", "format": "date", "description": "Incorporation anniversary the return is made up to." }, "nature_of_business": { "type": "string", "description": "{code, description} from the CR business nature list." }, "contact": { "type": "object", "description": "{email, hk_phone} for NAR1 items 7 and 8." }, "mortgages_and_charges_total": { "$ref": "#/components/schemas/Money", "description": "Total indebtedness on registrable charges." }, "share_capital": { "type": "array", "items": {}, "description": "Per class: class, currency, total_number, total_amount, total_paid_up." }, "company_records_locations": { "type": "array", "items": {}, "description": "{record, address} for records not at the registered office." }, "public_invitation_statement_confirmed": { "type": "boolean", "description": "Item 16: no invitation to the public to subscribe for shares or debentures since the last return, and any members over 50 are excluded by s.11." }, "signing_route": { "type": "string", "enum": [ "partner_as_company_secretary", "director_personally" ], "description": "partner_as_company_secretary or director_personally." }, "late_fee_acknowledged": { "type": "boolean", "description": "True to proceed after the 42 days; a higher fee applies." } }, "required": [ "anniversary_date", "nature_of_business", "contact", "share_capital", "public_invitation_statement_confirmed" ], "description": "File NAR1 for a private company within 42 days after the incorporation or re-domiciliation anniversary. No accounts attached." }, "Create_hk_annual_return_file": { "type": "object", "properties": { "type": { "const": "hk.annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Annual return, private company", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_attestation", "title": "Director's confirmation of the return", "source": "generated", "required": true }, { "key": "nar1_form", "title": "Form NAR1", "source": "generated", "required": true }, { "key": "nar1_receipt", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "director_attestation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nar1_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nar1_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAR1 Annual Return", "channel": "online", "government_fee": { "amount": 105, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "dormant_company_exempt", "type": null, "when": "Dormant private company, except the year dormancy begins after the 42nd day." }, { "code": "no_return_due_in_year_of_incorporation", "type": null, "when": "anniversary_date is in the year of incorporation." }, { "code": "filing_deadline_passed", "type": null, "when": "The 42 days have ended; set late_fee_acknowledged." } ] } }, "Params_hk_apostille_private_document_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership" ], "description": "Entity type." }, "document_kind": { "type": "string", "enum": [ "board_resolution", "shareholder_resolution", "power_of_attorney", "certified_true_copy", "incumbency_certificate", "director_declaration", "other_private_document" ], "description": "Kind of document." }, "notarial_act": { "type": "string", "enum": [ "notary_public", "commissioner_for_oaths" ], "description": "notary_public for powers of attorney and certified copies; commissioner_for_oaths for declarations." }, "signatories": { "type": "array", "items": {}, "description": "per_ ids of the people who sign and attend." }, "destination_country": { "type": "string", "description": "ISO 3166 country of use; must be an Apostille Convention member." }, "apostille_channel": { "type": "string", "enum": [ "e_apostille_via_notary", "paper_apostille_service_office" ], "description": "Enrolled notary files an e-Apostille, or the signed paper goes to the Apostille Service Office." }, "return_method": { "type": "string", "enum": [ "partner_collect_and_hold", "prepaid_courier", "registered_airmail" ], "description": "How the original comes back." }, "return_address": { "$ref": "#/components/schemas/Address", "description": "Required unless partner_collect_and_hold." } }, "required": [ "entity_type", "document_kind", "notarial_act", "signatories", "destination_country", "apostille_channel", "return_method" ], "description": "Takes a private document through a Hong Kong notary or Commissioner for Oaths and on to the apostille. Signers attend in person." }, "Create_hk_apostille_private_document_apply": { "type": "object", "properties": { "type": { "const": "hk.apostille_private_document.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_apostille_private_document_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notarise and apostille a Hong Kong private corporate document", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "private_document", "title": "Document to be notarised", "source": "generated", "required": true }, { "key": "notarised_document", "title": "Signed and notarised document", "source": "uploaded", "required": true }, { "key": "apostille", "title": "Apostille", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "private_document", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "High Court Registry, Apostille Service Office, or Judiciary e-Apostille", "form": "Apostille application on the notarised document", "channel": "both", "government_fee": { "amount": 125, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "signatory_attendance_required", "type": null, "when": "A signatory cannot attend the notary in person" }, { "code": "destination_not_apostille_state", "type": null, "when": "Destination is not an Apostille Convention member" } ] } }, "Params_hk_apostille_public_document_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership" ], "description": "Entity type." }, "document_type": { "type": "string", "enum": [ "certificate_of_incorporation", "certificate_of_change_of_name", "certificate_of_continuing_registration", "business_registration_certificate", "other_public_document" ], "description": "Public document to apostille." }, "document_origin": { "type": "string", "enum": [ "order_new_from_registry", "customer_original" ], "description": "order_new_from_registry: Entiva orders a fresh original. customer_original: paper original is sent to the partner." }, "destination_country": { "type": "string", "description": "ISO 3166 country of use; must be an Apostille Convention member." }, "return_method": { "type": "string", "enum": [ "partner_collect_and_hold", "prepaid_courier", "registered_airmail" ], "description": "How the apostilled original comes back." }, "return_address": { "$ref": "#/components/schemas/Address", "description": "Required unless partner_collect_and_hold." } }, "required": [ "entity_type", "document_type", "document_origin", "destination_country", "return_method" ], "description": "Gets the High Court Registrar's apostille on a public document such as a certificate of incorporation. Entiva obtains the original, adds the search print-out and lodges." }, "Create_hk_apostille_public_document_apply": { "type": "object", "properties": { "type": { "const": "hk.apostille_public_document.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_apostille_public_document_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apostille a Hong Kong public corporate document", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "company_search_printout", "title": "Company search print-out dated within 3 working days", "source": "generated", "required": false }, { "key": "apostille", "title": "Apostille", "source": "registry_issued", "required": true } ], "people": [], "approvals": [], "signatures": [ { "document_key": "company_search_printout", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court Registry, Apostille Service Office", "form": "Apostille application with the original and search print-out", "channel": "paper", "government_fee": { "amount": 125, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "search_printout_stale", "type": null, "when": "Print-out older than 3 working days at lodging" }, { "code": "destination_not_apostille_state", "type": null, "when": "Destination is not an Apostille Convention member" } ] } }, "Params_hk_business_registration_renew": { "type": "object", "properties": { "business_registration_number": { "type": "string", "description": "As printed on the certificate." }, "current_certificate_expiry_date": { "type": "string", "format": "date", "description": "Drives the demand note date and the 1-month rule for a 3-year election." }, "certificate_start_date": { "type": "string", "format": "date", "description": "Start of the renewal certificate." }, "certificate_term": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "1_year or 3_year." }, "branch_registration_numbers": { "type": "array", "items": {}, "description": "Branch certificates to renew on the same term." } }, "required": [ "business_registration_number", "current_certificate_expiry_date", "certificate_start_date", "certificate_term" ], "description": "Pay the IRD business registration demand note and obtain the renewed 1-year or 3-year certificate, with branch certificates." }, "Create_hk_business_registration_renew": { "type": "object", "properties": { "type": { "const": "hk.business_registration.renew" }, "params": { "$ref": "#/components/schemas/Params_hk_business_registration_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew the business registration certificate", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "lpf", "open_ended_fund_company", "general_partnership", "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "demand_note", "title": "IRD business registration demand note", "source": "registry_issued", "required": true }, { "key": "three_year_election_notice", "title": "Written 3-year election", "source": "generated", "required": false }, { "key": "business_registration_certificate", "title": "Renewed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "demand_note", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "three_year_election_notice", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Business registration demand note", "channel": "online", "government_fee": { "amount": 2350, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "demand_note_not_found", "type": null, "when": "Not issued yet; Entiva retries and warns before expiry." }, { "code": "three_year_notice_too_late", "type": null, "when": "Under 1 month to expiry; a 3-year election cannot apply." }, { "code": "entity_in_liquidation", "type": null, "when": "The eTAX demand note service excludes companies in liquidation." } ] } }, "Params_hk_business_registration_exemption_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership", "lp" ], "description": "Unincorporated business; companies, OFCs and LPFs are not eligible." }, "business_registration_number": { "type": "string", "description": "First 8 digits of the BR number." }, "application_type": { "type": "string", "enum": [ "existing_business", "new_business" ], "description": "existing_business or new_business." }, "certificate_expiry_date": { "type": "string", "format": "date", "description": "Current certificate expiry; required for existing_business." }, "br_application_date": { "type": "string", "format": "date", "description": "Required for new_business." }, "nature_of_business": { "type": "string", "enum": [ "mainly_services", "other" ], "description": "Ceiling: HK$10,000 a month if mainly services, HK$30,000 otherwise." }, "average_monthly_receipts": { "$ref": "#/components/schemas/Money", "description": "Last 6 months for an existing business; first-6-month estimate for a new one." }, "other_businesses_same_owners": { "type": "boolean", "description": "Same owners run 2 or more businesses; then none qualifies." }, "submission_channel": { "type": "string", "enum": [ "online_govhk", "paper_post", "paper_in_person" ], "description": "Sets the deadline; fax is not accepted." }, "owners": { "type": "array", "items": {}, "description": "per_ ids of the proprietor or every partner." } }, "required": [ "entity_type", "business_registration_number", "application_type", "nature_of_business", "average_monthly_receipts", "other_businesses_same_owners", "submission_channel", "owners" ], "description": "Submits Form 3 for a one-year exemption from the business registration fee and levy. Unincorporated, low-turnover businesses only; re-apply every year." }, "Create_hk_business_registration_exemption_apply": { "type": "object", "properties": { "type": { "const": "hk.business_registration_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_business_registration_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for the small-business exemption from the business registration fee and levy", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "sole_proprietorship", "general_partnership", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_application", "title": "Form 3", "source": "generated", "required": true }, { "key": "receipts_record", "title": "Sales or receipts record for the 6 months", "source": "uploaded", "required": false }, { "key": "exempt_br_certificate", "title": "Exempt Business Registration Certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "exemption_application", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_application", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Form 3", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "receipts_above_threshold", "type": null, "when": "Average receipts exceed the ceiling" }, { "code": "multiple_businesses_same_owners", "type": null, "when": "Owners run more than one business" } ] } }, "Params_hk_certificate_of_resident_status_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "general_partnership", "lp", "lpf", "open_ended_fund_company", "foreign_company" ], "description": "Entity type." }, "treaty_partner": { "type": "string", "description": "ISO 3166 code of the treaty partner; CN uses IR1313A, others IR1313B." }, "calendar_year": { "type": "integer", "description": "Year the certificate is for; generally one per treaty per year." }, "residency_basis": { "type": "string", "enum": [ "incorporated_or_constituted_in_hk", "managed_or_controlled_in_hk", "re_domiciled_company" ], "description": "Incorporated or constituted in HK, managed or controlled in HK, or re-domiciled." } }, "required": [ "entity_type", "treaty_partner", "calendar_year", "residency_basis" ], "description": "Applies to the IRD for the certificate proving Hong Kong residence under one double taxation agreement: IR1313A for Mainland China, IR1313B for others." }, "Create_hk_certificate_of_resident_status_apply": { "type": "object", "properties": { "type": { "const": "hk.certificate_of_resident_status.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_certificate_of_resident_status_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a Certificate of Resident Status for a tax treaty", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "general_partnership", "lp", "lpf", "open_ended_fund_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_form", "title": "Form IR1313A or IR1313B", "source": "generated", "required": true }, { "key": "residency_evidence", "title": "Evidence of management and control in HK", "source": "uploaded", "required": false }, { "key": "ird_service_agent_appointment", "title": "Appointment of Entiva in the IRD portal", "source": "uploaded", "required": true }, { "key": "certificate_of_resident_status", "title": "Certificate of Resident Status", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Tax Treaty Section", "form": "IR1313A", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_treaty_with_partner", "type": null, "when": "No comprehensive agreement with treaty_partner" }, { "code": "residency_evidence_missing", "type": null, "when": "Managed-and-controlled claim without evidence" } ] } }, "Params_hk_certified_copy_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "lpf", "open_ended_fund_company" ], "description": "Entity type." }, "record_type": { "type": "string", "enum": [ "image_record", "search_report" ], "description": "image_record or search_report." }, "items": { "type": "array", "items": {}, "description": "image_record: {form_code, filing_date, copies}. search_report: {report, copies}." }, "delivery_method": { "type": "string", "enum": [ "partner_collect_and_hold", "registry_post", "registry_courier" ], "description": "Collection by Entiva, or Registry post or courier for a handling charge." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for post or courier." } }, "required": [ "entity_type", "record_type", "delivery_method" ], "description": "Orders Companies Registry certified copies of registered documents or search reports, issued on paper." }, "Create_hk_certified_copy_request": { "type": "object", "properties": { "type": { "const": "hk.certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_hk_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order certified copies of registered documents or search reports", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_copy", "title": "Certified copy", "source": "registry_issued", "required": true } ], "people": [], "approvals": [], "signatures": [ { "document_key": "certified_copy", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Order for certified copy", "channel": "online", "government_fee": { "amount": 130, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "document_not_found", "type": null, "when": "No registered document matches the form code and date" }, { "code": "delivery_address_required", "type": null, "when": "Post or courier chosen without an address" } ] } }, "Params_hk_continuing_registration_certificate_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "description": "Entity type." }, "delivery_method": { "type": "string", "enum": [ "partner_collect_and_hold", "registry_post", "registry_courier" ], "description": "partner_collect_and_hold: partner collects at the 13/F e-Services Centre." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for post or courier." }, "then_apostille": { "type": "boolean", "description": "Also creates hk.apostille_public_document.apply once the original arrives." } }, "required": [ "entity_type", "delivery_method" ], "description": "Orders the Companies Registry's Certificate of Continuing Registration, proof that a live company is still on the register. Paper only." }, "Create_hk_continuing_registration_certificate_request": { "type": "object", "properties": { "type": { "const": "hk.continuing_registration_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_hk_continuing_registration_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a certificate of continuing registration", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "continuing_registration_certificate", "title": "Certificate of Continuing Registration", "source": "registry_issued", "required": true } ], "people": [], "approvals": [], "signatures": [ { "document_key": "continuing_registration_certificate", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Order for Certificate of Continuing Registration", "channel": "online", "government_fee": { "amount": 170, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_not_live", "type": null, "when": "Company is dissolved or struck off; use hk.letter_of_confirmation.request" }, { "code": "delivery_address_required", "type": null, "when": "Post or courier chosen without an address" } ] } }, "Params_hk_designated_representative_appoint": { "type": "object", "properties": { "representative_type": { "type": "string", "enum": [ "entiva_partner", "member", "director", "employee", "accounting_professional", "legal_professional", "tcsp_licensee" ], "description": "member, director and employee must be Hong Kong-resident natural persons." }, "person": { "type": "string", "pattern": "^per_", "description": "Natural person; required except for entiva_partner and firms." }, "firm_registration_number": { "type": "string", "description": "AFRC, Law Society or TCSP licence number, checked on the public register." }, "contact_email": { "type": "string", "description": "Entered in the register with the name." }, "contact_phone": { "type": "string", "description": "E.164." }, "effective_date": { "type": "string", "format": "date", "description": "Designation date." } }, "required": [ "representative_type", "contact_email", "contact_phone", "effective_date" ], "description": "Name the person or firm that assists law enforcement with the company's SCR. At least one is required; Entiva is the default." }, "Create_hk_designated_representative_appoint": { "type": "object", "properties": { "type": { "const": "hk.designated_representative.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_designated_representative_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Designate a representative for the significant controllers register", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution designating the representative", "source": "generated", "required": true }, { "key": "acceptance_of_designation", "title": "Acceptance of designation", "source": "generated", "required": true }, { "key": "professional_evidence", "title": "Professional or licence evidence", "source": "uploaded", "required": false }, { "key": "scr_extract", "title": "Register extract showing the representative", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "acceptance_of_designation", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "acceptance_of_designation", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Company register, not delivered to the Companies Registry", "form": "Name and contact details entered in the SCR", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "designated_representative_ineligible", "type": null, "when": "Not a Hong Kong-resident member, director or employee, and not a CPA, lawyer or TCSP licensee." }, { "code": "professional_status_unverified", "type": null, "when": "Practising status or TCSP licence not confirmed on the public register." }, { "code": "scr_not_required_listed_company", "type": null, "when": "The company is listed and keeps no register." } ] } }, "Params_hk_designated_representative_remove": { "type": "object", "properties": { "representative": { "type": "string", "description": "per_ id, entiva_partner, or the firm name on the register." }, "reason": { "type": "string", "enum": [ "resigned", "ceased_to_qualify", "replaced", "company_decision", "left_group" ], "description": "Why it ends." }, "effective_date": { "type": "string", "format": "date", "description": "Date it ends." }, "replacement": { "type": "string", "description": "act_ id of an appoint action or a per_ id." } }, "required": [ "representative", "reason", "effective_date" ], "description": "Remove an SCR designated representative. Blocked if it would leave none." }, "Create_hk_designated_representative_remove": { "type": "object", "properties": { "type": { "const": "hk.designated_representative.remove" }, "params": { "$ref": "#/components/schemas/Params_hk_designated_representative_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End a designated representative of the significant controllers register", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution ending the designation", "source": "generated", "required": true }, { "key": "scr_extract", "title": "Register extract after removal", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Company register, not delivered to the Companies Registry", "form": "Removal noted in the SCR", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_designated_representative", "type": null, "when": "No replacement named and no other representative remains." }, { "code": "representative_not_found", "type": null, "when": "Not a designated representative on the register." }, { "code": "replacement_not_eligible", "type": null, "when": "The replacement fails the eligibility rules." } ] } }, "Params_hk_employee_departure_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "description": "Employer type." }, "employee_name": { "type": "string", "description": "Employee name as on the ID." }, "employee_id": { "type": "object", "description": "{type: hkid|passport, number}." }, "expected_departure_date": { "type": "string", "format": "date", "description": "Departure date; IR56G is due at least 1 month earlier." }, "destination_country": { "type": "string", "description": "ISO 3166 country moved to." }, "amounts_due": { "$ref": "#/components/schemas/Money", "description": "Salary, commission, bonuses and reimbursements to be withheld." }, "withholding_acknowledged": { "type": "boolean", "description": "Employer will withhold all sums until the release letter." } }, "required": [ "entity_type", "employee_name", "employee_id", "expected_departure_date", "withholding_acknowledged" ], "description": "Files IR56G at least one month before an employee leaves Hong Kong; all sums due must be withheld until the IRD releases them." }, "Create_hk_employee_departure_notify": { "type": "object", "properties": { "type": { "const": "hk.employee_departure.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_employee_departure_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the IRD that an employee is leaving Hong Kong", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ir56g", "title": "IR56G", "source": "generated", "required": true }, { "key": "ird_release_letter", "title": "IRD letter of release", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ir56g", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "ir56g", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "IR56G Notification of Employee Leaving Hong Kong", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "withholding_not_acknowledged", "type": null, "when": "withholding_acknowledged is false" }, { "code": "departure_too_soon", "type": null, "when": "Departure less than 1 month away; filed at once and flagged" } ] } }, "Params_hk_employee_hire_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "description": "Employer type." }, "employee_name": { "type": "string", "description": "Employee name as on the ID." }, "employee_id": { "type": "object", "description": "{type: hkid|passport, number}." }, "commencement_date": { "type": "string", "format": "date", "description": "First day of employment; IR56E is due within 3 months." }, "capacity": { "type": "string", "description": "Post or capacity." }, "monthly_salary": { "$ref": "#/components/schemas/Money", "description": "Monthly salary." }, "likely_chargeable_to_salaries_tax": { "type": "boolean", "description": "Default true; if false no IR56E is needed." } }, "required": [ "entity_type", "employee_name", "employee_id", "commencement_date", "capacity", "monthly_salary" ], "description": "Files IR56E within 3 months after an employee starts, if they are likely to be chargeable to salaries tax." }, "Create_hk_employee_hire_notify": { "type": "object", "properties": { "type": { "const": "hk.employee_hire.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_employee_hire_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the IRD of a new employee", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "employment_contract", "title": "Employment contract", "source": "uploaded", "required": false }, { "key": "ir56e", "title": "IR56E", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ir56e", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "ir56e", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "IR56E Notification of Commencement of Employment", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_chargeable", "type": null, "when": "Not likely chargeable; no IR56E needed" }, { "code": "deadline_passed", "type": null, "when": "More than 3 months after commencement; filed and flagged" } ] } }, "Params_hk_employee_termination_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "description": "Employer type." }, "employee_name": { "type": "string", "description": "Employee name as on the ID." }, "employee_id": { "type": "object", "description": "{type: hkid|passport, number}." }, "termination_date": { "type": "string", "format": "date", "description": "Last day of employment; IR56F is due at least 1 month earlier." }, "reason": { "type": "string", "enum": [ "resignation", "dismissal", "contract_end", "retirement", "death", "other" ], "description": "Reason for ending." }, "final_payments": { "$ref": "#/components/schemas/Money", "description": "Final salary, bonus, leave pay and other sums." }, "leaving_hong_kong": { "type": "boolean", "description": "If true, also file hk.employee_departure.notify and withhold payments." } }, "required": [ "entity_type", "employee_name", "employee_id", "termination_date", "reason", "leaving_hong_kong" ], "description": "Files IR56F at least one month before an employee's termination date." }, "Create_hk_employee_termination_notify": { "type": "object", "properties": { "type": { "const": "hk.employee_termination.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_employee_termination_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the IRD that an employee's employment is ending", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "termination_letter", "title": "Resignation or termination letter", "source": "uploaded", "required": false }, { "key": "ir56f", "title": "IR56F", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ir56f", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "ir56f", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "IR56F Notification of Cessation of Employment", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_too_short", "type": null, "when": "Termination less than 1 month away; filed at once and flagged" }, { "code": "use_departure_notice", "type": null, "when": "leaving_hong_kong is true; IR56G also required" } ] } }, "Params_hk_employer_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "description": "Employer type." }, "year_of_assessment": { "type": "string", "description": "YYYY/YY of the return." }, "return_issued_date": { "type": "string", "format": "date", "description": "Date the IRD issued BIR56A; due 1 month after receipt." }, "no_employees": { "type": "boolean", "description": "True for a nil return." }, "employees": { "type": "array", "items": {}, "description": "Per person: name, ID, capacity, period, cash and non-cash pay, MPF, quarters. 2025/26 rule: report single staff earning HK$132,000+, married staff, part-timers." }, "filing_mode": { "type": "string", "enum": [ "online", "mixed" ], "description": "online, or mixed." } }, "required": [ "entity_type", "year_of_assessment", "return_issued_date", "no_employees", "filing_mode" ], "description": "Files BIR56A and an IR56B for each reportable employee, directors always included. A return is due even with no employees." }, "Create_hk_employer_return_file": { "type": "object", "properties": { "type": { "const": "hk.employer_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_employer_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual Employer's Return", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "sole_proprietorship", "general_partnership", "lp", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payroll_records", "title": "Payroll and remuneration records", "source": "uploaded", "required": false }, { "key": "employer_return", "title": "BIR56A with IR56B forms", "source": "generated", "required": true }, { "key": "control_list", "title": "Control List", "source": "generated", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "employer_return", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "employer_return", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "control_list", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "BIR56A with IR56B for each employee reported", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "return_not_issued", "type": null, "when": "No BIR56A issued; Entiva asks the IRD for one" }, { "code": "payroll_data_incomplete", "type": null, "when": "A reportable employee lacks pay or ID data" } ] } }, "Params_hk_financial_statements_approve": { "type": "object", "properties": { "financial_statements": { "type": "string", "pattern": "^doc_", "description": "Draft audited statements from hk.financial_statements.prepare, or an uploaded set." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year covered." }, "approval_date": { "type": "string", "format": "date", "description": "Date directors approve; the auditor's report is dated on or after it." }, "signing_directors": { "type": "array", "items": {}, "description": "per_ ids of the directors signing the statement of financial position: two, or the sole director." }, "directors_report_signer": { "type": "string", "enum": [ "director", "company_secretary" ], "description": "A director or the secretary signs the directors' report." }, "auditor": { "type": "string", "pattern": "^per_", "description": "The CPA signing the auditor's report." }, "reporting_route": { "type": "string", "enum": [ "agm", "written_resolution_dispensing_agm", "single_member_decision", "dormant_company" ], "description": "agm; written_resolution_dispensing_agm (all members, s.613, copies provided s.612); single_member_decision (s.612); dormant_company." }, "agm_date": { "type": "string", "format": "date", "description": "For route agm; must fall in the s.610 period." }, "members_sent_on": { "type": "string", "format": "date", "description": "Date copies go to every member." } }, "required": [ "financial_statements", "financial_year_end", "approval_date", "signing_directors", "directors_report_signer", "auditor", "reporting_route", "members_sent_on" ], "description": "Directors approve and sign, the auditor signs, and the pack goes to members or the AGM. It feeds NAR1 and the tax return." }, "Create_hk_financial_statements_approve": { "type": "object", "properties": { "type": { "const": "hk.financial_statements.approve" }, "params": { "$ref": "#/components/schemas/Params_hk_financial_statements_approve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Approve, sign and circulate the audited financial statements", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the statements", "source": "generated", "required": true }, { "key": "management_representation_letter", "title": "Management representation letter", "source": "generated", "required": true }, { "key": "signed_financial_statements", "title": "Signed statements, directors' report and auditor's report", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' written resolution dispensing with the AGM", "source": "generated", "required": false }, { "key": "circulation_record", "title": "Record of circulation to members", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "signed_financial_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "signed_financial_statements", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "signed_financial_statements", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "management_representation_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Reporting documents under Cap. 622 Part 9 and s.610", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "financial_statements_not_audited", "type": null, "when": "No auditor's report and the company is not dormant." }, { "code": "directors_signatures_insufficient", "type": null, "when": "Too few directors signed the statement of financial position." }, { "code": "agm_period_exceeded", "type": null, "when": "agm_date is after the s.610 period; a director must acknowledge." } ] } }, "Params_hk_financial_statements_prepare": { "type": "object", "properties": { "financial_year_start": { "type": "string", "format": "date", "description": "First day of the financial year." }, "financial_year_end": { "type": "string", "format": "date", "description": "Accounting reference date." }, "reporting_framework": { "type": "string", "description": "Framework the directors adopt, for example HKFRS Accounting Standards or HKFRS for Private Entities." }, "reporting_exemption": { "type": "string", "enum": [ "none", "small_private_company", "other_private_company_unanimous_consent", "eligible_private_company", "small_guarantee_company" ], "description": "Simplified reporting under ss.359-366." }, "dormant": { "type": "boolean", "description": "s.5 dormancy resolution delivered: audit exempt." }, "auditor_choice": { "type": "string", "enum": [ "entiva_partner_cpa", "customer_nominated_cpa" ], "description": "entiva_partner_cpa or customer_nominated_cpa." }, "auditor_afrc_registration_number": { "type": "string", "description": "AFRC registration of the CPA firm or practising certificate; required for a nominated auditor." }, "accounting_records_source": { "type": "string", "enum": [ "entiva_ledger", "customer_upload", "customer_system_sync" ], "description": "Where the books come from." }, "engagement_scope": { "type": "array", "items": {}, "description": "Any of: statutory_audit, directors_report_draft, tax_computation, ixbrl_supporting_documents." } }, "required": [ "financial_year_start", "financial_year_end", "reporting_framework", "auditor_choice", "accounting_records_source", "engagement_scope" ], "description": "Engage a practising CPA to prepare and audit the annual statements, with draft directors' report, tax computation and iXBRL files." }, "Create_hk_financial_statements_prepare": { "type": "object", "properties": { "type": { "const": "hk.financial_statements.prepare" }, "params": { "$ref": "#/components/schemas/Params_hk_financial_statements_prepare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare and audit the annual financial statements", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Audit engagement letter", "source": "generated", "required": true }, { "key": "trial_balance_and_ledgers", "title": "Trial balance, ledgers and supporting records", "source": "uploaded", "required": false }, { "key": "draft_financial_statements", "title": "Draft financial statements", "source": "generated", "required": true }, { "key": "tax_computation", "title": "Profits tax computation", "source": "generated", "required": false }, { "key": "ixbrl_supporting_documents", "title": "Statements and computation in iXBRL", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "engagement_letter", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None at this step. Signed statements go later to the CR", "form": "Audited financial statements, directors' report and auditor's report", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "auditor_not_eligible", "type": null, "when": "Not a practising CPA or registered CPA firm on the AFRC registers." }, { "code": "accounting_records_incomplete", "type": null, "when": "Records cannot support an audit; gaps listed in requirements." }, { "code": "dormant_audit_exempt", "type": null, "when": "Dormant company: no audit needed." } ] } }, "Params_hk_financial_statements_revision_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_shares", "guarantee_company" ], "description": "Companies that deliver financial statements under s.664." }, "financial_period_start": { "type": "string", "format": "date", "description": "Start of the period the statements cover." }, "financial_period_end": { "type": "string", "format": "date", "description": "End of that period." }, "original_delivery_date": { "type": "string", "format": "date", "description": "When the statements were delivered." }, "decision_date": { "type": "string", "format": "date", "description": "Date the directors decided to revise (s.449); NAC3 is due 7 days later." }, "defect_description": { "type": "string", "description": "What is wrong; kept for the auditor and file, not on NAC3." } }, "required": [ "entity_type", "financial_period_start", "financial_period_end", "original_delivery_date", "decision_date", "defect_description" ], "description": "Files NAC3 within 7 days after the directors decide to revise financial statements already delivered with the annual return. It only warns; the revision follows separately." }, "Create_hk_financial_statements_revision_notify": { "type": "object", "properties": { "type": { "const": "hk.financial_statements_revision.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_financial_statements_revision_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give the warning statement that delivered financial statements will be revised", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "public_ltd_shares", "guarantee_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_decision", "title": "Directors' decision to revise", "source": "generated", "required": true }, { "key": "warning_statement", "title": "Form NAC3", "source": "generated", "required": true }, { "key": "revised_financial_statements", "title": "Revised statements with auditor's report", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "warning_statement", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAC3 - Statement of Revision of Financial Statements", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 7 days after decision_date; filed and flagged late" }, { "code": "financial_statements_not_delivered", "type": null, "when": "No s.664 delivery on record" } ] } }, "Params_hk_fsie_chargeability_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company", "foreign_company" ], "description": "Entity type." }, "year_of_assessment": { "type": "string", "description": "YYYY/YY of the year of receipt." }, "basis_period_end": { "type": "string", "format": "date", "description": "End of the basis period; the notice is due 4 months later." }, "is_mne_entity": { "type": "boolean", "description": "Entity is, or acts for, an MNE group entity." }, "income_received": { "type": "array", "items": {}, "description": "Items: type, amount, source_country, accrued_on, received_in_hk_on." }, "no_exemption_reason": { "type": "string", "enum": [ "economic_substance_not_met", "participation_requirement_not_met", "nexus_requirement_not_met", "other" ], "description": "Why no exception applies." }, "no_return_issued_confirmed": { "type": "boolean", "description": "No return was issued for the year of receipt." } }, "required": [ "entity_type", "year_of_assessment", "basis_period_end", "is_mne_entity", "income_received", "no_exemption_reason", "no_return_issued_confirmed" ], "description": "Writes to the Commissioner when an MNE entity received non-exempt foreign-sourced income and the IRD issued no profits tax return for the year of receipt." }, "Create_hk_fsie_chargeability_notify": { "type": "object", "properties": { "type": { "const": "hk.fsie_chargeability.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_fsie_chargeability_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify chargeability on foreign-sourced income", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notification_letter", "title": "Written notification of chargeability", "source": "generated", "required": true }, { "key": "income_evidence", "title": "Dividend or interest advices, bank statements", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notification_letter", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "Written notice of chargeability", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "return_already_issued", "type": null, "when": "no_return_issued_confirmed is false" }, { "code": "deadline_passed", "type": null, "when": "More than 4 months after the basis period; Entiva files and flags it" } ] } }, "Params_hk_fsie_economic_substance_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company", "foreign_company" ], "description": "Entity type." }, "year_of_assessment": { "type": "string", "description": "YYYY/YY of the return." }, "basis_period_end": { "type": "string", "format": "date", "description": "End of the basis period." }, "is_mne_entity": { "type": "boolean", "description": "Entity is, or acts for, an MNE group entity (IRO s.15H)." }, "income_received": { "type": "array", "items": {}, "description": "Items: type, amount, source_country, accrued_on, received_in_hk_on." }, "exemption_route": { "type": "array", "items": {}, "description": "Any of economic_substance, nexus_requirement, participation_requirement, intra_group_transfer_relief." }, "activity_profile": { "type": "string", "enum": [ "pure_equity_holding", "other_activities" ], "description": "Pure equity holders earn only dividends, equity gains and incidental income; the test differs." }, "hk_substance": { "type": "object", "description": "employees, operating_expenditure, premises." }, "outsourced_activities": { "type": "boolean", "description": "True makes the outsourcing agreement mandatory evidence." } }, "required": [ "entity_type", "year_of_assessment", "basis_period_end", "is_mne_entity", "income_received", "exemption_route", "activity_profile", "hk_substance", "outsourced_activities" ], "description": "Prepares the FSIE disclosure and economic-substance evidence for an MNE entity and files them with its profits tax return. Hong Kong has no standalone economic substance filing." }, "Create_hk_fsie_economic_substance_file": { "type": "object", "properties": { "type": { "const": "hk.fsie_economic_substance.file" }, "params": { "$ref": "#/components/schemas/Params_hk_fsie_economic_substance_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report foreign-sourced income and evidence economic substance", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "substance_evidence", "title": "Economic substance evidence", "source": "uploaded", "required": true }, { "key": "ird_service_agent_appointment", "title": "Appointment of Entiva in the IRD portal", "source": "uploaded", "required": true }, { "key": "fsie_disclosure", "title": "FSIE disclosure for the return", "source": "generated", "required": true }, { "key": "substance_memo", "title": "Economic substance memo", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fsie_disclosure", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "Profits tax return with the IRD's designated FSIE form", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_mne_entity", "type": null, "when": "is_mne_entity is false; FSIE does not apply" }, { "code": "profits_tax_return_not_issued", "type": null, "when": "No return exists; use hk.fsie_chargeability.notify" } ] } }, "Params_hk_guarantee_company_annual_return_file": { "type": "object", "properties": { "accounting_reference_period_end": { "type": "string", "format": "date", "description": "End of the accounting reference period." }, "financial_statements_period_start": { "type": "string", "format": "date", "description": "Start of the period covered." }, "financial_statements_period_end": { "type": "string", "format": "date", "description": "End of the period covered." }, "nature_of_business": { "type": "string", "description": "{code, description} from the CR business nature list." }, "contact": { "type": "object", "description": "{email, hk_phone} for NAR1 items 7 and 8." }, "mortgages_and_charges_total": { "$ref": "#/components/schemas/Money", "description": "Total indebtedness on registrable charges." }, "number_of_members": { "type": "integer", "description": "Members at the return date." }, "company_records_locations": { "type": "array", "items": {}, "description": "{record, address} for records not at the registered office." }, "financial_statements_source": { "type": "string", "enum": [ "hk_action", "uploaded" ], "description": "hk_action: output of hk.financial_statements.approve; or uploaded." }, "signing_route": { "type": "string", "enum": [ "partner_as_company_secretary", "director_personally" ], "description": "partner_as_company_secretary or director_personally." }, "late_fee_acknowledged": { "type": "boolean", "description": "True to proceed after the 42 days; a higher fee applies." } }, "required": [ "accounting_reference_period_end", "financial_statements_period_start", "financial_statements_period_end", "nature_of_business", "contact", "number_of_members", "financial_statements_source" ], "description": "File NAR1 for a company limited by guarantee with certified accounts within 42 days after the return date." }, "Create_hk_guarantee_company_annual_return_file": { "type": "object", "properties": { "type": { "const": "hk.guarantee_company_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_guarantee_company_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Annual return, company limited by guarantee", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "guarantee_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_attestation", "title": "Director's confirmation of the return", "source": "generated", "required": true }, { "key": "financial_statements_pack", "title": "Certified copies of financial statements, directors' report and auditor's report", "source": "uploaded", "required": true }, { "key": "nar1_form", "title": "Form NAR1", "source": "generated", "required": true }, { "key": "nar1_receipt", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "director_attestation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "financial_statements_pack", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nar1_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nar1_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAR1 with certified financial statements", "channel": "online", "government_fee": { "amount": 105, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "financial_statements_not_approved", "type": null, "when": "Statements not yet approved and signed; complete hk.financial_statements.approve." }, { "code": "filing_deadline_passed", "type": null, "when": "The 42 days have ended; set late_fee_acknowledged." }, { "code": "register_mismatch", "type": null, "when": "Entiva's registers differ from the CR record; reconcile first." } ] } }, "Params_hk_letter_of_confirmation_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "description": "Entity type." }, "confirmation_type": { "type": "string", "enum": [ "br_number_replaced_company_number", "company_dissolved", "never_registered", "not_struck_off", "no_deregistration_application", "no_record_of_document" ], "description": "The one fact to confirm." }, "name": { "type": "string", "description": "Name as on the register." }, "br_number": { "type": "string", "description": "First 8 digits of the BR number; required except for never_registered." }, "document_name": { "type": "string", "description": "Required for no_record_of_document." }, "recipient_email": { "type": "string", "description": "Where the Registry emails the letter." } }, "required": [ "entity_type", "confirmation_type", "name", "recipient_email" ], "description": "Requests a Registry letter confirming one fact about one company, such as dissolution or no record of a document. Emailed, never on paper." }, "Create_hk_letter_of_confirmation_request": { "type": "object", "properties": { "type": { "const": "hk.letter_of_confirmation.request" }, "params": { "$ref": "#/components/schemas/Params_hk_letter_of_confirmation_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request a Companies Registry letter of confirmation", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "letter_of_confirmation", "title": "Letter of confirmation", "source": "registry_issued", "required": true } ], "people": [], "approvals": [], "signatures": [ { "document_key": "letter_of_confirmation", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Public Search Section", "form": "Application Form for Letter of Confirmation", "channel": "both", "government_fee": { "amount": 130, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "confirmation_not_available", "type": null, "when": "The register does not support the requested fact; the Registry may refuse" }, { "code": "recipient_email_required", "type": null, "when": "No email address given" } ] } }, "Params_hk_lpf_annual_return_file": { "type": "object", "properties": { "anniversary_date": { "type": "string", "format": "date", "description": "Anniversary of the date the certificate of registration was issued." }, "operated_as_fund_in_prior_12_months": { "type": "boolean", "description": "GP's statement for the 12 months before the anniversary." }, "expects_to_operate_in_next_12_months": { "type": "boolean", "description": "GP's assessment for the 12 months after." }, "signing_route": { "type": "string", "enum": [ "general_partner_personally", "authorized_representative" ], "description": "general_partner_personally or authorized_representative." }, "late_fee_acknowledged": { "type": "boolean", "description": "True to proceed after the 42 days; a higher fee applies." } }, "required": [ "anniversary_date", "operated_as_fund_in_prior_12_months", "expects_to_operate_in_next_12_months" ], "description": "File LPF5 with the general partner's statement on whether the fund operated, within 42 days after each registration anniversary." }, "Create_hk_lpf_annual_return_file": { "type": "object", "properties": { "type": { "const": "hk.lpf_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return of a limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_statement", "title": "General partner's annual statement", "source": "generated", "required": true }, { "key": "lpf5_form", "title": "Form LPF5", "source": "generated", "required": true }, { "key": "lpf5_receipt", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf5_form", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf5_form", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF5 Annual Return of Limited Partnership Fund", "channel": "online", "government_fee": { "amount": 105, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "filing_deadline_passed", "type": null, "when": "The 42 days have ended; the GP risks prosecution and default fines." }, { "code": "gp_signatory_not_registered_user", "type": null, "when": "No registered CR user is linked to the general partner." }, { "code": "entity_type_not_supported", "type": null, "when": "Not a limited partnership fund." } ] } }, "Params_hk_lpf_registered_office_change": { "type": "object", "properties": { "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office." }, "principal_place_of_business_address": { "$ref": "#/components/schemas/Address", "description": "New principal place of business." }, "records_location": { "$ref": "#/components/schemas/Address", "description": "New Hong Kong place for the section 29 records." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change." }, "provider": { "type": "string", "enum": [ "entiva_partner", "company_own_premises", "third_party_provider" ], "description": "Who provides the address." }, "provider_licence_number": { "type": "string", "description": "TCSP licence or professional registration number of a third-party provider." } }, "required": [ "effective_date", "provider" ], "description": "Notify the Registrar of a limited partnership fund's new registered office, principal place of business or records location." }, "Create_hk_lpf_registered_office_change": { "type": "object", "properties": { "type": { "const": "hk.lpf_registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered office of a limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_resolution", "title": "General partner's decision", "source": "generated", "required": true }, { "key": "lpf4a_form", "title": "Form LPF4A", "source": "generated", "required": true }, { "key": "lpf4a_receipt", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf4a_form", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf4a_form", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF4A Notification of Change in Address, Location of Records and Investment Scope of ", "channel": "online", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_is_po_box_or_care_of", "type": null, "when": "The address is a PO box or care-of address." }, { "code": "filing_out_of_time", "type": null, "when": "effective_date is over 15 days ago; filed late and reported." }, { "code": "investment_scope_change_not_supported", "type": null, "when": "LPF4A also covers investment scope; this action handles address and records only." } ] } }, "Params_hk_money_lender_changes_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "description": "Licensee type." }, "licence_number": { "type": "string", "description": "Licence number." }, "change_type": { "type": "string", "enum": [ "director_change", "shareholder_change", "registered_office_change", "business_name_change", "other_registered_particulars" ], "description": "New or substituted premises need an endorsement application instead." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; the notice is due 21 days later." }, "details": { "type": "string", "description": "Before and after." } }, "required": [ "entity_type", "licence_number", "change_type", "effective_date", "details" ], "description": "Sends the written notice due within 21 days of a change in a licensee's registered particulars, separately from any ND2A or ND2B." }, "Create_hk_money_lender_changes_notify": { "type": "object", "properties": { "type": { "const": "hk.money_lender_changes.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_money_lender_changes_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar of Money Lenders of a change in registered particulars", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_letter", "title": "Notice of change", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_letter", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry Money Lenders Section", "form": "Written notice", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 21 days after the change; Entiva files and warns" }, { "code": "needs_endorsement", "type": null, "when": "The change is new or substituted premises" } ] } }, "Params_hk_money_lender_exemption_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "description": "Applicant type." }, "licence_number": { "type": "string", "description": "Licence number if the applicant is licensed." }, "renewal_of_exemption": { "type": "boolean", "description": "True when renewing an s.33B exemption." }, "existing_exemption_number": { "type": "string", "description": "Required when renewing." }, "previously_revoked": { "type": "boolean", "description": "Whether any earlier s.33B exemption was revoked." }, "provisions_and_reasons": { "type": "array", "items": {}, "description": "{provision, reason} rows; not needed for a renewal on identical provisions and reasons." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Applicant, or a person the company authorises, who signs." } }, "required": [ "entity_type", "renewal_of_exemption", "previously_revoked", "authorised_signatory" ], "description": "Prepares Form 11, the s.33B application for exemption from named provisions of the Money Lenders Ordinance, or the renewal of an exemption. The Registrar decides." }, "Create_hk_money_lender_exemption_apply": { "type": "object", "properties": { "type": { "const": "hk.money_lender_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_money_lender_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to be exempted from provisions of the Money Lenders Ordinance", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_application", "title": "Form 11 in triplicate", "source": "generated", "required": true }, { "key": "authorisation_evidence", "title": "Evidence of the signer's authority", "source": "uploaded", "required": false }, { "key": "exemption_decision", "title": "Registrar's decision", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "exemption_application", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry Money Lenders Section", "form": "Form 11 - Application", "channel": "paper", "government_fee": { "amount": 770, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "reasons_required", "type": null, "when": "No provisions and reasons, and not an identical renewal" }, { "code": "exemption_number_required", "type": null, "when": "Renewal without the existing exemption number" } ] } }, "Params_hk_money_lender_licence_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "description": "Applicant type." }, "applicant_name_en": { "type": "string", "description": "English name of the company, proprietor or firm." }, "business_premises": { "type": "array", "items": {}, "description": "Each place of business: {address, telephone}." }, "applicant_persons": { "type": "array", "items": {}, "description": "per_ ids: all current directors, the proprietor, or all partners." }, "other_persons": { "type": "array", "items": {}, "description": "Others who may grant loans, take an active part or control the business: {person, role}." }, "principal_shareholders": { "type": "array", "items": {}, "description": "Company: six principal shareholders {holder, shares_held, total_shares_issued, beneficial_owner if nominee}." }, "prior_applications": { "type": "array", "items": {}, "description": "Earlier licence applications by the applicant or its group: {applicant, date, successful, reason}." }, "convictions": { "type": "array", "items": {}, "description": "Non-traffic convictions of directors or controllers: {person, offence, penalty, date, court}." }, "bank_accounts": { "type": "array", "items": {}, "description": "{bank_name, bank_address, account_number, opened_on} of the money-lending account." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director, proprietor or partner who signs." } }, "required": [ "entity_type", "applicant_name_en", "business_premises", "applicant_persons", "prior_applications", "convictions", "bank_accounts", "authorised_signatory" ], "description": "Lodges a new money lender's licence application with the Registrar of Money Lenders and the Police; the Licensing Court decides. Companies use Forms 3 and 5, others Forms 2 and 4." }, "Create_hk_money_lender_licence_apply": { "type": "object", "properties": { "type": { "const": "hk.money_lender_licence.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_money_lender_licence_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a money lender's licence", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_form", "title": "Form 3 or Form 2, with SIS-1/1A or SIS-2/2A", "source": "generated", "required": true }, { "key": "statement_in_support", "title": "Form 5 or Form 4 statement in support", "source": "generated", "required": true }, { "key": "business_plan", "title": "Business plan", "source": "uploaded", "required": true }, { "key": "authorisation_evidence", "title": "Evidence of the signer's authority", "source": "uploaded", "required": false }, { "key": "police_supporting_documents", "title": "Documents for the Commissioner of Police", "source": "uploaded", "required": true }, { "key": "money_lenders_licence", "title": "Money lender's licence", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "statement_in_support", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry Money Lenders Section", "form": "Form 3 or 2, with Form 5 or 4, SIS sheets and business plan", "channel": "paper", "government_fee": { "amount": 8800, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "premises_po_box_not_accepted", "type": null, "when": "An address is a P.O. box" }, { "code": "police_documents_missing", "type": null, "when": "Police supporting documents incomplete" } ] } }, "Params_hk_money_lender_licence_renew": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "description": "Licensee type." }, "licence_number": { "type": "string", "description": "Licence to renew." }, "licence_expiry_date": { "type": "string", "format": "date", "description": "Expiry date; the window opens 3 months before." }, "business_premises": { "type": "array", "items": {}, "description": "Current places of business: {address, telephone}." }, "applicant_persons": { "type": "array", "items": {}, "description": "per_ ids: current directors, the licensee, or all partners." }, "principal_shareholders_changed": { "type": "boolean", "description": "Company: any change in the six principal shareholders since issue or last renewal." }, "principal_shareholders": { "type": "array", "items": {}, "description": "Required if changed: {holder, shares_held, total_shares_issued}." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director, licensee or partner who signs." } }, "required": [ "entity_type", "licence_number", "licence_expiry_date", "business_premises", "applicant_persons", "principal_shareholders_changed", "authorised_signatory" ], "description": "Lodges the renewal of a money lender's licence within the 3 months before expiry. Companies use Forms 7 and 9, others Forms 6 and 8." }, "Create_hk_money_lender_licence_renew": { "type": "object", "properties": { "type": { "const": "hk.money_lender_licence.renew" }, "params": { "$ref": "#/components/schemas/Params_hk_money_lender_licence_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a money lender's licence", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_form", "title": "Form 7 or Form 6, with SIS-3/3A or SIS-4/4A", "source": "generated", "required": true }, { "key": "statement_in_support", "title": "Form 9 or Form 8 statement", "source": "generated", "required": true }, { "key": "authorisation_evidence", "title": "Evidence of the signer's authority", "source": "uploaded", "required": false }, { "key": "police_supporting_documents", "title": "Documents for the Commissioner of Police", "source": "uploaded", "required": true }, { "key": "money_lenders_licence", "title": "Renewed licence", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "statement_in_support", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry Money Lenders Section", "form": "Form 7 or 6, with Form 9 or 8 and SIS-3/3A or SIS-4/4A", "channel": "paper", "government_fee": { "amount": 8800, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "renewal_window_not_open", "type": null, "when": "More than 3 months before expiry; Entiva schedules it" }, { "code": "licence_expired", "type": null, "when": "Licence has expired; use hk.money_lender_licence.apply" } ] } }, "Params_hk_money_lender_third_party_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "description": "Licensee type." }, "licence_number": { "type": "string", "description": "Money lender number." }, "operation": { "type": "string", "enum": [ "appoint", "change_particulars", "terminate" ], "description": "appoint files ML-ATP-1, change_particulars ML-ATP-2, terminate ML-ATP-3." }, "licensee_enquiry_telephone": { "type": "string", "description": "Telephone for enquiries." }, "third_party_kind": { "type": "string", "enum": [ "individual", "body_corporate_or_firm" ], "description": "Individual, or body corporate, sole proprietorship, partnership or other body." }, "third_party_name": { "type": "string", "description": "Name." }, "third_party_address": { "$ref": "#/components/schemas/Address", "description": "Address." }, "third_party_id": { "type": "object", "description": "Individuals: {type: hkid|passport, number, passport_country, submission: original_in_person|copy_submitted}." }, "effective_date": { "type": "string", "format": "date", "description": "For terminate: when the appointment ends." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Licensee or authorised person who signs." } }, "required": [ "entity_type", "licence_number", "operation", "third_party_kind", "third_party_name", "third_party_address", "authorised_signatory" ], "description": "Files ML-ATP-1, -2 or -3 to tell the Registrar of a third party the licensee appoints to procure, negotiate or guarantee loans." }, "Create_hk_money_lender_third_party_notify": { "type": "object", "properties": { "type": { "const": "hk.money_lender_third_party.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_money_lender_third_party_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the appointment, change or termination of a licensee's appointed third party", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "atp_notice", "title": "ML-ATP-1, ML-ATP-2 or ML-ATP-3", "source": "generated", "required": true }, { "key": "third_party_id_copy", "title": "Copy of the third party's ID", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "atp_notice", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "atp_notice", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry Money Lenders Section", "form": "ML-ATP-1 / ML-ATP-2 / ML-ATP-3", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "third_party_id_missing", "type": null, "when": "An individual third party has no ID number" }, { "code": "licence_not_found", "type": null, "when": "Licence number not on the register" } ] } }, "Params_hk_profits_tax_chargeability_unincorporated_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership", "lp" ], "description": "Unincorporated business." }, "year_of_assessment": { "type": "string", "description": "YYYY/YY of the basis period." }, "basis_period_end": { "type": "string", "format": "date", "description": "Notice must reach the IRD within 4 months after it." }, "return_not_received_confirmed": { "type": "boolean", "description": "The IRD has issued no return for the year." }, "nature_of_business": { "type": "string", "description": "What the business does." }, "taxpayer": { "type": "string", "pattern": "^per_", "description": "Proprietor, or the precedent partner." } }, "required": [ "entity_type", "year_of_assessment", "basis_period_end", "return_not_received_confirmed", "nature_of_business", "taxpayer" ], "description": "Writes to the Commissioner within 4 months after the basis period to report assessable profits and ask for a return." }, "Create_hk_profits_tax_chargeability_unincorporated_notify": { "type": "object", "properties": { "type": { "const": "hk.profits_tax_chargeability_unincorporated.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_profits_tax_chargeability_unincorporated_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify chargeability to profits tax when no return was issued", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "sole_proprietorship", "general_partnership", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notification_letter", "title": "Notification of chargeability", "source": "generated", "required": true } ], "people": [ { "role": "tax_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notification_letter", "signer_role": "tax_agent", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "Written notice of chargeability", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "return_already_issued", "type": null, "when": "A return exists; file it instead" }, { "code": "deadline_passed", "type": null, "when": "More than 4 months after the basis period; sent and flagged" } ] } }, "Params_hk_profits_tax_return_file": { "type": "object", "properties": { "year_of_assessment": { "type": "string", "description": "April to March year, for example 2025/26." }, "basis_period_start": { "type": "string", "format": "date", "description": "Start of the basis period." }, "basis_period_end": { "type": "string", "format": "date", "description": "End of the basis period." }, "return_form": { "type": "string", "enum": [ "BIR51", "BIR52", "other_as_issued" ], "description": "BIR51 corporations incl. registered non-Hong Kong companies; BIR52 persons other than corporations; other_as_issued if the IRD issued another form." }, "compliance_date": { "type": "string", "format": "date", "description": "Due date on the return or Notice, read from the BTP message box." }, "filing_mode": { "type": "string", "enum": [ "electronic_ixbrl", "semi_electronic", "paper" ], "description": "electronic_ixbrl; semi_electronic; paper." }, "is_part_4aa_entity": { "type": "boolean", "description": "Constituent entity of an in-scope multinational group; must e-file from 2025/26 with listed exceptions." }, "signing_route": { "type": "string", "enum": [ "service_provider", "taxpayer_signs" ], "description": "service_provider: Entiva furnishes the return under a signed IR1476. taxpayer_signs: a director, secretary or manager signs in BTP." }, "appoint_tax_representative": { "type": "boolean", "description": "Appoint Entiva as tax representative; needs the taxpayer's signed written authorisation." }, "block_extension": { "type": "boolean", "description": "Use the Block Extension Scheme as tax representative." }, "audited_financial_statements": { "type": "string", "pattern": "^doc_", "description": "Certified copies." }, "tax_computation": { "type": "string", "pattern": "^doc_", "description": "Computation with supporting schedules." }, "supplementary_forms": { "type": "array", "items": {}, "description": "{code S1-S22, xml_document}." }, "assessable_profits": { "$ref": "#/components/schemas/Money", "description": "Current-year assessable profits in whole HKD." }, "adjusted_loss": { "$ref": "#/components/schemas/Money", "description": "Current-year adjusted loss, excluding losses brought forward." }, "industry_code": { "type": "string", "description": "Latest 6-digit HKSIC code of the principal activity; 000000 if none." }, "dormant_company": { "type": "boolean", "description": "s.5 dormancy resolution delivered: the IRD accepts the return without audited statements." } }, "required": [ "year_of_assessment", "basis_period_start", "basis_period_end", "return_form", "compliance_date", "filing_mode", "tax_computation", "industry_code" ], "description": "File the IRD profits tax return with accounts, tax computation and supplementary forms as service provider or tax representative." }, "Create_hk_profits_tax_return_file": { "type": "object", "properties": { "type": { "const": "hk.profits_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_profits_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the profits tax return", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "general_partnership", "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ir1476", "title": "IR1476 Confirmation for Engagement of Service Provider to Furnish Return", "source": "uploaded", "required": false }, { "key": "tax_return_authorisation", "title": "Taxpayer's written authorisation of the tax representative", "source": "uploaded", "required": false }, { "key": "profits_tax_return", "title": "BIR51 or BIR52", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "IRD acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ir1476", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "tax_return_authorisation", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "profits_tax_return", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "profits_tax_return", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "BIR51 or BIR52 with supplementary forms S1-S22, IR1476, and IR1477 on paper", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "btp_service_agent_not_appointed", "type": null, "when": "Entiva is not appointed in BTP Manage Service Agent." }, { "code": "ir1476_missing", "type": null, "when": "No signed IR1476 for this year of assessment." }, { "code": "mandatory_efiling_required", "type": null, "when": "A Part 4AA entity chose paper or semi-electronic without a listed exception." } ] } }, "Params_hk_profits_tax_return_unincorporated_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership", "lp" ], "description": "Partnerships file BIR52; sole proprietors report in Part 5 of BIR60." }, "year_of_assessment": { "type": "string", "description": "YYYY/YY." }, "basis_period_end": { "type": "string", "format": "date", "description": "End of the basis period." }, "return_issued_date": { "type": "string", "format": "date", "description": "When the IRD issued the return; if none, use hk.profits_tax_chargeability_unincorporated.notify." }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Above HK$2,000,000 the accounts go in with the return." }, "assessable_profits_or_adjusted_loss": { "$ref": "#/components/schemas/Money", "description": "Negative for an adjusted loss." }, "accounts_prepared": { "type": "boolean", "description": "Accounts exist." }, "precedent_partner": { "type": "string", "pattern": "^per_", "description": "Partnerships: completes and signs BIR52; for an LP normally a general partner." }, "partners": { "type": "array", "items": {}, "description": "Partnerships: {person, profit_share_percent}." }, "proprietor": { "type": "string", "pattern": "^per_", "description": "Sole proprietorships." } }, "required": [ "entity_type", "year_of_assessment", "basis_period_end", "return_issued_date", "gross_income", "assessable_profits_or_adjusted_loss", "accounts_prepared" ], "description": "Files BIR52 or the business part of BIR60 from the accounts and a tax computation." }, "Create_hk_profits_tax_return_unincorporated_file": { "type": "object", "properties": { "type": { "const": "hk.profits_tax_return_unincorporated.file" }, "params": { "$ref": "#/components/schemas/Params_hk_profits_tax_return_unincorporated_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the profits tax return for a partnership or sole proprietorship", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "sole_proprietorship", "general_partnership", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "business_accounts", "title": "Business accounts", "source": "uploaded", "required": true }, { "key": "tax_computation", "title": "Profits tax computation (IR957A proforma)", "source": "generated", "required": true }, { "key": "tax_return", "title": "BIR52 or BIR60 Part 5", "source": "generated", "required": true }, { "key": "ird_service_agent_appointment", "title": "Appointment of Entiva in the IRD portal", "source": "uploaded", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tax_return", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "BIR52", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "accounts_missing", "type": null, "when": "No accounts, or income above HK$2,000,000 without them" }, { "code": "precedent_partner_required", "type": null, "when": "A partnership has no precedent partner" } ] } }, "Params_hk_public_company_annual_return_file": { "type": "object", "properties": { "accounting_reference_period_end": { "type": "string", "format": "date", "description": "End of the accounting reference period." }, "financial_statements_period_start": { "type": "string", "format": "date", "description": "Start of the period covered." }, "financial_statements_period_end": { "type": "string", "format": "date", "description": "End of the period covered." }, "nature_of_business": { "type": "string", "description": "{code, description} from the CR business nature list." }, "contact": { "type": "object", "description": "{email, hk_phone} for NAR1 items 7 and 8." }, "mortgages_and_charges_total": { "$ref": "#/components/schemas/Money", "description": "Total indebtedness on registrable charges." }, "share_capital": { "type": "array", "items": {}, "description": "Per class: class, currency, total_number, total_amount, total_paid_up." }, "listed_company": { "type": "boolean", "description": "Listed companies report only holders of 5% or more." }, "company_records_locations": { "type": "array", "items": {}, "description": "{record, address} for records not at the registered office." }, "financial_statements_source": { "type": "string", "enum": [ "hk_action", "uploaded" ], "description": "hk_action: output of hk.financial_statements.approve; or uploaded." }, "signing_route": { "type": "string", "enum": [ "partner_as_company_secretary", "director_personally" ], "description": "partner_as_company_secretary or director_personally." }, "late_fee_acknowledged": { "type": "boolean", "description": "True to proceed after the 42 days; a higher fee applies." } }, "required": [ "accounting_reference_period_end", "financial_statements_period_start", "financial_statements_period_end", "nature_of_business", "contact", "share_capital", "financial_statements_source" ], "description": "File NAR1 for a public company with certified accounts within 42 days after the return date." }, "Create_hk_public_company_annual_return_file": { "type": "object", "properties": { "type": { "const": "hk.public_company_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_public_company_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Annual return, public company", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_attestation", "title": "Director's confirmation of the return", "source": "generated", "required": true }, { "key": "financial_statements_pack", "title": "Certified copies of financial statements, directors' report and auditor's report", "source": "uploaded", "required": true }, { "key": "nar1_form", "title": "Form NAR1", "source": "generated", "required": true }, { "key": "nar1_receipt", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "director_attestation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "financial_statements_pack", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nar1_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nar1_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAR1 with certified financial statements", "channel": "online", "government_fee": { "amount": 140, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "financial_statements_not_approved", "type": null, "when": "Statements not yet approved and signed; complete hk.financial_statements.approve." }, { "code": "filing_deadline_passed", "type": null, "when": "The 42 days have ended; set late_fee_acknowledged." }, { "code": "register_mismatch", "type": null, "when": "Entiva's registers differ from the CR record; reconcile first." } ] } }, "Params_hk_registered_non_hk_company_annual_return_file": { "type": "object", "properties": { "anniversary_date": { "type": "string", "format": "date", "description": "Latest anniversary of Part 16 registration." }, "place_of_incorporation": { "type": "string", "description": "Item 4." }, "principal_place_of_business_hk": { "$ref": "#/components/schemas/Address", "description": "Item 5." }, "contact": { "type": "object", "description": "{email, hk_phone} (items 5, 5)." }, "registered_office_abroad": { "$ref": "#/components/schemas/Address", "description": "Registered office or equivalent in the place of incorporation; no care-of (item 6)." }, "authorised_representatives": { "type": "array", "items": {}, "description": "Hong Kong-resident individuals, or solicitor or CPA firms." }, "share_capital": { "type": "object", "description": "{authorised, issued} as money, or omit if not applicable." }, "mortgages_and_charges_total": { "$ref": "#/components/schemas/Money", "description": "Total indebtedness on charges registrable under Part 8." }, "accounts_option": { "type": "string", "enum": [ "published_accounts_delivered", "not_required_by_foreign_law", "incorporated_under_18_months" ], "description": "published_accounts_delivered; not_required_by_foreign_law; incorporated_under_18_months." }, "accounts_period": { "type": "object", "description": "{start, end}; at least 12 months, for published accounts." }, "signing_route": { "type": "string", "enum": [ "authorized_representative", "officer_personally" ], "description": "authorized_representative or officer_personally." }, "late_fee_acknowledged": { "type": "boolean", "description": "True to proceed after the 42 days; a higher fee applies." } }, "required": [ "anniversary_date", "place_of_incorporation", "principal_place_of_business_hk", "contact", "registered_office_abroad", "authorised_representatives", "accounts_option" ], "description": "File NN3 for a Part 16 company within 42 days after each Hong Kong registration anniversary, with published accounts where s.789 applies." }, "Create_hk_registered_non_hk_company_annual_return_file": { "type": "object", "properties": { "type": { "const": "hk.registered_non_hk_company_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_registered_non_hk_company_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_attestation", "title": "Officer's confirmation of the return", "source": "generated", "required": true }, { "key": "published_accounts", "title": "Certified true copy of the latest published accounts", "source": "uploaded", "required": false }, { "key": "nn3_form", "title": "Form NN3", "source": "generated", "required": true }, { "key": "nn3_receipt", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "director_attestation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nn3_form", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn3_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN3 Annual Return of Registered Non-Hong Kong Company", "channel": "online", "government_fee": { "amount": 180, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "accounts_required", "type": null, "when": "Published accounts were needed but not supplied." }, { "code": "authorized_representative_missing", "type": null, "when": "No Hong Kong authorized representative on record." }, { "code": "filing_deadline_passed", "type": null, "when": "The 42 days have ended; set late_fee_acknowledged." } ] } }, "Params_hk_registry_search_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "lpf", "open_ended_fund_company" ], "description": "Entity type." }, "search_type": { "type": "string", "enum": [ "company_particulars_report", "limited_partnership_inspection", "image_record" ], "description": "Company Particulars Report HK$22, Cap. 37 limited partnership inspection HK$13, or document images." }, "subject_name": { "type": "string", "description": "Company or partnership searched." }, "items": { "type": "array", "items": {}, "description": "image_record: {form_code, filing_date}." } }, "required": [ "entity_type", "search_type", "subject_name" ], "description": "Orders a paid, uncertified search: a Company Particulars Report, a Cap. 37 limited partnership inspection or document images. Results are delivered electronically." }, "Create_hk_registry_search_request": { "type": "object", "properties": { "type": { "const": "hk.registry_search.request" }, "params": { "$ref": "#/components/schemas/Params_hk_registry_search_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order an uncertified Companies Registry search", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "search_result", "title": "Search result", "source": "registry_issued", "required": true } ], "people": [], "approvals": [], "signatures": [ { "document_key": "search_result", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Company Particulars Search / Cap. 37 inspection / Image Record Search", "channel": "online", "government_fee": { "amount": 22, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "subject_not_found", "type": null, "when": "No company or partnership matches subject_name" } ] } }, "Params_hk_significant_controllers_register_change": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "Register changes." }, "knowledge_date": { "type": "string", "format": "date", "description": "Date the company first knew, or had reasonable cause to believe, of the controller or change." }, "reason": { "type": "string", "enum": [ "formation_setup", "share_transfer", "share_allotment", "control_agreement", "trust_change", "upstream_change", "annual_review", "other" ], "description": "What triggered the change." }, "send_statutory_notices": { "type": "boolean", "description": "Default true." } }, "required": [ "changes", "knowledge_date", "reason" ], "description": "Identify, notify and record people and entities that significantly control a Hong Kong company. The register is kept by the company and never filed." }, "Create_hk_significant_controllers_register_change": { "type": "object", "properties": { "type": { "const": "hk.significant_controllers_register.change" }, "params": { "$ref": "#/components/schemas/Params_hk_significant_controllers_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update the significant controllers register", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statutory_notice", "title": "Statutory notice to controller or person who may know their identity", "source": "generated", "required": true }, { "key": "controller_confirmation", "title": "Controller's confirmation of particulars", "source": "uploaded", "required": false }, { "key": "scr_extract", "title": "Register extract", "source": "generated", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statutory_notice", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "controller_confirmation", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Company register", "form": "Significant controllers register, Cap. 622 Part 12 Division 2A, Schedules 5A to 5C", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "scr_not_required_listed_company", "type": null, "when": "Shares are listed on the Stock Exchange of Hong Kong." }, { "code": "designated_representative_missing", "type": null, "when": "No designated representative on record." }, { "code": "notice_period_exceeded", "type": null, "when": "knowledge_date is over 7 days ago; a director must acknowledge the late notice." } ] } }, "Params_hk_tax_exempt_charity_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "guarantee_company", "registered_trustees_corporation", "society" ], "description": "Charitable body." }, "charitable_objects": { "type": "string", "description": "Object clause as in the governing instrument." }, "nature_of_business": { "type": "string", "description": "What the body does, has done or will do; the IRD tests activities as well as objects." }, "consent_to_publish_name": { "type": "boolean", "description": "The IRD lists recognised charities only with consent." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Where the IRD writes." }, "carries_on_trade_or_business": { "type": "boolean", "description": "Trading profits are exempt only if the proviso to s.88 is met." }, "governing_body_members": { "type": "array", "items": {}, "description": "per_ ids of directors, trustees or office-bearers." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Governing body member who signs." } }, "required": [ "entity_type", "charitable_objects", "nature_of_business", "consent_to_publish_name", "correspondence_address", "carries_on_trade_or_business", "governing_body_members", "authorised_signatory" ], "description": "Posts the application for IRD recognition as exempt from profits tax under s.88 IRO. Elective, but donors need it to claim approved donation deductions." }, "Create_hk_tax_exempt_charity_apply": { "type": "object", "properties": { "type": { "const": "hk.tax_exempt_charity.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_tax_exempt_charity_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for recognition as a tax-exempt charity", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "guarantee_company", "registered_trustees_corporation", "society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_form", "title": "IRD application form for s.88 recognition", "source": "generated", "required": true }, { "key": "governing_instrument", "title": "Governing instrument", "source": "uploaded", "required": true }, { "key": "registration_certificate", "title": "Certificate of incorporation, registration or exemption", "source": "uploaded", "required": true }, { "key": "supporting_documents", "title": "Other documents the IRD form specifies", "source": "uploaded", "required": true }, { "key": "recognition_letter", "title": "IRD recognition letter", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Commissioner of Inland Revenue", "form": "IRD application form for recognition as a charity exempt from tax under s.88", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "governing_instrument_clauses_missing", "type": null, "when": "Instrument lacks clauses the IRD expects" }, { "code": "purposes_not_exclusively_charitable", "type": null, "when": "Objects are not exclusively charitable" } ] } }, "Params_hk_top_up_tax_notification_file": { "type": "object", "properties": { "reporting_fiscal_year_end": { "type": "string", "format": "date", "description": "Last day of the fiscal year." }, "mne_group_code": { "type": "string", "description": "Group code issued on paper Form IR1485." }, "group_name": { "type": "string", "description": "Multinational group." }, "ultimate_parent_entity": { "type": "object", "description": "{name, jurisdiction, registration_number}." }, "meets_eur_750m_test": { "type": "boolean", "description": "Revenue of EUR 750m or more in at least two of the four preceding fiscal years." }, "file_as_designated_local_entity": { "type": "boolean", "description": "File for all Hong Kong constituent entities; appointed annually." }, "gir_filing_entity": { "type": "object", "description": "{name, jurisdiction} from which Hong Kong receives the GloBE Information Return." }, "part_4aa_entity_type": { "type": "string", "enum": [ "hong_kong_constituent_entity", "hong_kong_standalone_jv", "hong_kong_member_of_jv_group", "stateless_constituent_entity" ], "description": "Kind of Part 4AA entity." } }, "required": [ "reporting_fiscal_year_end", "mne_group_code", "group_name", "ultimate_parent_entity", "meets_eur_750m_test", "gir_filing_entity", "part_4aa_entity_type" ], "description": "Notify the IRD each fiscal year that a Hong Kong entity belongs to an in-scope multinational group." }, "Create_hk_top_up_tax_notification_file": { "type": "object", "properties": { "type": { "const": "hk.top_up_tax_notification.file" }, "params": { "$ref": "#/components/schemas/Params_hk_top_up_tax_notification_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Pillar Two top-up tax notification", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "general_partnership", "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "group_structure_chart", "title": "Group structure chart", "source": "uploaded", "required": true }, { "key": "designated_local_entity_resolution", "title": "Resolution appointing the designated local entity", "source": "generated", "required": false }, { "key": "notification_record", "title": "Notification as submitted", "source": "generated", "required": true }, { "key": "notification_receipt", "title": "Pillar Two Portal acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "designated_local_entity_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notification_record", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notification_record", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Pillar Two Portal", "form": "Top-up tax notification", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "mne_group_code_missing", "type": null, "when": "No IR1485 group code on record." }, { "code": "not_in_scope_group", "type": null, "when": "meets_eur_750m_test is false." }, { "code": "esignature_certificate_missing", "type": null, "when": "No authorised individual holds an e-Cert with AEOI Functions." } ] } }, "Params_hk_top_up_tax_return_file": { "type": "object", "properties": { "reporting_fiscal_year_end": { "type": "string", "format": "date", "description": "Last day of the reporting fiscal year." }, "is_transition_year": { "type": "boolean", "description": "First transition year: the deadline is 18 months, not 15." }, "scope": { "type": "string", "enum": [ "entity_return", "designated_local_entity_return" ], "description": "entity_return, or designated_local_entity_return to file for the group's Hong Kong entities." }, "notification_action": { "type": "string", "description": "act_ id of the completed notification for this year." }, "gir_xml": { "type": "string", "pattern": "^doc_", "description": "GIR in the OECD XML schema." }, "gir_filed_elsewhere": { "type": "boolean", "description": "GIR filed in a jurisdiction that exchanges it with Hong Kong, relieving the entity." }, "gir_filing_jurisdiction": { "type": "string", "description": "ISO 3166 country if gir_filed_elsewhere." }, "hkmtt_top_up_tax": { "$ref": "#/components/schemas/Money", "description": "Hong Kong minimum top-up tax, HKD." }, "qdmtt_safe_harbour_claimed": { "type": "boolean", "description": "Claim the QDMTT Safe Harbour." }, "top_up_tax_computation": { "type": "string", "pattern": "^doc_", "description": "Computation workbook and consolidation data." } }, "required": [ "reporting_fiscal_year_end", "is_transition_year", "scope", "notification_action", "hkmtt_top_up_tax", "top_up_tax_computation" ], "description": "File the Hong Kong top-up tax return with GloBE Information Return data within 15 months of year end." }, "Create_hk_top_up_tax_return_file": { "type": "object", "properties": { "type": { "const": "hk.top_up_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_top_up_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Pillar Two top-up tax return and GloBE information return", "x-entiva": { "jurisdiction": "hk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lp", "general_partnership", "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "consolidated_financial_statements", "title": "Ultimate parent's consolidated statements", "source": "uploaded", "required": true }, { "key": "designated_local_entity_resolution", "title": "Resolution appointing the designated local entity", "source": "generated", "required": false }, { "key": "return_record", "title": "Return as submitted", "source": "generated", "required": true }, { "key": "return_acknowledgement", "title": "Portal acknowledgement and assessment notice", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "designated_local_entity_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "return_record", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "return_record", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Pillar Two Portal", "form": "Top-up tax return including GloBE Information Return data, Inland Revenue Ordinance Part 4", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "portal_return_filing_not_live", "type": null, "when": "Phase 2 is not available yet; the action waits." }, { "code": "notification_missing", "type": null, "when": "No completed notification for this fiscal year." }, { "code": "gir_xml_invalid", "type": null, "when": "The GIR file fails the OECD XML schema." } ] } }, "Params_hk_agm_hold": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year this AGM is held for.", "examples": [ "2026-03-31" ] }, "is_subsidiary_of_public_company": { "type": "boolean", "description": "Set true if the company is a subsidiary of a public company, which shortens the deadline to 6 months.", "examples": [ "false" ] }, "meeting_at": { "type": "string", "description": "Start of the meeting as an ISO 8601 date-time with the Hong Kong offset.", "examples": [ "2026-12-10T14:30:00+08:00" ] }, "mode": { "type": "string", "enum": [ "physical", "hybrid", "virtual" ], "description": "physical = one or more physical venues; hybrid = physical venue plus virtual technology; virtual = technology only.", "examples": [ "hybrid" ] }, "venue": { "$ref": "#/components/schemas/Address", "description": "Physical venue.", "examples": [ "{\"line1\":\"Unit 5, 9/F, Sunrise Industrial Building\",\"line2\":\"20 Wang Chiu Road\",\"city\":\"Kowloon Bay\",\"region\":\"Kowloon\",\"country\":\"HK\"}" ] }, "virtual_meeting_technology": { "type": "string", "description": "Name of the virtual meeting technology and how to join.", "examples": [ "Entiva hosted video meeting with live voting" ] }, "agenda_items": { "type": "array", "items": {}, "description": "Business of the meeting.", "examples": [ "[{\"kind\":\"receive_financial_statements\"},{\"kind\":\"reappoint_auditor\",\"text\":\"Reappoint Harbour Audit CPA Limited as auditor\"}]" ] }, "financial_statements": { "type": "string", "pattern": "^doc_", "description": "The signed statement of financial position, directors' report and auditor's report to lay before the meeting.", "examples": [ "doc_2Qr7TnYb5Lc" ] }, "notice_method": { "type": "string", "enum": [ "electronic", "hard_copy", "website", "mixed" ], "description": "How notice reaches members. electronic relies on the articles and the member's electronic address; website notice must also notify members of the venue or.", "examples": [ "electronic" ] }, "notice_date": { "type": "string", "format": "date", "description": "Date Entiva sends the notice.", "examples": [ "2026-11-02" ] }, "short_notice": { "type": "object", "description": "Shorter AGM notice, allowed only if every member entitled to attend and vote agrees (s.571). {agreed_by_all_entitled_members: boolean, consents: array of.", "examples": [ "{\"agreed_by_all_entitled_members\":false}" ] }, "chair": { "type": "string", "pattern": "^per_", "description": "Person who will chair the meeting and sign the minutes.", "examples": [ "per_1Dv8NqZc4TgA" ] }, "proxies_allowed": { "type": "boolean", "description": "Send a proxy form with the notice.", "examples": [ "true" ] } }, "required": [ "entity_type", "financial_year_end", "meeting_at", "mode", "agenda_items", "financial_statements" ], "description": "Convenes and records an annual general meeting of a Hong Kong company: the board approves the meeting and the financial statements, Entiva issues at least 21 days' notice with the reporting documents and a proxy form, runs the meeting." }, "Create_hk_agm_hold": { "type": "object", "properties": { "type": { "const": "hk.agm.hold" }, "params": { "$ref": "#/components/schemas/Params_hk_agm_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Hold an annual general meeting", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements_package", "title": "Financial statements, directors' report and auditor's report", "source": "uploaded", "required": true }, { "key": "board_resolution_convening_agm", "title": "Board resolution convening the AGM and approving the notice", "source": "generated", "required": true }, { "key": "notice_of_agm", "title": "Notice of annual general meeting", "source": "generated", "required": true }, { "key": "proxy_form", "title": "Proxy form", "source": "generated", "required": false }, { "key": "short_notice_consents", "title": "Consents to shorter notice", "source": "uploaded", "required": false }, { "key": "attendance_and_voting_record", "title": "Attendance and voting record", "source": "generated", "required": true }, { "key": "minutes_of_agm", "title": "Minutes of the annual general meeting", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "proxy", "verification_level": "none" }, { "role": "auditor", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_convening_agm", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_agm", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "proxy_form", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes_of_agm", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None for the meeting itself. The Companies Registry receives no AGM filing", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_not_required", "type": null, "when": "[invalid_request_error] The company is dormant, has a single member (s.612), or an s.613 dispensation covers this year." }, { "code": "notice_period_too_short", "type": null, "when": "[invalid_request_error] meeting_at is less than 21 days after notice_date and short_notice is not agreed by all entitled members." }, { "code": "virtual_meeting_not_permitted", "type": null, "when": "[requirement_error] The articles preclude virtual meetings or require a physical-only meeting (s.583A)." }, { "code": "meeting_details_incomplete", "type": null, "when": "[invalid_request_error] A physical or hybrid meeting has no venue, or a hybrid or virtual meeting has no virtual_meeting_technology (s.576)." }, { "code": "financial_statements_not_signed", "type": null, "when": "[requirement_error] The financial statements are missing a director's or the auditor's signature." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] A director who must sign the convening resolution has not completed identity verification." }, { "code": "deadline_already_passed", "type": null, "when": "[requirement_error] The s.610 deadline has passed." } ] } }, "Params_hk_agm_waive": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "procedure": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "written_resolution = circulated to all members and passed when every member agrees; general_meeting = a resolution passed by all members at a general meeting.", "examples": [ "written_resolution" ] }, "resolution_wording": { "type": "string", "description": "Wording of the dispensing resolution.", "examples": [ "That the company dispenses with the holding of annual general meetings under section 613 of the Companies Ordinance." ] }, "circulation_method": { "type": "string", "enum": [ "electronic", "hard_copy", "website" ], "description": "For written_resolution: hard_copy, electronic or website.", "examples": [ "electronic" ] }, "circulation_date": { "type": "string", "format": "date", "description": "For written_resolution: date of circulation to all members.", "examples": [ "2026-10-19" ] }, "lapse_date": { "type": "string", "format": "date", "description": "For written_resolution: last day for agreement.", "examples": [ "2026-11-16" ] }, "meeting_at": { "type": "string", "description": "For general_meeting: ISO 8601 date-time with +08:00 offset.", "examples": [ "2026-11-05T11:00:00+08:00" ] }, "deliver_on_passing": { "type": "boolean", "description": "Deliver the passed resolution to the Companies Registry automatically through Entiva.", "examples": [ "true" ] } }, "required": [ "entity_type", "procedure" ], "description": "Passes a resolution of all members dispensing with the holding of AGMs, by written resolution or at a general meeting, and delivers a copy to the Companies Registry within 15 days. Entiva checks that the articles allow it, collects." }, "Create_hk_agm_waive": { "type": "object", "properties": { "type": { "const": "hk.agm.waive" }, "params": { "$ref": "#/components/schemas/Params_hk_agm_waive" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dispense with annual general meetings by resolution of all members", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing the dispensation", "source": "generated", "required": true }, { "key": "dispensation_resolution", "title": "Resolution of all members dispensing with AGMs", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "uploaded", "required": false }, { "key": "resolution_copy_for_registrar", "title": "Copy of the resolution for the Registrar", "source": "generated", "required": true }, { "key": "delivery_acknowledgement", "title": "Companies Registry acknowledgement of delivery", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dispensation_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_copy_for_registrar", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "resolution_copy_for_registrar", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "No specified form. A copy of the s.613 resolution is delivered under ss.622", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_dispensation_unnecessary", "type": null, "when": "[invalid_request_error] The company has a single member (no AGM or dispensation needed, s.612) or is dormant." }, { "code": "articles_prevent_dispensation", "type": null, "when": "[requirement_error] The articles require an AGM or forbid dispensing with one." }, { "code": "not_all_members_agreed", "type": null, "when": "[requirement_error] A member declined, or agreement was not received from every member by lapse_date." }, { "code": "members_not_reconciled", "type": null, "when": "[requirement_error] The register of members is not open or does not match the Companies Registry record, so 'all members' cannot be fixed." }, { "code": "financial_year_before_2014", "type": null, "when": "[invalid_request_error] The dispensation is requested for a financial year that began before 3 March 2014, to which s.613 does not apply." }, { "code": "registry_signing_unavailable", "type": null, "when": "[registry_error] The partner's Individual User account is not associated with the company on the CR register, so the delivery cannot be submitted." } ] } }, "Params_hk_agm_written_resolution_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the resolutions replace the AGM for.", "examples": [ "2026-03-31" ] }, "proposed_by": { "type": "string", "enum": [ "directors", "member" ], "description": "Who proposes the written resolution.", "examples": [ "directors" ] }, "proposer": { "type": "string", "pattern": "^per_", "description": "The proposing member.", "examples": [ "per_6Fh2YsXe9PbK" ] }, "resolutions": { "type": "array", "items": {}, "description": "All the business of the AGM.", "examples": [ "[{\"kind\":\"receive_financial_statements\"},{\"kind\":\"reappoint_auditor\",\"text\":\"Reappoint Harbour Audit CPA Limited as auditor.\"}]" ] }, "financial_statements": { "type": "string", "pattern": "^doc_", "description": "The reporting documents every member must receive by the circulation date (s.612).", "examples": [ "doc_2Qr7TnYb5Lc" ] }, "circulation_method": { "type": "string", "enum": [ "electronic", "hard_copy", "website" ], "description": "How the proposed resolutions reach members: hard_copy, electronic, or website.", "examples": [ "electronic" ] }, "circulation_date": { "type": "string", "format": "date", "description": "Date the resolutions and documents are circulated.", "examples": [ "2026-10-19" ] }, "lapse_date": { "type": "string", "format": "date", "description": "Last day for agreement.", "examples": [ "2026-11-16" ] }, "member_statements": { "type": "array", "items": {}, "description": "Array of document_ref: statements of up to 1,000 words from members on the subject of the resolution, which must be circulated.", "examples": [ "[]" ] } }, "required": [ "entity_type", "financial_year_end", "proposed_by", "resolutions", "financial_statements", "circulation_date" ], "description": "Takes all the business that would be done at the annual general meeting by members' written resolution instead of holding a meeting. Entiva circulates the resolutions and the reporting documents to every eligible member, collects their." }, "Create_hk_agm_written_resolution_pass": { "type": "object", "properties": { "type": { "const": "hk.agm_written_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_hk_agm_written_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Replace the AGM with a members' written resolution", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the proposal and circulation", "source": "generated", "required": false }, { "key": "written_resolution", "title": "Proposed members' written resolution", "source": "generated", "required": true }, { "key": "financial_statements_package", "title": "Financial statements, directors' report and auditor's report", "source": "uploaded", "required": true }, { "key": "member_statements", "title": "Members' statements under s.551", "source": "uploaded", "required": false }, { "key": "notice_of_passing", "title": "Notice to members and the auditor that the resolution has passed", "source": "generated", "required": true }, { "key": "resolution_record", "title": "Record of the members' written resolution", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "auditor", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "written_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_passing", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "resolution_record", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None, unless a resolution passed is one that s.622 requires to be delivered to the Registr", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_permitted", "type": null, "when": "[invalid_request_error] resolutions includes the removal of a director or auditor before the end of their term, which cannot be passed in writing (s.548)." }, { "code": "agm_not_required", "type": null, "when": "[invalid_request_error] The company is dormant, has a single member (s.612), or an s.613 dispensation covers this year." }, { "code": "financial_statements_not_signed", "type": null, "when": "[requirement_error] The reporting documents are missing a required signature, so they cannot be circulated." }, { "code": "proposer_not_a_member", "type": null, "when": "[invalid_request_error] proposed_by is member but proposer is not on the register of members." }, { "code": "eligible_members_not_reconciled", "type": null, "when": "[requirement_error] The register of members is not open or does not match the Companies Registry record, so the eligible members cannot be fixed." }, { "code": "resolution_lapsed", "type": null, "when": "[requirement_error] The required majority was not reached by lapse_date." }, { "code": "lapse_date_too_long", "type": null, "when": "[invalid_request_error] lapse_date is more than 28 days after circulation_date and the articles do not set a longer period." } ] } }, "Params_hk_board_minutes_record": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "meeting_at": { "type": "string", "description": "Start of the meeting as an ISO 8601 date-time with the Hong Kong offset.", "examples": [ "2026-10-14T15:00:00+08:00" ] }, "mode": { "type": "string", "enum": [ "physical", "hybrid", "virtual" ], "description": "How directors attended.", "examples": [ "virtual" ] }, "venue": { "$ref": "#/components/schemas/Address", "description": "Physical venue, for physical and hybrid meetings.", "examples": [ "{\"line1\":\"Unit 5, 9/F, Sunrise Industrial Building\",\"city\":\"Kowloon Bay\",\"country\":\"HK\"}" ] }, "chair": { "type": "string", "pattern": "^per_", "description": "The director who chaired the meeting and will sign the minutes.", "examples": [ "per_1Dv8NqZc4TgA" ] }, "attendees": { "type": "array", "items": {}, "description": "Everyone invited.", "examples": [ "[{\"person\":\"per_1Dv8NqZc4TgA\",\"capacity\":\"director\",\"attendance\":\"virtual\"},{\"person\":\"per_6Fh2YsXe9PbK\",\"capacity\":\"director\",\"attendance\":\"virtual\"}]" ] }, "quorum_present": { "type": "boolean", "description": "Confirms a quorum was present throughout the meeting under the articles.", "examples": [ "true" ] }, "declarations_of_interest": { "type": "array", "items": {}, "description": "Each item: person and nature of the interest declared.", "examples": [ "[]" ] }, "resolutions_passed": { "type": "array", "items": {}, "description": "Each item: title, text, vote, votes_for, votes_against and abstentions.", "examples": [ "[{\"title\":\"Approval of draft financial statements\",\"text\":\"That the draft financial statements for the year ended 31 March 2026 are approved.\",\"vote\":\"unanimous\",\"votes_for\":2,\"votes_against\":0,\"abstentions\":0}]" ] }, "minutes_source": { "type": "string", "enum": [ "drafted_by_entiva", "uploaded" ], "description": "drafted_by_entiva drafts from the notes and resolutions you supply; uploaded uses minutes you already wrote.", "examples": [ "drafted_by_entiva" ] }, "source_notes": { "type": "string", "pattern": "^doc_", "description": "Rough notes, an agenda or a recording transcript for Entiva to draft from.", "examples": [ "doc_7Rb4YnPc3Mx" ] }, "draft_minutes": { "type": "string", "pattern": "^doc_", "description": "Existing minutes to upload.", "examples": [ "doc_1Lf8GhQw6Zt" ] } }, "required": [ "entity_type", "meeting_at", "mode", "chair", "attendees", "quorum_present", "resolutions_passed" ], "description": "Drafts the minutes of a directors' meeting held in person, hybrid or virtually: attendees, quorum, declarations of interest, and each resolution passed with its vote. The chair of the meeting signs them electronically, and they go into the." }, "Create_hk_board_minutes_record": { "type": "object", "properties": { "type": { "const": "hk.board_minutes.record" }, "params": { "$ref": "#/components/schemas/Params_hk_board_minutes_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the minutes of a directors' meeting", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "minutes", "title": "Minutes of the directors' meeting", "source": "generated", "required": true }, { "key": "source_notes", "title": "Notes or transcript", "source": "uploaded", "required": false }, { "key": "board_papers", "title": "Board papers", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "alternate_director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "recipient", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. Minutes are kept", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "quorum_not_met", "type": null, "when": "[requirement_error] quorum_present is false or the attendees do not meet the articles' quorum." }, { "code": "chair_not_in_attendees", "type": null, "when": "[invalid_request_error] chair is not listed in attendees as a director or alternate director present." }, { "code": "attendee_not_current_director", "type": null, "when": "[invalid_request_error] A person recorded as a director was not a director on meeting_at according to the register of directors." }, { "code": "meeting_in_future", "type": null, "when": "[invalid_request_error] meeting_at is after the current time." }, { "code": "draft_minutes_required", "type": null, "when": "[invalid_request_error] minutes_source is uploaded and draft_minutes is missing." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] The chair has not completed identity verification, or an open sanctions alert pauses the action." } ] } }, "Params_hk_board_resolution_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "decision_method": { "type": "string", "enum": [ "written_unanimous", "sole_director_decision" ], "description": "written_unanimous = a resolution each eligible director signs or otherwise agrees to in writing; sole_director_decision = a written record of a decision by the.", "examples": [ "written_unanimous" ] }, "title": { "type": "string", "description": "Short title of the resolution.", "examples": [ "Authorisation to file the annual return" ] }, "resolutions": { "type": "array", "items": {}, "description": "The decisions to be taken.", "examples": [ "[{\"category\":\"authorise_filing\",\"text\":\"That the company secretary is authorised to prepare and file the annual return (Form NAR1) for the company.\"}]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the decision takes effect.", "examples": [ "2026-10-19" ] }, "eligible_directors": { "type": "array", "items": {}, "description": "Array of person_ref for the directors who must agree.", "examples": [ "[\"per_1Dv8NqZc4TgA\",\"per_6Fh2YsXe9PbK\"]" ] }, "lapse_date": { "type": "string", "format": "date", "description": "Last day for directors to agree.", "examples": [ "2026-10-31" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref: papers the directors should read before signing.", "examples": [ "[]" ] }, "authorises_action": { "type": "string", "description": "Id of the action this resolution authorises.", "examples": [ "act_8Vn3QkTd5Ye" ] } }, "required": [ "entity_type", "decision_method", "title", "resolutions" ], "description": "Prepares a directors' written resolution or records a sole director's written decision, collects each director's own electronic signature, and places the signed record in the minute book. Use it to authorise filings, approve accounts." }, "Create_hk_board_resolution_pass": { "type": "object", "properties": { "type": { "const": "hk.board_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_hk_board_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass a directors' written resolution or sole-director decision", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' written resolution", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Papers for the directors", "source": "uploaded", "required": false }, { "key": "articles_of_association", "title": "Articles of association", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "alternate_director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "alternate_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. Directors' resolutions are kept", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "decision_rule_unconfirmed", "type": null, "when": "[requirement_error] The articles are not the Model Articles, so Entiva cannot confirm the written-decision rule." }, { "code": "sole_director_required", "type": null, "when": "[invalid_request_error] decision_method is sole_director_decision but the company has more than one director." }, { "code": "director_not_current", "type": null, "when": "[invalid_request_error] eligible_directors names a person who is not a current director or appointed alternate on the register of directors." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] An eligible director has not completed identity verification, or an open sanctions alert pauses the action." }, { "code": "resolution_lapsed", "type": null, "when": "[requirement_error] An eligible director had not agreed by lapse_date." }, { "code": "director_declined", "type": null, "when": "[requirement_error] An eligible director declined to agree, so a unanimous written decision cannot pass." } ] } }, "Params_hk_branch_register_debenture_holders_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "operation": { "type": "string", "enum": [ "commence", "change_address", "discontinue" ], "description": "commence = the company begins to keep a branch register; change_address = the branch register moves to a new address; discontinue = it is closed and its.", "examples": [ "change_address" ] }, "debenture_series": { "type": "string", "description": "Description of the series of debentures or debenture stock issued outside Hong Kong, kept on file as the basis for the branch register.", "examples": [ "HK$20,000,000 registered secured notes due 2029, issued in London" ] }, "branch_register_address": { "$ref": "#/components/schemas/Address", "description": "For commence: the address outside Hong Kong where the branch register is kept.", "examples": [ "{\"line1\":\"Level 3, 1 Example Square\",\"city\":\"London\",\"postal_code\":\"EC2A 1AA\",\"country\":\"GB\"}" ] }, "previous_address": { "$ref": "#/components/schemas/Address", "description": "For change_address: the previous address of the branch register.", "examples": [ "{\"line1\":\"Level 3, 1 Example Square\",\"city\":\"London\",\"postal_code\":\"EC2A 1AA\",\"country\":\"GB\"}" ] }, "address": { "$ref": "#/components/schemas/Address", "description": "For change_address: the new address of the branch register.", "examples": [ "{\"line1\":\"Floor 8, 25 Sample Row\",\"city\":\"London\",\"postal_code\":\"EC2A 4BB\",\"country\":\"GB\"}" ] }, "entries_transferred_to": { "type": "string", "enum": [ "other_branch_register_same_place", "register_of_debenture_holders" ], "description": "For discontinue: where all entries were transferred. other_branch_register_same_place = another branch register kept in the same place outside Hong Kong.", "examples": [ "register_of_debenture_holders" ] }, "other_branch_register_address": { "$ref": "#/components/schemas/Address", "description": "For discontinue into another branch register: the address where that other register is kept.", "examples": [ "{\"line1\":\"Floor 8, 25 Sample Row\",\"city\":\"London\",\"postal_code\":\"EC2A 4BB\",\"country\":\"GB\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the branch register began, moved or was discontinued.", "examples": [ "2026-10-09" ] }, "signatory_role": { "type": "string", "enum": [ "company_secretary", "director" ], "description": "Who signs NR3. company_secretary = Entiva's Entiva. director signs personally.", "examples": [ "company_secretary" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "The signing director.", "examples": [ "per_1Dv8NqZc4TgA" ] }, "form_language": { "type": "string", "enum": [ "en", "zh_hant" ], "description": "NR3 must be completed consistently in one language.", "examples": [ "en" ] }, "presentor_reference": { "type": "string", "description": "Your reference for the Presentor's Reference box.", "examples": [ "branch-debenture-london" ] }, "board_resolution": { "type": "string", "pattern": "^doc_", "description": "An existing signed board resolution.", "examples": [ "doc_8Wk2PrNb4Hs" ] } }, "required": [ "entity_type", "operation", "effective_date" ], "description": "Files Form NR3 with the Companies Registry when a company that has issued, outside Hong Kong, a series of debentures or debenture stock that cannot be transferred by delivery begins to keep a branch register of the holders resident there." }, "Create_hk_branch_register_debenture_holders_notify": { "type": "object", "properties": { "type": { "const": "hk.branch_register_debenture_holders.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_branch_register_debenture_holders_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Open, move or close a branch register of debenture holders", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nr3_form", "title": "Form NR3 Notice Relating to Branch Register of Debenture Holders", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution on the branch register", "source": "generated", "required": false }, { "key": "articles_of_association", "title": "Articles of association", "source": "uploaded", "required": false }, { "key": "debenture_terms", "title": "Terms of the debenture series", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Companies Registry acknowledgement of NR3", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nr3_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nr3_form", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NR3 Notice Relating to Branch Register of Debenture Holders", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "debentures_not_eligible", "type": null, "when": "[requirement_error] The debenture series was not issued outside Hong Kong, or is transferable by delivery, so a branch register is not available." }, { "code": "articles_do_not_authorise_branch_register", "type": null, "when": "[requirement_error] The articles do not authorise a branch register of debenture holders." }, { "code": "branch_register_in_hong_kong", "type": null, "when": "[invalid_request_error] A branch register address is in Hong Kong." }, { "code": "branch_register_not_found", "type": null, "when": "[invalid_request_error] operation is change_address or discontinue but no branch register of debenture holders has been notified for that address." }, { "code": "transfer_destination_missing", "type": null, "when": "[invalid_request_error] operation is discontinue and entries_transferred_to is missing." }, { "code": "registry_signing_unavailable", "type": null, "when": "[registry_error] The partner's Individual User account is not associated with the company on the CR register." } ] } }, "Params_hk_branch_register_members_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "description": "Only a company having a share capital may keep a branch register of members.", "examples": [ "private_ltd_shares" ] }, "operation": { "type": "string", "enum": [ "commence", "change_address", "discontinue" ], "description": "commence = the company begins to keep a branch register; change_address = the branch register moves to a new address; discontinue = the branch register is.", "examples": [ "commence" ] }, "branch_register_address": { "$ref": "#/components/schemas/Address", "description": "For commence: the address outside Hong Kong where the branch register is kept.", "examples": [ "{\"line1\":\"20 Example Street\",\"line2\":\"#09-01\",\"city\":\"Singapore\",\"postal_code\":\"049999\",\"country\":\"SG\"}" ] }, "previous_address": { "$ref": "#/components/schemas/Address", "description": "For change_address: the previous address of the branch register.", "examples": [ "{\"line1\":\"20 Example Street\",\"line2\":\"#09-01\",\"city\":\"Singapore\",\"postal_code\":\"049999\",\"country\":\"SG\"}" ] }, "address": { "$ref": "#/components/schemas/Address", "description": "For change_address: the new address of the branch register.", "examples": [ "{\"line1\":\"30 Sample Road\",\"line2\":\"#12-04\",\"city\":\"Singapore\",\"postal_code\":\"049998\",\"country\":\"SG\"}" ] }, "entries_transferred_to": { "type": "string", "enum": [ "other_branch_register_same_place", "register_of_members" ], "description": "For discontinue: where all entries were transferred. other_branch_register_same_place = another branch register kept by the company in the same place outside.", "examples": [ "register_of_members" ] }, "other_branch_register_address": { "$ref": "#/components/schemas/Address", "description": "For discontinue into another branch register: the address where that other register is kept.", "examples": [ "{\"line1\":\"30 Sample Road\",\"line2\":\"#12-04\",\"city\":\"Singapore\",\"postal_code\":\"049998\",\"country\":\"SG\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the branch register began, moved or was discontinued.", "examples": [ "2026-10-14" ] }, "signatory_role": { "type": "string", "enum": [ "company_secretary", "director" ], "description": "Who signs NR4. company_secretary = Entiva's Entiva. director signs personally.", "examples": [ "company_secretary" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "The signing director.", "examples": [ "per_1Dv8NqZc4TgA" ] }, "form_language": { "type": "string", "enum": [ "en", "zh_hant" ], "description": "NR4 must be completed consistently in one language.", "examples": [ "en" ] }, "presentor_reference": { "type": "string", "description": "Your reference for the Presentor's Reference box.", "examples": [ "branch-register-sg" ] }, "board_resolution": { "type": "string", "pattern": "^doc_", "description": "An existing signed board resolution.", "examples": [ "doc_5Tq3MsLd9Ya" ] } }, "required": [ "entity_type", "operation", "effective_date" ], "description": "Files Form NR4 with the Companies Registry when a company with a share capital begins to keep a branch register of its members resident outside Hong Kong, changes the address where that branch register is kept, or discontinues it. The." }, "Create_hk_branch_register_members_notify": { "type": "object", "properties": { "type": { "const": "hk.branch_register_members.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_branch_register_members_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Open, move or close a branch register of members", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nr4_form", "title": "Form NR4 Notice Relating to Branch Register of Members", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution on the branch register", "source": "generated", "required": false }, { "key": "articles_of_association", "title": "Articles of association", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Companies Registry acknowledgement of NR4", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nr4_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nr4_form", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NR4 Notice Relating to Branch Register of Members", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The company has no share capital, so it cannot keep a branch register of members." }, { "code": "articles_do_not_authorise_branch_register", "type": null, "when": "[requirement_error] The articles do not authorise a branch register (s.636)." }, { "code": "branch_register_in_hong_kong", "type": null, "when": "[invalid_request_error] A branch register address is in Hong Kong." }, { "code": "branch_register_not_found", "type": null, "when": "[invalid_request_error] operation is change_address or discontinue but no branch register has been notified for that address." }, { "code": "transfer_destination_missing", "type": null, "when": "[invalid_request_error] operation is discontinue and entries_transferred_to is missing." }, { "code": "registry_signing_unavailable", "type": null, "when": "[registry_error] The partner's Individual User account is not associated with the company on the CR register." } ] } }, "Params_hk_members_resolution_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "resolution_class": { "type": "string", "enum": [ "ordinary", "special" ], "description": "ordinary or special.", "examples": [ "ordinary" ] }, "procedure": { "type": "string", "enum": [ "written_resolution", "general_meeting_record", "sole_member_written_record" ], "description": "written_resolution = circulated to eligible members and passed on written agreement; general_meeting_record = records a resolution passed at a general meeting.", "examples": [ "written_resolution" ] }, "title": { "type": "string", "description": "Short title of the resolution.", "examples": [ "Authority to allot shares" ] }, "resolution_text": { "type": "string", "description": "The full wording.", "examples": [ "That the directors are authorised to allot up to 100,000 ordinary shares of the company on such terms as they decide." ] }, "proposed_by": { "type": "string", "enum": [ "directors", "member" ], "description": "For written_resolution: directors or a member.", "examples": [ "directors" ] }, "proposer": { "type": "string", "pattern": "^per_", "description": "The proposing member.", "examples": [ "per_6Fh2YsXe9PbK" ] }, "circulation_method": { "type": "string", "enum": [ "electronic", "hard_copy", "website" ], "description": "For written_resolution: hard_copy, electronic or website.", "examples": [ "electronic" ] }, "circulation_date": { "type": "string", "format": "date", "description": "For written_resolution: date of circulation.", "examples": [ "2026-10-19" ] }, "lapse_date": { "type": "string", "format": "date", "description": "For written_resolution: last day for agreement.", "examples": [ "2026-11-16" ] }, "meeting": { "type": "object", "description": "Required for general_meeting_record. {held_at, notice_given_on, chair, votes_for, votes_against, abstentions, poll, minutes}.", "examples": [ "{\"held_at\":\"2026-10-15T10:00:00+08:00\",\"notice_given_on\":\"2026-09-30\",\"chair\":\"per_1Dv8NqZc4TgA\",\"votes_for\":10000,\"votes_against\":0,\"abstentions\":0,\"poll\":false}" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref: papers circulated with the resolution.", "examples": [ "[]" ] } }, "required": [ "entity_type", "resolution_class", "procedure", "title", "resolution_text" ], "description": "Passes a resolution of the members, as a written resolution circulated to the eligible members, or records one passed at a general meeting, or records the written decision of a sole member. Entiva collects each member's agreement." }, "Create_hk_members_resolution_pass": { "type": "object", "properties": { "type": { "const": "hk.members_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_hk_members_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass a members' ordinary or special resolution, or record a sole member's decision", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing the members' resolution", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Members' resolution", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the general meeting", "source": "uploaded", "required": false }, { "key": "notice_of_passing", "title": "Notice to members and the auditor that the written resolution has passed", "source": "generated", "required": false }, { "key": "resolution_record", "title": "Record of the members' resolution", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "auditor", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_passing", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "resolution_record", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None for the resolution itself. Special resolutions, and any other resolution s.622 requir", "form": "None. Resolutions have no specified form", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_permitted", "type": null, "when": "[invalid_request_error] The resolution removes a director or the auditor before the end of the term, which cannot be passed in writing (s.548)." }, { "code": "sole_member_required", "type": null, "when": "[invalid_request_error] procedure is sole_member_written_record but the register shows more than one member." }, { "code": "proposer_not_a_member", "type": null, "when": "[invalid_request_error] proposed_by is member but proposer is not on the register of members." }, { "code": "meeting_notice_defective", "type": null, "when": "[requirement_error] The recorded meeting had less than 14 days' notice without the agreement of a majority in number of the voting members holding at least 95% of the voting." }, { "code": "required_majority_not_reached", "type": null, "when": "[requirement_error] Votes or written agreements do not reach the ordinary or special majority." }, { "code": "resolution_lapsed", "type": null, "when": "[requirement_error] The written resolution had not reached the required majority by lapse_date." }, { "code": "eligible_members_not_reconciled", "type": null, "when": "[requirement_error] The register of members is not open or does not match the Companies Registry record, so eligible members cannot be fixed." }, { "code": "registrar_delivery_review_needed", "type": null, "when": "[requirement_error] Entiva cannot tell whether s.622 requires an ordinary resolution of this kind to be delivered." } ] } }, "Params_hk_ofc_registers_location_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "open_ended_fund_company" ], "description": "Always open_ended_fund_company.", "examples": [ "open_ended_fund_company" ] }, "records": { "type": "array", "items": {}, "description": "Registers and records covered by this location, as strings: register_of_shareholders, register_of_directors.", "examples": [ "[\"register_of_shareholders\",\"register_of_directors\"]" ] }, "location_kind": { "type": "string", "enum": [ "other_hong_kong_address", "registered_office" ], "description": "other_hong_kong_address = first kept at, or moved to, a place other than the registered office; registered_office = changed back to the registered office.", "examples": [ "other_hong_kong_address" ] }, "location_address": { "$ref": "#/components/schemas/Address", "description": "Full address in Hong Kong.", "examples": [ "{\"line1\":\"Room 2105, 21/F, Example Fund Tower\",\"line2\":\"100 Des Voeux Road Central\",\"city\":\"Central\",\"region\":\"Hong Kong Island\",\"country\":\"HK\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the records were first kept at the place, or the date of the change.", "examples": [ "2026-10-09" ] }, "remarks": { "type": "string", "description": "Needed when different parts of a register are kept at different places: say which part or period is kept here.", "examples": [ "Register of directors for the period before 1 July 2026 is kept at this address." ] }, "additional_locations": { "type": "array", "items": {}, "description": "Further locations, one per OFCR2 continuation sheet.", "examples": [ "[]" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "A director of the OFC, who must sign OFCR2 personally.", "examples": [ "per_3Zk7BtMq5RwL" ] }, "form_language": { "type": "string", "enum": [ "en", "zh_hant" ], "description": "OFCR2 must be completed consistently in one language; Traditional Chinese characters if Chinese.", "examples": [ "en" ] }, "presentor_reference": { "type": "string", "description": "Your reference for the Presentor's Reference box.", "examples": [ "ofc-records-oct-2026" ] }, "board_resolution": { "type": "string", "pattern": "^doc_", "description": "An existing signed board resolution.", "examples": [ "doc_2Hb6NwXr8Jc" ] } }, "required": [ "entity_type", "records", "location_kind", "effective_date", "signatory" ], "description": "Files Form OFCR2 with the Companies Registry when an open-ended fund company keeps its register of shareholders, register of directors, or copies of shareholders' resolutions and minutes of general meetings at a place other than its." }, "Create_hk_ofc_registers_location_notify": { "type": "object", "properties": { "type": { "const": "hk.ofc_registers_location.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_registers_location_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the location of an OFC's registers and records", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ofcr2_form", "title": "Form OFCR2 Notice of Location of Registers and Records", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution deciding where the records are kept", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies Registry acknowledgement of OFCR2", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "partner", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ofcr2_form", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "OFCR2 Notice of Location of Registers and Records", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is not an open-ended fund company." }, { "code": "signatory_not_a_director", "type": null, "when": "[requirement_error] signatory is not a director of the OFC on the register of directors." }, { "code": "address_not_in_hong_kong", "type": null, "when": "[invalid_request_error] location_address is outside Hong Kong or is a PO box." }, { "code": "linked_records_split", "type": null, "when": "[invalid_request_error] The register of directors is moved but the process-agent or non-Hong Kong custodian records would stay at a different place." }, { "code": "no_notification_needed", "type": null, "when": "[invalid_request_error] The records have always been kept at the registered office and nothing has changed, or the same location is already on the register." }, { "code": "registry_signing_unavailable", "type": null, "when": "[registry_error] The director has no CR e-Services Individual User account associated with the OFC." } ] } }, "Params_hk_registers_location_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "records": { "type": "array", "items": {}, "description": "Registers and records covered by this location, as strings: members, significant_controllers, directors, company_secretaries, charges.", "examples": [ "[\"members\",\"significant_controllers\",\"directors\",\"company_secretaries\",\"resolutions_and_minutes\"]" ] }, "location_kind": { "type": "string", "enum": [ "other_hong_kong_address", "registered_office" ], "description": "other_hong_kong_address = the records are first kept at, or moved to, a place other than the registered office; registered_office = they are changed back to.", "examples": [ "other_hong_kong_address" ] }, "location_address": { "$ref": "#/components/schemas/Address", "description": "Full address in Hong Kong.", "examples": [ "{\"line1\":\"Unit 5, 9/F, Sunrise Industrial Building\",\"line2\":\"20 Wang Chiu Road\",\"city\":\"Kowloon Bay\",\"region\":\"Kowloon\",\"country\":\"HK\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the records were first kept at the place, or the date of the change.", "examples": [ "2026-10-12" ] }, "remarks": { "type": "string", "description": "Needed when different parts of a register are kept at different places: say which part is kept here.", "examples": [ "Register of members for the period 2021 to 2024 is kept at this address." ] }, "additional_locations": { "type": "array", "items": {}, "description": "Further locations, one per NR2 continuation sheet.", "examples": [ "[]" ] }, "signatory_role": { "type": "string", "enum": [ "company_secretary", "director", "manager", "authorized_representative" ], "description": "Who signs NR2. company_secretary = Entiva's Entiva signs through its natural-person officer. director signs personally. manager and.", "examples": [ "company_secretary" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "The signing person.", "examples": [ "per_1Dv8NqZc4TgA" ] }, "form_language": { "type": "string", "enum": [ "en", "zh_hant" ], "description": "NR2 must be completed consistently in one language; use Traditional Chinese characters if Chinese.", "examples": [ "en" ] }, "presentor_reference": { "type": "string", "description": "Your reference, printed in the Presentor's Reference box.", "examples": [ "records-move-oct-2026" ] }, "board_resolution": { "type": "string", "pattern": "^doc_", "description": "An existing signed board resolution deciding where the records are kept.", "examples": [ "doc_6Pn1VsHk4Wd" ] } }, "required": [ "entity_type", "records", "location_kind", "effective_date" ], "description": "Files Form NR2 with the Companies Registry when a company keeps any of its statutory registers or records at a place other than its registered office, or moves them. NR2 covers the register of members, significant controllers register." }, "Create_hk_registers_location_notify": { "type": "object", "properties": { "type": { "const": "hk.registers_location.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_registers_location_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the location of registers and company records", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nr2_form", "title": "Form NR2 Notice of Location of Registers and Company Records", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution deciding where the records are kept", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies Registry acknowledgement of NR2", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nr2_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nr2_form", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nr2_form", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NR2 Notice of Location of Registers and Company Records", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_not_in_hong_kong", "type": null, "when": "[invalid_request_error] location_address is outside Hong Kong." }, { "code": "po_box_not_accepted", "type": null, "when": "[invalid_request_error] location_address is a PO box." }, { "code": "records_not_applicable_to_entity_type", "type": null, "when": "[invalid_request_error] A registered non-Hong Kong company listed a record other than charges and charge_instrument_copies." }, { "code": "no_notification_needed", "type": null, "when": "[invalid_request_error] The records have always been kept at the registered office and nothing has changed, or the same location is already on the register." }, { "code": "scr_notification_exempt", "type": null, "when": "[invalid_request_error] An existing company kept its SCR at the registered office since the register began, or with the register of members at a place already notified." }, { "code": "signatory_not_eligible", "type": null, "when": "[requirement_error] signatory is not a director of the company, or signatory_role is manager or authorized_representative for a local company." }, { "code": "registry_signing_unavailable", "type": null, "when": "[registry_error] The partner's Individual User account is not associated with the company on the CR register." } ] } }, "Params_hk_specified_resolution_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "resolution_type": { "type": "string", "enum": [ "special_resolution", "agm_dispensation", "other_section_622_resolution" ], "description": "special_resolution = any special resolution without its own specified form; agm_dispensation = a s.613 resolution dispensing with AGMs (s.622).", "examples": [ "agm_dispensation" ] }, "statutory_basis": { "type": "string", "description": "The section of Cap. 622 that requires delivery.", "examples": [ "s.613" ] }, "title": { "type": "string", "description": "Title of the resolution as passed.", "examples": [ "Resolution of all members dispensing with annual general meetings" ] }, "resolution_document": { "type": "string", "pattern": "^doc_", "description": "The resolution as passed: the signed written-resolution record or an extract of the minutes.", "examples": [ "doc_4Xk9DsLc2Ru" ] }, "date_passed": { "type": "string", "format": "date", "description": "Date the resolution was passed.", "examples": [ "2026-10-06" ] }, "passed_by": { "type": "string", "enum": [ "general_meeting", "written_resolution", "unanimous_agreement_of_members" ], "description": "How the resolution was passed.", "examples": [ "written_resolution" ] }, "source_action": { "type": "string", "description": "Id of the Entiva action that passed the resolution, if any.", "examples": [ "act_1TzVd8KnJq5H" ] }, "delivery_channel": { "type": "string", "enum": [ "e_services", "paper" ], "description": "e_services = PDF through the CR e-Services Portal; paper = hand delivery or post to the Companies Registry, 14th floor, Queensway Government Offices, 66.", "examples": [ "e_services" ] }, "late_explanation": { "type": "string", "description": "Why the resolution is being delivered after 15 days.", "examples": [ "Resolution passed outside Entiva and found during a transfer-in." ] } }, "required": [ "entity_type", "resolution_type", "title", "resolution_document", "date_passed", "passed_by" ], "description": "Delivers a copy of a resolution that s.622 requires to be sent to the Registrar, within 15 days after it was passed: a special resolution, a resolution of all members dispensing with AGMs, or another resolution the Ordinance lists. The." }, "Create_hk_specified_resolution_file": { "type": "object", "properties": { "type": { "const": "hk.specified_resolution.file" }, "params": { "$ref": "#/components/schemas/Params_hk_specified_resolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deliver a specified resolution to the Companies Registry", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_document", "title": "Resolution as passed", "source": "uploaded", "required": true }, { "key": "resolution_copy_for_registrar", "title": "Certified copy of the resolution for the Registrar", "source": "generated", "required": true }, { "key": "delivery_acknowledgement", "title": "Companies Registry acknowledgement of delivery", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "resolution_copy_for_registrar", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "resolution_copy_for_registrar", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "No specified form. A copy of the resolution is delivered under s.622", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "resolution_not_passed", "type": null, "when": "[requirement_error] No evidence shows the resolution was passed, or the required majority was not reached." }, { "code": "own_form_required", "type": null, "when": "[invalid_request_error] The resolution accompanies a specified form, which Entiva files through that form's action." }, { "code": "delivery_not_required", "type": null, "when": "[invalid_request_error] The resolution is not one that s.622 requires to be delivered." }, { "code": "statutory_basis_required", "type": null, "when": "[invalid_request_error] resolution_type is other_section_622_resolution and statutory_basis is missing." }, { "code": "registry_signing_unavailable", "type": null, "when": "[registry_error] The partner's Individual User account is not associated with the company on the CR register, so the e-Services submission cannot be made." }, { "code": "resolution_copy_unreadable", "type": null, "when": "[invalid_request_error] The uploaded PDF is unreadable, password protected or exceeds the portal's size limit." } ] } }, "Params_hk_statutory_registers_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "register": { "type": "string", "enum": [ "members", "charges", "debenture_holders" ], "description": "Register to amend.", "examples": [ "members" ] }, "change_kind": { "type": "string", "enum": [ "add_entry", "amend_particulars", "close_entry", "correct_error" ], "description": "add_entry = add a missing historic entry; amend_particulars = change the holder's name, address or contact details; close_entry = record that an entry has.", "examples": [ "amend_particulars" ] }, "entry_id": { "type": "string", "description": "Id of the existing register entry, from GET /v1/entities/{entity_id}/registers/{register}.", "examples": [ "rent_6Tn2KcVb" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect.", "examples": [ "2026-10-10" ] }, "entry": { "type": "object", "description": "The new or corrected particulars, by register. members: person, name, address, share_class, number_of_shares, amount_paid, amount_unpaid, date_entered.", "examples": [ "{\"address\":{\"line1\":\"Flat 12B, Tower 3, Example Gardens\",\"city\":\"Tai Po\",\"region\":\"New Territories\",\"country\":\"HK\"}}" ] }, "reason": { "type": "string", "description": "Why the entry is being changed.", "examples": [ "Member notified a new residential address on 10 October 2026." ] }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref: the member's written notice, a court order, or other evidence for the change.", "examples": [ "[\"doc_8Kd3LwQn4Ye\"]" ] } }, "required": [ "entity_type", "register", "change_kind", "effective_date", "entry" ], "description": "Records a change to the register of members, the register of charges or the register of debenture holders that does not itself need a registry filing: a member's change of name or address, a correction of a wrong entry, closing an entry." }, "Create_hk_statutory_registers_change": { "type": "object", "properties": { "type": { "const": "hk.statutory_registers.change" }, "params": { "$ref": "#/components/schemas/Params_hk_statutory_registers_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend or correct an entry in a statutory register", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "supporting_document", "title": "Evidence for the change", "source": "uploaded", "required": false }, { "key": "member_notice", "title": "Member's notice of change of particulars", "source": "uploaded", "required": false }, { "key": "register_entry_record", "title": "Register entry and audit record", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "none" }, { "role": "member", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "member_notice", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_entry_record", "signer_role": "company_secretary", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None. Registers are kept", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_not_open", "type": null, "when": "[invalid_request_error] The register has not been opened." }, { "code": "register_not_maintainable_here", "type": null, "when": "[invalid_request_error] register names the directors, secretaries or SCR." }, { "code": "shareholding_change_requires_share_action", "type": null, "when": "[requirement_error] The change would move shares between members or change the number of shares held." }, { "code": "charge_requires_registry_filing", "type": null, "when": "[requirement_error] The charge change must be registered with the Companies Registry." }, { "code": "entry_not_found", "type": null, "when": "[invalid_request_error] entry_id does not match an entry in the register." }, { "code": "reason_required", "type": null, "when": "[invalid_request_error] change_kind is correct_error or close_entry and no reason was given." } ] } }, "Params_hk_statutory_registers_form": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "opening_basis": { "type": "string", "enum": [ "formation", "transfer_in", "rebuild" ], "description": "Why the registers are being opened. formation = opened from an Entiva formation; transfer_in = imported from the outgoing provider; rebuild = reconstructed.", "examples": [ "transfer_in" ] }, "opening_date": { "type": "string", "format": "date", "description": "Date as of which the opening entries are struck and reconciled to the Companies Registry record.", "examples": [ "2026-10-17" ] }, "registers": { "type": "array", "items": {}, "description": "Registers and records to open, as strings: members, directors, company_secretaries, significant_controllers, charges, charge_instrument_copies.", "examples": [ "[\"members\",\"directors\",\"company_secretaries\",\"significant_controllers\",\"charges\",\"minute_book\"]" ] }, "source_documents": { "type": "array", "items": {}, "description": "Array of document_ref: the outgoing provider's registers, minute book and handover letter.", "examples": [ "[\"doc_5Jt2WqLd8HnR\"]" ] }, "members": { "type": "array", "items": {}, "description": "Opening entries for the register of members, required when opening_basis is not formation and members is in registers.", "examples": [ "[{\"person\":\"per_1Dv8NqZc4TgA\",\"share_class\":\"ordinary\",\"number_of_shares\":7500}]" ] }, "existing_charges": { "type": "array", "items": {}, "description": "Opening entries for the register of charges.", "examples": [ "[]" ] }, "records_location": { "type": "object", "description": "Where the registers are kept. {kind: registered_office | other_hong_kong_address, address: address}.", "examples": [ "{\"kind\":\"registered_office\"}" ] }, "scr_exemption": { "type": "string", "enum": [ "none", "listed_on_sehk" ], "description": "none keeps a significant controllers register. listed_on_sehk records that the company is listed on the Stock Exchange of Hong Kong and so keeps no SCR.", "examples": [ "none" ] }, "significant_controllers": { "type": "array", "items": {}, "description": "Opening SCR entries.", "examples": [ "[{\"person\":\"per_1Dv8NqZc4TgA\",\"conditions\":[\"shares_over_25\",\"votes_over_25\"],\"date_became_registrable\":\"2021-03-15\"}]" ] }, "designated_representative": { "type": "string", "pattern": "^per_", "description": "SCR designated representative.", "examples": [ "per_8Qw3ZnKd7VcT" ] }, "board_resolution": { "type": "string", "pattern": "^doc_", "description": "An existing signed board resolution adopting the arrangements.", "examples": [ "doc_3Pm6YhRu2FeL" ] } }, "required": [ "entity_type", "opening_basis", "opening_date" ], "description": "Opens, takes custody of or rebuilds the company's statutory registers and records under the Companies Ordinance: members, directors, company secretaries, significant controllers, charges with copies of charge instruments, debenture holders." }, "Create_hk_statutory_registers_form": { "type": "object", "properties": { "type": { "const": "hk.statutory_registers.form" }, "params": { "$ref": "#/components/schemas/Params_hk_statutory_registers_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up statutory registers and records, including the significant controllers register", "x-entiva": { "jurisdiction": "hk", "stage": "governance", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "existing_registers", "title": "Existing registers and minute book", "source": "uploaded", "required": false }, { "key": "handover_letter", "title": "Handover letter from the outgoing company secretary or provider", "source": "uploaded", "required": false }, { "key": "articles_of_association", "title": "Articles of association", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution adopting the register arrangements", "source": "generated", "required": true }, { "key": "designated_representative_consent", "title": "Consent of a customer-appointed designated representative", "source": "generated", "required": false }, { "key": "scr_notices", "title": "Statutory notices to persons who may be significant controllers", "source": "generated", "required": false }, { "key": "scr_confirmation", "title": "Controller's confirmation of SCR particulars", "source": "generated", "required": false }, { "key": "reconciliation_report", "title": "Reconciliation of the opening registers to the Companies Registry record", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "member", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "scr_confirmation", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "designated_representative_consent", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "reconciliation_report", "signer_role": "company_secretary", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None. The registers are kept", "form": "None. Form NR2 is needed only if records are kept away from the registered office", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is not a private, public, guarantee or unlimited company." }, { "code": "registers_already_open", "type": null, "when": "[invalid_request_error] A register in registers is already open for this entity." }, { "code": "source_documents_required", "type": null, "when": "[requirement_error] opening_basis is transfer_in or rebuild and no registers, minute book or handover letter was uploaded." }, { "code": "register_reconciliation_failed", "type": null, "when": "[requirement_error] The members, officers or share totals supplied do not reconcile to the Companies Registry record." }, { "code": "scr_exempt_entity", "type": null, "when": "[invalid_request_error] significant_controllers was supplied but scr_exemption is listed_on_sehk." }, { "code": "designated_representative_ineligible", "type": null, "when": "[requirement_error] A customer-appointed designated representative is not a Hong Kong-resident natural person in a permitted capacity." }, { "code": "records_location_not_in_hong_kong", "type": null, "when": "[invalid_request_error] records_location.address is outside Hong Kong or is a PO box." }, { "code": "controller_verification_incomplete", "type": null, "when": "[requirement_error] A listed significant controller has not completed identity verification or an open sanctions alert pauses the action." } ] } }, "Params_hk_auditor_remove": { "type": "object", "properties": { "auditor_name": { "type": "string", "description": "Name of the auditor as registered." }, "auditor_address": { "$ref": "#/components/schemas/Address", "description": "Auditor's address in Hong Kong." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the ordinary resolution was passed." }, "effective_date": { "type": "string", "format": "date", "description": "Date the removal takes effect." }, "meeting_minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "Minutes of the general meeting, signed by the chair." } }, "required": [ "auditor_name", "auditor_address", "resolution_date", "effective_date" ], "description": "Records that the members removed the company's auditor by ordinary resolution at a general meeting and files Form NA1 within 15 days beginning on the date the resolution was passed." }, "Create_hk_auditor_remove": { "type": "object", "properties": { "type": { "const": "hk.auditor.remove" }, "params": { "$ref": "#/components/schemas/Params_hk_auditor_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the removal of an auditor", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_meeting_minutes", "title": "Minutes of the general meeting removing the auditor", "source": "generated", "required": true }, { "key": "form_na1", "title": "Form NA1", "source": "generated", "required": true }, { "key": "na1_receipt", "title": "Registered NA1 and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting" } ], "signatures": [ { "document_key": "general_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_na1", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_na1", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NA1", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_permitted", "type": null, "when": "Removal is proposed as a written resolution." }, { "code": "auditor_not_on_record", "type": null, "when": "No auditor of that name is recorded for the company." }, { "code": "meeting_minutes_missing", "type": null, "when": "No signed minutes of a general meeting are attached or generated." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "filing_overdue", "type": null, "when": "Non-blocking: the 15-day deadline has passed." } ] } }, "Params_hk_auditor_resignation_notify": { "type": "object", "properties": { "auditor_name": { "type": "string", "description": "Name of the resigning auditor as registered." }, "auditor_address": { "$ref": "#/components/schemas/Address", "description": "Auditor's address in Hong Kong." }, "notice_received_date": { "type": "string", "format": "date", "description": "Date the company received the auditor's written notice." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the resignation." }, "resignation_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "The auditor's written notice of resignation." }, "statement_of_circumstances_document_id": { "type": "string", "pattern": "^doc_", "description": "The statement required from the resigning auditor under s.424; it must accompany the notice." } }, "required": [ "auditor_name", "auditor_address", "notice_received_date", "effective_date", "resignation_notice_document_id", "statement_of_circumstances_document_id" ], "description": "Files Form NA2 to notify the Registrar that the company received the auditor's written notice of resignation, with the auditor's statement of circumstances, within 15 days beginning on the date of receipt." }, "Create_hk_auditor_resignation_notify": { "type": "object", "properties": { "type": { "const": "hk.auditor_resignation.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_auditor_resignation_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar that the auditor has resigned", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "auditor_resignation_notice", "title": "Auditor's written notice of resignation", "source": "uploaded", "required": true }, { "key": "auditor_statement", "title": "Statement of circumstances under s.424", "source": "uploaded", "required": true }, { "key": "form_na2", "title": "Form NA2", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "form_na2", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_na2", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NA2", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "statement_of_circumstances_missing", "type": null, "when": "The auditor's s.424 statement of circumstances is not attached; it must accompany the notice." }, { "code": "auditor_not_on_record", "type": null, "when": "No auditor of that name is recorded for the company." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "filing_overdue", "type": null, "when": "Non-blocking: the 15-day deadline has passed." } ] } }, "Params_hk_authorized_representative_remove": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the representative whose authorization ends." }, "terminated_by": { "type": "string", "enum": [ "company", "authorized_representative" ], "description": "Who gave the written notice." }, "notice_date": { "type": "string", "format": "date", "description": "Date of the written notice of termination." }, "termination_date": { "type": "string", "format": "date", "description": "Termination date stated in the written notice." }, "notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Copy of the written notice." }, "notice_delivered_to": { "type": "string", "enum": [ "company_registered_office_in_place_of_incorporation", "authorized_representative_address_on_register" ], "description": "Where the notice was sent, as required." } }, "required": [ "person", "terminated_by", "notice_date", "termination_date", "notice_document_id", "notice_delivered_to" ], "description": "Notifies the Registrar on Form NN2 that the authorization of a registered non-Hong Kong company's representative is terminated by written notice. Termination takes effect on the later of 21 days after delivery of NN2 and the date stated in." }, "Create_hk_authorized_representative_remove": { "type": "object", "properties": { "type": { "const": "hk.authorized_representative.remove" }, "params": { "$ref": "#/components/schemas/Params_hk_authorized_representative_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Terminate the authorization of an authorized representative", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "termination_notice", "title": "Written notice of termination", "source": "uploaded", "required": true }, { "key": "form_nn2", "title": "Form NN2", "source": "generated", "required": true }, { "key": "nn2_receipt", "title": "Registered NN2 and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "termination_notice", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_nn2", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nn2", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN2", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_missing", "type": null, "when": "No copy of the written notice of termination is attached." }, { "code": "no_replacement_representative", "type": null, "when": "No replacement representative has been appointed or is in progress." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_on_register", "type": null, "when": "The person is not on the register in the stated capacity." }, { "code": "filing_overdue", "type": null, "when": "Non-blocking: the 1-month deadline has passed." } ] } }, "Params_hk_company_secretary_appoint": { "type": "object", "properties": { "appointee_type": { "type": "string", "enum": [ "natural_person", "body_corporate", "entiva_partner" ], "description": "natural_person, body_corporate, or entiva_partner." }, "person": { "type": "string", "pattern": "^per_", "description": "Required for natural_person." }, "corporate_appointee": { "type": "object", "description": "Required for body_corporate: name_en, name_zh, registered_office_address, email, business_registration_number, authorised_officer_person_id." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date; starts the 15-day clock." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Required for natural_person: Hong Kong, no PO box (s.650)." }, "tcsp_status": { "type": "object", "description": "Required unless entiva_partner: {licence_number} or {not_required_reason}." }, "replaces": { "type": "object", "description": "Outgoing secretary, reported in section 2 of the same form: secretary_person_id or secretary_entity_id, cessation_date, reason." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Set to a director to have them sign personally; omit and Entiva signs." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "appointee_type", "effective_date" ], "description": "Records the directors' appointment of a company secretary, updates the register and files ND2A within 15 days. The outgoing secretary can be reported on the same form." }, "Create_hk_company_secretary_appoint": { "type": "object", "properties": { "type": { "const": "hk.company_secretary.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_company_secretary_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a company secretary", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_appoint_secretary", "title": "Directors' decision appointing the secretary", "source": "generated", "required": true }, { "key": "secretary_acceptance", "title": "Secretary's written acceptance of office", "source": "generated", "required": true }, { "key": "hk_residence_evidence", "title": "Evidence of Hong Kong residence", "source": "uploaded", "required": false }, { "key": "corporate_appointee_pack", "title": "Third-party corporate secretary documents", "source": "uploaded", "required": false }, { "key": "nd2a", "title": "Form ND2A", "source": "generated", "required": true }, { "key": "pi_nd2a", "title": "PI-ND2A protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution_appoint_secretary", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_acceptance", "signer_role": "appointee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "secretary_acceptance", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "nd2a", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nd2a", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND2A, Notice of Change of Company Secretary and Director", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "secretary_not_resident_in_hk", "type": null, "when": "[requirement_error] An individual lacks evidence of Hong Kong residence (s.474), or a body corporate has no Hong Kong office (s.474)." }, { "code": "sole_director_cannot_be_secretary", "type": null, "when": "[requirement_error] The appointee is the only director of a private company (s.475), or a body corporate whose sole director is that person (s.475)." }, { "code": "tcsp_status_missing", "type": null, "when": "[invalid_request_error] No TCSP licence number or reason for no licence is given for a non-partner appointee." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a step only the person can do: a verification selfie or government login, an acceptance, or a registry signature." } ] } }, "Params_hk_company_secretary_change": { "type": "object", "properties": { "secretary": { "type": "string", "pattern": "^per_", "description": "Individual secretary whose particulars change." }, "secretary_entity_id": { "type": "string", "pattern": "^ent_", "description": "Body-corporate secretary whose particulars change." }, "changes": { "type": "array", "items": {}, "description": "One object per change: field, value, effective_date." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Set to a director to have them sign personally; omit and Entiva signs." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "changes" ], "description": "Records a change in a secretary's registered particulars and files ND2B within 15 days." }, "Create_hk_company_secretary_change": { "type": "object", "properties": { "type": { "const": "hk.company_secretary.change" }, "params": { "$ref": "#/components/schemas/Params_hk_company_secretary_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a company secretary's particulars", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "secretary_change_notice", "title": "Secretary's notice of changed particulars to the company", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of changed name or ID", "source": "uploaded", "required": false }, { "key": "nd2b", "title": "Form ND2B", "source": "generated", "required": true }, { "key": "pi_nd2b", "title": "PI-ND2B protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "secretary_change_notice", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nd2b", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nd2b", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND2B, Notice of Change in Particulars of Company Secretary and Director, Spec. No. 1/", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_changes_supplied", "type": null, "when": "[invalid_request_error] changes is empty or repeats registered values." }, { "code": "correspondence_address_invalid", "type": null, "when": "[invalid_request_error] Address outside Hong Kong or a PO box (s.650)." }, { "code": "tcsp_status_missing", "type": null, "when": "[invalid_request_error] A tcsp_licence change has neither licence number nor reason for no licence." } ] } }, "Params_hk_company_secretary_remove": { "type": "object", "properties": { "secretary": { "type": "string", "pattern": "^per_", "description": "Individual secretary ceasing to act." }, "secretary_entity_id": { "type": "string", "pattern": "^ent_", "description": "Body-corporate secretary ceasing to act." }, "effective_date": { "type": "string", "format": "date", "description": "Date of cessation; not in the future." }, "reason": { "type": "string", "enum": [ "resignation", "removal_by_directors", "term_expired", "death", "other" ], "description": "Prints 'Resignation/Others' on the form, except death." }, "replacement_action_id": { "type": "string", "description": "An hk.company_secretary.appoint action filling the vacancy." }, "resignation_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for resignation: the secretary's written notice to the company (s.477)." }, "death_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for death." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Set to a director to have them sign personally; omit and Entiva signs." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "effective_date", "reason" ], "description": "Records that a company secretary resigned, was removed or died, updates the register and files ND2A section 2 within 15 days. Refuses to leave the company without a secretary." }, "Create_hk_company_secretary_remove": { "type": "object", "properties": { "type": { "const": "hk.company_secretary.remove" }, "params": { "$ref": "#/components/schemas/Params_hk_company_secretary_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the departure of a company secretary", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_remove_secretary", "title": "Directors' decision removing the secretary or noting the cessation", "source": "generated", "required": true }, { "key": "secretary_resignation_letter", "title": "Secretary's notice of resignation to the company", "source": "uploaded", "required": false }, { "key": "death_evidence", "title": "Evidence of death", "source": "uploaded", "required": false }, { "key": "nd2a", "title": "Form ND2A", "source": "generated", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_remove_secretary", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_resignation_letter", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nd2a", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nd2a", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND2A, section 2", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_would_have_no_secretary", "type": null, "when": "[requirement_error] No replacement given and no other secretary in office; the Registrar can direct an appointment." }, { "code": "secretary_not_on_register", "type": null, "when": "[invalid_request_error] The person or body is not the registered secretary." }, { "code": "resignation_notice_missing", "type": null, "when": "[requirement_error] Resignation with no notice on file where the articles or an agreement require it (s.477)." }, { "code": "cessation_date_in_future", "type": null, "when": "[invalid_request_error] ND2A reports a cessation that has happened." } ] } }, "Params_hk_director_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the appointee: a natural person aged 18 or over, or a body corporate." }, "capacity": { "type": "string", "enum": [ "director", "alternate_director" ], "description": "Office being filled." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "appointed_by": { "type": "string", "enum": [ "members_resolution", "board_decision" ], "description": "Which organ appoints, as the articles allow." }, "alternate_for": { "type": "string", "pattern": "^per_", "description": "Principal director the alternate acts for." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Director's correspondence address." }, "usual_residential_address": { "$ref": "#/components/schemas/Address", "description": "Natural person only." }, "corporate_signatory": { "type": "string", "pattern": "^per_", "description": "Body corporate only: the individual who signs the consent for it." }, "email": { "type": "string", "description": "Director's email for registry communications." }, "acts_as_nominee": { "type": "boolean", "description": "True if the appointee acts on another person's instructions." } }, "required": [ "person", "capacity", "effective_date", "appointed_by" ], "description": "Appoints a natural person as director or alternate director of a Hong Kong local company and files Form ND2A within 15 days. The appointee signs the consent to act personally." }, "Create_hk_director_appoint": { "type": "object", "properties": { "type": { "const": "hk.director.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director or alternate director", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointment_resolution", "title": "Resolution or decision appointing the director", "source": "generated", "required": true }, { "key": "consent_to_act_director", "title": "Consent to act as director with confirmation of age 18 or over", "source": "generated", "required": true }, { "key": "form_nd2a", "title": "Form ND2A with PI-ND2A sheet", "source": "generated", "required": true }, { "key": "identity_document", "title": "HKID card or passport of the appointee", "source": "uploaded", "required": true }, { "key": "nd2a_receipt", "title": "Registered ND2A and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "appointee", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointment_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act_director", "signer_role": "appointee", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "consent_to_act_director", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "form_nd2a", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nd2a", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form ND2A with PI-ND2A sheet", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "corporate_director_not_permitted", "type": null, "when": "A body corporate is proposed for a public company, a guarantee company, or a private company in a group with a listed company." }, { "code": "director_under_18", "type": null, "when": "The appointee is under 18." }, { "code": "acts_as_nominee_use_nominee_action", "type": null, "when": "acts_as_nominee is true." }, { "code": "principal_director_invalid", "type": null, "when": "capacity is alternate_director and alternate_for_person_id is missing or not a current director." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_verified", "type": null, "when": "A person is below the required verification level or has an open sanctions alert." } ] } }, "Params_hk_lpf_general_partner_change": { "type": "object", "properties": { "outgoing_general_partner": { "type": "string", "pattern": "^per_", "description": "per_ id of the general partner leaving." }, "reason": { "type": "string", "enum": [ "withdrawal", "removal", "replacement" ], "description": "Why the general partner is leaving." }, "effective_date": { "type": "string", "format": "date", "description": "Date the outgoing general partner ceased." }, "general_partner": { "type": "string", "pattern": "^per_", "description": "per_ id of the incoming general partner." }, "general_partner_type": { "type": "string", "enum": [ "natural_person_18_plus", "hk_private_company_limited_by_shares", "foreign_company", "redomiciled_private_company", "cap37_limited_partnership", "lpf", "non_hk_partnership_with_legal_personality", "non_hk_partnership_without_legal_personality" ], "description": "Eligible types only." }, "date_became_general_partner": { "type": "string", "format": "date", "description": "Date the incoming general partner took office." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Required when the new general partner is another LPF or a non-HK partnership without legal personality: the person appointed under s.23." }, "partners_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "Executed partnership agreement amendment or partners' consent to the change." } }, "required": [ "outgoing_general_partner", "reason", "effective_date", "general_partner", "general_partner_type", "date_became_general_partner", "partners_consent_document_id" ], "description": "Reports the withdrawal, removal or replacement of an LPF's general partner and the new general partner on Form LPF4C within 15 days. An LPF must have exactly one general partner at all times." }, "Create_hk_lpf_general_partner_change": { "type": "object", "properties": { "type": { "const": "hk.lpf_general_partner.change" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_general_partner_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the general partner of a limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_consent", "title": "Partners' consent or amendment to the limited partnership agreement", "source": "uploaded", "required": true }, { "key": "new_gp_entity_documents", "title": "Certificate of incorporation, registry extract, constitution, ownership chart and board resolution.", "source": "uploaded", "required": false }, { "key": "identity_document", "title": "HKID card or passport of a natural-person GP", "source": "uploaded", "required": false }, { "key": "form_lpf4c", "title": "Form LPF4C", "source": "generated", "required": true }, { "key": "lpf4c_receipt", "title": "Registered LPF4C and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_consent", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "form_lpf4c", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_lpf4c", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_lpf4c", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF4C", "channel": "both", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lpf_must_have_one_general_partner", "type": null, "when": "The change would leave the fund with none or more than one general partner." }, { "code": "general_partner_type_not_eligible", "type": null, "when": "The incoming general partner is not one of the eight eligible types." }, { "code": "authorized_representative_required", "type": null, "when": "The new GP is another LPF or a non-HK partnership without legal personality and no authorized representative is given." }, { "code": "partners_consent_missing", "type": null, "when": "No partners' consent or LPA amendment is attached." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_verified", "type": null, "when": "A person is below the required verification level or has an open sanctions alert." } ] } }, "Params_hk_lpf_officer_change": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "authorized_representative", "investment_manager", "responsible_person" ], "description": "Role changing." }, "outgoing": { "type": "string", "pattern": "^per_", "description": "per_ id of the party ceasing." }, "effective_date": { "type": "string", "format": "date", "description": "Date of cessation." }, "incoming": { "type": "string", "pattern": "^per_", "description": "per_ id of the new party." }, "incoming_type": { "type": "string", "enum": [ "hk_resident_individual_18_plus", "company", "foreign_company", "authorized_institution", "licensed_corporation", "accounting_professional", "legal_professional" ], "description": "Authorized representative or manager: HK resident aged 18+, company or registered non-HK company." }, "appointment_date": { "type": "string", "format": "date", "description": "Date of appointment." }, "status_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "SFC or banking licence, or professional practising evidence." }, "hong_kong_address": { "$ref": "#/components/schemas/Address", "description": "Authorized representative only: correspondence address, registered office or Hong Kong place of business." } }, "required": [ "role" ], "description": "Reports a new, replaced or ceasing authorized representative, investment manager or responsible person of a limited partnership fund on Form LPF4C within 15 days." }, "Create_hk_lpf_officer_change": { "type": "object", "properties": { "type": { "const": "hk.lpf_officer.change" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_officer_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint, replace or remove an LPF's authorized representative, investment manager or responsible person", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_lpf4c", "title": "Form LPF4C", "source": "generated", "required": true }, { "key": "status_evidence", "title": "Licence, practising or registry evidence of the incoming party", "source": "uploaded", "required": false }, { "key": "lpf4c_receipt", "title": "Registered LPF4C and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "appointee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_lpf4c", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_lpf4c", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_lpf4c", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF4C", "channel": "both", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "role_not_applicable", "type": null, "when": "role is authorized_representative but the GP is not another LPF or a non-HK partnership without legal personality." }, { "code": "incoming_party_not_eligible", "type": null, "when": "The incoming party is not an eligible type for the role." }, { "code": "role_would_be_vacant", "type": null, "when": "The change would leave the fund without a required investment manager or responsible person." }, { "code": "no_change_supplied", "type": null, "when": "Neither outgoing_person_id nor incoming_person_id is given." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." } ] } }, "Params_hk_nominee_director_appoint": { "type": "object", "properties": { "nominee_provider": { "type": "string", "enum": [ "partner_individual", "partner_body_corporate" ], "description": "Whom the partner supplies." }, "nominator": { "type": "string", "pattern": "^per_", "description": "per_ id of the person or entity on whose instructions the nominee acts." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "appointed_by": { "type": "string", "enum": [ "members_resolution", "board_decision" ], "description": "Which organ appoints, as the articles allow." }, "purpose_of_arrangement": { "type": "string", "description": "Why a nominee is used." }, "source_of_funds_document_id": { "type": "string", "pattern": "^doc_", "description": "Evidence of the nominator's source of funds and wealth." }, "term_months": { "type": "integer", "description": "Service term in months; renews annually unless cancelled." }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "Executed appointing resolution." } }, "required": [ "nominee_provider", "nominator", "effective_date", "appointed_by", "purpose_of_arrangement", "source_of_funds_document_id" ], "description": "Appoints a nominee director arranged by Entiva's TCSP-Entiva, after enhanced due diligence on the nominator, and files Form ND2A within 15 days. Hong Kong has no resident-director requirement; this is an optional regulated service." }, "Create_hk_nominee_director_appoint": { "type": "object", "properties": { "type": { "const": "hk.nominee_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_nominee_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a nominee director supplied by Entiva's Entiva", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nominee_services_agreement", "title": "Nominee director services agreement", "source": "generated", "required": true }, { "key": "nominator_declaration", "title": "Nominator's declaration of identity, ownership and instructions", "source": "generated", "required": true }, { "key": "source_of_funds", "title": "Source of funds and wealth evidence", "source": "uploaded", "required": true }, { "key": "appointment_resolution", "title": "Resolution or decision appointing the director", "source": "generated", "required": true }, { "key": "consent_to_act_director", "title": "Consent to act as director", "source": "generated", "required": true }, { "key": "form_nd2a", "title": "Form ND2A with PI-ND2A sheet", "source": "generated", "required": true }, { "key": "nd2a_receipt", "title": "Registered ND2A and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "nominator", "verification_level": "enhanced" }, { "role": "nominee_director", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nominee_services_agreement", "signer_role": "nominator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nominee_services_agreement", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act_director", "signer_role": "nominee_director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "form_nd2a", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form ND2A with PI-ND2A sheet", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "tcsp_licence_not_active", "type": null, "when": "The partner's TCSP licence is not current on the Registrar's register." }, { "code": "enhanced_due_diligence_pending", "type": null, "when": "Nominator or nominee has not completed source of funds, source of wealth and adverse-media review." }, { "code": "corporate_nominee_not_permitted", "type": null, "when": "partner_body_corporate would be the only director, or the company is not eligible for a body corporate director." }, { "code": "nominator_sanctions_alert", "type": null, "when": "An open sanctions alert on the nominator pauses the action." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_verified", "type": null, "when": "A person is below the required verification level or has an open sanctions alert." } ] } }, "Params_hk_non_hk_company_officer_appoint": { "type": "object", "properties": { "capacity": { "type": "string", "enum": [ "director", "alternate_director", "company_secretary", "authorized_representative" ], "description": "Office being filled. authorized_representative accepts service of process in Hong Kong and uses NN8; the others use NN6." }, "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the appointee: natural person, body corporate or an eligible firm." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "appointment_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Resolution or record of appointment under the company's home-country constitution." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Officers: correspondence address." }, "usual_residential_address": { "$ref": "#/components/schemas/Address", "description": "Directors who are natural persons: reported on the PI-NN6 sheet, withheld from public inspection." }, "alternate_for": { "type": "string", "pattern": "^per_", "description": "Principal director when capacity is alternate_director." }, "representative_type": { "type": "string", "enum": [ "natural_person", "firm_of_solicitors", "solicitor_corporation", "cpa_firm", "cpa_corporate_practice" ], "description": "Representatives only." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Representatives only: the outgoing one, reported as ceasing on the same NN8." } }, "required": [ "capacity", "person", "effective_date", "appointment_evidence_document_id" ], "description": "Reports a new director, alternate director, company secretary or authorized representative of a Part 16 registered non-Hong Kong company within 1 month." }, "Create_hk_non_hk_company_officer_appoint": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_officer.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_officer_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director, secretary or authorized representative of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointment_evidence", "title": "Home-jurisdiction record appointing the officer or representative", "source": "uploaded", "required": true }, { "key": "form_nn6_nn8", "title": "Form NN6 or NN8 with PI sheet", "source": "generated", "required": true }, { "key": "identity_document", "title": "HKID card or passport of the appointee", "source": "uploaded", "required": true } ], "people": [ { "role": "appointee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointment_evidence", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_nn6_nn8", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nn6_nn8", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN6", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "representative_not_eligible", "type": null, "when": "A representative is not a natural person with a Hong Kong address, a solicitors' firm or corporation, or a CPA firm or corporate practice." }, { "code": "foreign_constitution_not_on_file", "type": null, "when": "The home-country constitution needed to check the appointment is missing." }, { "code": "principal_director_invalid", "type": null, "when": "capacity is alternate_director and alternate_for_person_id is missing or not a current director." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_verified", "type": null, "when": "A person is below the required verification level or has an open sanctions alert." } ] } }, "Params_hk_non_hk_company_officer_cease": { "type": "object", "properties": { "capacity": { "type": "string", "enum": [ "director", "alternate_director", "company_secretary", "authorized_representative" ], "description": "Office that ended." }, "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the officer or representative who ceased." }, "effective_date": { "type": "string", "format": "date", "description": "Date of cessation." }, "replacement_action_id": { "type": "string", "description": "Representatives: act_ id of the hk.non_hk_company_officer.appoint action filed together, so the company keeps a representative." }, "continues_in_other_capacity": { "type": "boolean", "description": "Directors: whether the person still holds office as another director or alternate director." }, "cessation_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Resignation, removal record or death evidence under home-country law." } }, "required": [ "capacity", "person", "effective_date" ], "description": "Reports a director, alternate director, company secretary or authorized representative ceasing to act, within 1 month. Use hk.authorized_representative.terminate when the authorization ends by written notice." }, "Create_hk_non_hk_company_officer_cease": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_officer.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_officer_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record that a director, secretary or authorized representative of a registered non-Hong Kong company has ceased", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_nn6_nn8", "title": "Form NN6 or NN8, cessation section", "source": "generated", "required": true }, { "key": "cessation_evidence", "title": "Record of resignation, removal or death", "source": "uploaded", "required": false }, { "key": "nn_receipt", "title": "Registered NN6 or NN8 and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "form_nn6_nn8", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nn6_nn8", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN6 or NN8, cessation section", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_replacement_representative", "type": null, "when": "capacity is authorized_representative and no replacement is given; the company must keep one." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_on_register", "type": null, "when": "The person is not on the register in the stated capacity." }, { "code": "filing_overdue", "type": null, "when": "Non-blocking: the 1-month deadline has passed." } ] } }, "Params_hk_non_hk_company_officer_change": { "type": "object", "properties": { "capacity": { "type": "string", "enum": [ "director", "alternate_director", "company_secretary", "authorized_representative" ], "description": "Office held." }, "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the officer or representative whose particulars changed." }, "changes": { "type": "array", "items": {}, "description": "Each item: field, new_value, effective_date." }, "evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "New ID document for a name or ID change." } }, "required": [ "capacity", "person", "changes" ], "description": "Updates the name, addresses, email or ID details of a director, alternate director, company secretary or authorized representative within 1 month." }, "Create_hk_non_hk_company_officer_change": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_officer.change" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_officer_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the particulars of an officer or authorized representative of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_nn7_nn8c", "title": "Form NN7 or NN8C with PI sheet", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "change_confirmation", "title": "Officer's confirmation of the change", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "change_confirmation", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_nn7_nn8c", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nn7_nn8c", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN7", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_must_match_id", "type": null, "when": "A new name is not supported by the new HKID or passport." }, { "code": "no_changes_supplied", "type": null, "when": "changes is empty or repeats the registered values." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_on_register", "type": null, "when": "The person is not on the register in the stated capacity." }, { "code": "filing_overdue", "type": null, "when": "Non-blocking: the 1-month deadline has passed." } ] } }, "Params_hk_ofc_custodian_appoint": { "type": "object", "properties": { "offering": { "type": "string", "enum": [ "private_ofc", "public_ofc" ], "description": "private_ofc or public_ofc." }, "proposed_custodian": { "type": "object", "description": "name_en, name_zh, jurisdiction, registration_number, custodian_category, sfc_ce_number, address, authorised_signatory_person_id, process_agent {name, address}." }, "appointment_kind": { "type": "string", "enum": [ "replacement", "additional" ], "description": "replacement of the existing custodian, or an additional one." }, "replaced_custodian_name": { "type": "string", "description": "Required for a replacement." }, "intended_effective_date": { "type": "string", "format": "date", "description": "Intended date of appointment; omit for as soon as practicable after approval." }, "already_custodian_of_other_sfc_funds": { "type": "boolean", "description": "Already custodian of another SFC-registered OFC or SFC-authorised fund?" }, "same_ultimate_holding_company_as_investment_manager": { "type": "boolean", "description": "If true, Annex D is needed." }, "independent_directors_remain_compliant": { "type": "boolean", "description": "Will independent directors still meet OFC Code 5.2?" }, "confirm_shareholder_notices_and_approvals": { "type": "boolean", "description": "Must be true: shareholder notices and approvals required by the instrument of incorporation and offering documents are done." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director of the OFC, or senior executive of the investment manager, authorised by the board to sign." }, "law_firm": { "type": "object", "description": "Instructed law firm: firm_name, lawyer_in_charge, position, phone, email, address." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via the e-IP Smart-form on SFC WINGS, or paper." } }, "required": [ "offering", "proposed_custodian", "appointment_kind", "already_custodian_of_other_sfc_funds", "same_ultimate_holding_company_as_investment_manager", "independent_directors_remain_compliant", "confirm_shareholder_notices_and_approvals", "authorised_signatory" ], "description": "Prepares and lodges the application for the SFC's prior approval of a new or replacement OFC custodian, then records the directors' appointment once approved. Nothing is filed with the Companies Registry." }, "Create_hk_ofc_custodian_appoint": { "type": "object", "properties": { "type": { "const": "hk.ofc_custodian.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_custodian_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the SFC to appoint an OFC custodian (rule 114)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_apply", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "sfc_application_form", "title": "SFC application form", "source": "generated", "required": true }, { "key": "sfc_information_checklist", "title": "SFC information checklist", "source": "generated", "required": true }, { "key": "custodian_confirmations_annex_b1", "title": "Proposed custodian's confirmations", "source": "uploaded", "required": true }, { "key": "directors_confirmations_annex_b2", "title": "Directors' confirmations on the custodian's controls", "source": "generated", "required": false }, { "key": "custodian_credentials", "title": "Custodian credentials", "source": "uploaded", "required": false }, { "key": "annex_d_same_group", "title": "Annex D", "source": "uploaded", "required": false }, { "key": "sfc_approval_letter", "title": "SFC's written approval", "source": "registry_issued", "required": true }, { "key": "board_resolution_appoint", "title": "Directors' appointment of the custodian", "source": "generated", "required": true }, { "key": "process_agent_record", "title": "Record of the custodian's process agent", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "process_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_apply", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sfc_application_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "sfc_information_checklist", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "custodian_confirmations_annex_b1", "signer_role": "custodian", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "directors_confirmations_annex_b2", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "annex_d_same_group", "signer_role": "manager", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution_appoint", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission, Investment Products Division", "form": "SFC application form Private OFC 3", "channel": "both", "government_fee": { "amount": 300, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "custodian_ineligible", "type": null, "when": "[requirement_error] Category or evidence does not support OFC Code 7.1; Entiva flags it, the SFC decides." }, { "code": "process_agent_required", "type": null, "when": "[requirement_error] Non-Hong Kong custodian with no process agent (r.115,)." }, { "code": "replaced_custodian_missing", "type": null, "when": "[invalid_request_error] Replacement without the existing custodian named." }, { "code": "appointment_before_approval", "type": null, "when": "[requirement_error] Appointment marked effective before SFC approval; it has no effect and making it is an offence (OFC Rules r.114 to)." } ] } }, "Params_hk_ofc_custodian_cease": { "type": "object", "properties": { "outgoing_custodian_name": { "type": "string", "description": "The custodian that ceased, as recorded." }, "effective_date": { "type": "string", "format": "date", "description": "Date the custodian ceased; starts the 15-day clock." }, "reason": { "type": "string", "enum": [ "resigned", "removed_by_directors", "replaced_by_approved_custodian", "other" ], "description": "A cessation by Court order under SFO s.213 is outside this action (r.118)." }, "replacement_action_id": { "type": "string", "description": "The hk.ofc_custodian.appoint action for the successor (SFO s.112ZA)." }, "custodian_statement_type": { "type": "string", "enum": [ "circumstances_stated", "no_circumstances" ], "description": "What the outgoing custodian's r.119 statement says." }, "custodian_statement_document_id": { "type": "string", "pattern": "^doc_", "description": "The outgoing custodian's statement; it sends its own copy to the SFC (r.119)." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director of the OFC, or senior executive of the investment manager, authorised by the board to sign." }, "delivery_channel": { "type": "string", "enum": [ "paper", "online" ], "description": "paper: written notice." } }, "required": [ "outgoing_custodian_name", "effective_date", "reason", "custodian_statement_type", "custodian_statement_document_id", "authorised_signatory" ], "description": "Gives the SFC the written notice the OFC must send within 15 days after its custodian ceases, collects the outgoing custodian's statement, and handles shareholder circulation if it reports circumstances. Nothing is filed with the Companies." }, "Create_hk_ofc_custodian_cease": { "type": "object", "properties": { "type": { "const": "hk.ofc_custodian.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_custodian_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the SFC that an OFC custodian has ceased (rule 118)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_note_cessation", "title": "Directors' resolution noting the cessation", "source": "generated", "required": true }, { "key": "custodian_statement_r119", "title": "Outgoing custodian's statement (r.119)", "source": "uploaded", "required": true }, { "key": "sfc_cessation_notice", "title": "Written notice of cessation to the SFC", "source": "generated", "required": true }, { "key": "shareholder_circulation_evidence", "title": "Evidence the statement went to shareholders, or a court application", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "custodian", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_note_cessation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sfc_cessation_notice", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission, Investment Products Division", "form": "Written notice under OFC Rules r.118", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cessation_date_in_future", "type": null, "when": "[invalid_request_error] The notice reports a cessation that has happened." }, { "code": "cessation_by_court_order", "type": null, "when": "[requirement_error] Ceased by Court order under SFO s.213; r.118 does not apply." }, { "code": "no_custodian_remaining", "type": null, "when": "[requirement_error] No replacement and no other custodian recorded (SFO s.112ZA)." }, { "code": "statement_missing", "type": null, "when": "[requirement_error] No r.119 statement on file." } ] } }, "Params_hk_ofc_director_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the new director." }, "effective_date": { "type": "string", "format": "date", "description": "Date of appointment." }, "sfc_approval_reference": { "type": "string", "description": "Reference of the SFC's prior approval under rule 101 or 103 of Cap. 571AQ." }, "sfc_approval_document_id": { "type": "string", "pattern": "^doc_", "description": "The SFC approval letter." }, "usual_residential_address": { "$ref": "#/components/schemas/Address", "description": "Director's usual residential address." }, "email": { "type": "string", "description": "Director's email for registry communications." }, "process_agent": { "type": "string", "pattern": "^per_", "description": "Required when the usual residential address is outside Hong Kong: an individual with a Hong Kong residence, a company with a Hong Kong registered office, or a." } }, "required": [ "person", "effective_date", "sfc_approval_reference", "sfc_approval_document_id", "usual_residential_address" ], "description": "Files Form OFCD1 to report a new OFC director, after the SFC has approved the appointment, and the process agent of a non-resident director. The form is delivered to the SFC, which sends it to the Companies Registry, within 15 days." }, "Create_hk_ofc_director_appoint": { "type": "object", "properties": { "type": { "const": "hk.ofc_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director of an open-ended fund company", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sfc_approval_letter", "title": "SFC approval of the appointment", "source": "uploaded", "required": true }, { "key": "appointment_resolution", "title": "Board decision or instrument-based appointment", "source": "generated", "required": true }, { "key": "form_ofcd1", "title": "Form OFCD1 with director and process agent sections", "source": "generated", "required": true }, { "key": "identity_document", "title": "HKID card or passport of the director", "source": "uploaded", "required": true }, { "key": "ofcd1_receipt", "title": "Registered notice and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "process_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_ofcd1", "signer_role": "appointee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_ofcd1", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission, for sending to the Companies Registry", "form": "Form OFCD1", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "sfc_approval_missing", "type": null, "when": "No SFC approval is attached." }, { "code": "body_corporate_director_not_permitted", "type": null, "when": "A body corporate is proposed; an OFC director must be a natural person (SFO s.112V)." }, { "code": "process_agent_required", "type": null, "when": "The usual residential address is outside Hong Kong and no process agent is given (rule 102)." }, { "code": "process_agent_not_eligible", "type": null, "when": "The process agent is not an individual with a Hong Kong residence, a company with a Hong Kong registered office, or a firm of solicitors or CPAs." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_verified", "type": null, "when": "A person is below the required verification level or has an open sanctions alert." } ] } }, "Params_hk_ofc_director_cease": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the director who ceased." }, "effective_date": { "type": "string", "format": "date", "description": "Date of cessation." }, "reason": { "type": "string", "enum": [ "resignation", "removal", "other" ], "description": "Why the office ended." }, "process_agent": { "type": "string", "pattern": "^per_", "description": "The director's process agent, if the director was non-resident." }, "resignation_letter_document_id": { "type": "string", "pattern": "^doc_", "description": "Director's notice of resignation to the OFC." } }, "required": [ "person", "effective_date", "reason" ], "description": "Files Form OFCD2 to report that an OFC director, and the process agent of a non-resident director, has ceased to hold office, within 15 days." }, "Create_hk_ofc_director_cease": { "type": "object", "properties": { "type": { "const": "hk.ofc_director.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_director_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the cessation of an OFC director", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Director's notice of resignation", "source": "uploaded", "required": false }, { "key": "form_ofcd2", "title": "Form OFCD2", "source": "generated", "required": true }, { "key": "ofcd2_receipt", "title": "Registered notice and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_ofcd2", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form OFCD2", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "minimum_two_directors", "type": null, "when": "Cessation would leave the OFC with fewer than two directors." }, { "code": "process_agent_not_ceased", "type": null, "when": "A non-resident director is ceasing and process_agent_person_id is missing." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_on_register", "type": null, "when": "The person is not on the register in the stated capacity." }, { "code": "filing_overdue", "type": null, "when": "Non-blocking: the 15-day deadline has passed." } ] } }, "Params_hk_ofc_director_change": { "type": "object", "properties": { "subject": { "type": "string", "enum": [ "director", "process_agent" ], "description": "Whose particulars changed." }, "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the director or of the process agent." }, "changes": { "type": "array", "items": {}, "description": "Each item: field, new_value, effective_date." }, "directors": { "type": "array", "items": {}, "description": "Process agent changes: per_ ids of the non-resident directors the agent acts for." }, "process_agent": { "type": "string", "pattern": "^per_", "description": "Director changes to a non-Hong Kong address: the process agent, if none is registered." } }, "required": [ "subject", "person", "changes" ], "description": "Files Form OFCD3 or OFCPA1 to update names, addresses, email or ID details within 15 days." }, "Create_hk_ofc_director_change": { "type": "object", "properties": { "type": { "const": "hk.ofc_director.change" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_director_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the particulars of an OFC director or of a non-resident director's process agent", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_ofcd3_ofcpa1", "title": "Form OFCD3 or OFCPA1", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "change_confirmation", "title": "Officer's confirmation of the change", "source": "generated", "required": true } ], "people": [ { "role": "appointee", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "change_confirmation", "signer_role": "appointee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_ofcd3_ofcpa1", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form OFCD3", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "process_agent_required", "type": null, "when": "A director's new address is outside Hong Kong and no process agent is registered; report one on OFCD1 first." }, { "code": "process_agent_not_eligible", "type": null, "when": "The changed particulars make the agent ineligible, for example no Hong Kong address." }, { "code": "no_changes_supplied", "type": null, "when": "changes is empty or repeats the registered values." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_on_register", "type": null, "when": "The person is not on the register in the stated capacity." } ] } }, "Params_hk_ofc_investment_manager_appoint": { "type": "object", "properties": { "offering": { "type": "string", "enum": [ "private_ofc", "public_ofc" ], "description": "private_ofc or public_ofc." }, "proposed_investment_manager": { "type": "object", "description": "name_en, name_zh, jurisdiction, registration_number, sfc_ce_number, licence_status, address, authorised_signatory_person_id." }, "appointment_kind": { "type": "string", "enum": [ "replacement", "additional" ], "description": "replacement of the existing investment manager, or an additional one." }, "replaced_investment_manager_name": { "type": "string", "description": "Required for a replacement." }, "intended_effective_date": { "type": "string", "format": "date", "description": "Intended date of appointment; omit for as soon as practicable after approval." }, "manages_other_sfc_funds": { "type": "boolean", "description": "Already manages another SFC-registered OFC or SFC-authorised fund?" }, "same_ultimate_holding_company_as_custodian": { "type": "boolean", "description": "If true, Annex D is needed." }, "confirm_shareholder_notices_and_approvals": { "type": "boolean", "description": "Must be true: shareholder notices and approvals required by the instrument of incorporation and offering documents are done." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director of the OFC, or senior executive of the investment manager, authorised by the board to sign." }, "law_firm": { "type": "object", "description": "Instructed law firm: firm_name, lawyer_in_charge, position, phone, email, address." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via the e-IP Smart-form on SFC WINGS, or paper." } }, "required": [ "offering", "proposed_investment_manager", "appointment_kind", "manages_other_sfc_funds", "same_ultimate_holding_company_as_custodian", "confirm_shareholder_notices_and_approvals", "authorised_signatory" ], "description": "Prepares and lodges the application for the SFC's prior approval of a new or replacement OFC investment manager, then records the directors' appointment once approved. The manager must be licensed or registered for Type 9." }, "Create_hk_ofc_investment_manager_appoint": { "type": "object", "properties": { "type": { "const": "hk.ofc_investment_manager.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_investment_manager_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the SFC to appoint an OFC investment manager (rule 125)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_apply", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "sfc_application_form", "title": "SFC application form", "source": "generated", "required": true }, { "key": "sfc_information_checklist", "title": "SFC information checklist", "source": "generated", "required": true }, { "key": "im_confirmation_annex_c", "title": "Proposed manager's confirmation", "source": "uploaded", "required": true }, { "key": "im_licence_evidence", "title": "Copy of the manager's Type 9 licence or registration", "source": "uploaded", "required": false }, { "key": "annex_d_same_group", "title": "Annex D", "source": "uploaded", "required": false }, { "key": "sfc_approval_letter", "title": "SFC's written approval", "source": "registry_issued", "required": true }, { "key": "board_resolution_appoint", "title": "Directors' appointment of the investment manager", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_apply", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sfc_application_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "sfc_information_checklist", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "im_confirmation_annex_c", "signer_role": "manager", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "annex_d_same_group", "signer_role": "custodian", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution_appoint", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission, Investment Products Division", "form": "SFC application form Private OFC 3", "channel": "both", "government_fee": { "amount": 300, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "investment_manager_not_type_9", "type": null, "when": "[requirement_error] licence_status is not licensed, registered or application_pending for Type 9 (SFO s.112Z)." }, { "code": "replaced_investment_manager_missing", "type": null, "when": "[invalid_request_error] Replacement without the existing manager named." }, { "code": "appointment_before_approval", "type": null, "when": "[requirement_error] Appointment marked effective before SFC approval; it has no effect (OFC Rules r.125,)." }, { "code": "sfc_requisition_open", "type": null, "when": "[registry_error] The SFC raised a requisition; the action returns to requirements_pending." } ] } }, "Params_hk_ofc_investment_manager_cease": { "type": "object", "properties": { "outgoing_investment_manager_name": { "type": "string", "description": "The manager that ceased, as recorded." }, "effective_date": { "type": "string", "format": "date", "description": "Date the manager ceased; starts the 15-day clock." }, "reason": { "type": "string", "enum": [ "resigned", "terminated_by_directors", "replaced_by_approved_manager", "other" ], "description": "A cessation by Court order under SFO s.213 or s.214A is outside this action (r.127)." }, "replacement_action_id": { "type": "string", "description": "The hk.ofc_investment_manager.appoint action for the successor (SFO s.112Z)." }, "termination_document_id": { "type": "string", "pattern": "^doc_", "description": "The manager's resignation or the OFC's termination notice." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director of the OFC, or senior executive of the investment manager, authorised by the board to sign." }, "delivery_channel": { "type": "string", "enum": [ "paper", "online" ], "description": "paper: written notice." } }, "required": [ "outgoing_investment_manager_name", "effective_date", "reason", "authorised_signatory" ], "description": "Gives the SFC the written notice the OFC must send within 15 days after its investment manager ceases to act. Nothing is filed with the Companies Registry." }, "Create_hk_ofc_investment_manager_cease": { "type": "object", "properties": { "type": { "const": "hk.ofc_investment_manager.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_investment_manager_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the SFC that an OFC investment manager has ceased (rule 127)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_note_cessation", "title": "Directors' resolution noting the cessation", "source": "generated", "required": true }, { "key": "im_termination_notice", "title": "Manager's resignation or termination notice", "source": "uploaded", "required": false }, { "key": "sfc_cessation_notice", "title": "Written notice of cessation to the SFC", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "manager", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_note_cessation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sfc_cessation_notice", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission, Investment Products Division", "form": "Written notice under OFC Rules r.127", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cessation_date_in_future", "type": null, "when": "[invalid_request_error] The notice reports a cessation that has happened." }, { "code": "cessation_by_court_order", "type": null, "when": "[requirement_error] Ceased by Court order under SFO s.213 or s.214A; r.127 does not apply." }, { "code": "no_investment_manager_remaining", "type": null, "when": "[requirement_error] No replacement and no other manager recorded (SFO s.112Z)." } ] } }, "Params_hk_officer_change": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the officer whose particulars changed." }, "capacity": { "type": "string", "enum": [ "director", "alternate_director", "reserve_director", "company_secretary" ], "description": "Office held." }, "changes": { "type": "array", "items": {}, "description": "Each item: field, new_value, effective_date." }, "evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "New HKID or passport page." }, "batch_all_client_companies": { "type": "boolean", "description": "Account-level: apply the change to every company in the account and file by bulk submission." } }, "required": [ "person", "capacity", "changes" ], "description": "Updates the registered name, aliases, addresses, email, ID details or TCSP licence status of a director, alternate director, reserve director or company secretary. Files ND2B, or ND7 for a reserve director, within 15 days." }, "Create_hk_officer_change": { "type": "object", "properties": { "type": { "const": "hk.officer.change" }, "params": { "$ref": "#/components/schemas/Params_hk_officer_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered particulars of a director, reserve director or company secretary", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_nd2b", "title": "Form ND2B with PI sheet", "source": "generated", "required": true }, { "key": "change_evidence", "title": "New ID document or other evidence of the change", "source": "uploaded", "required": false }, { "key": "change_confirmation", "title": "Officer's confirmation of the change", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "change_confirmation", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_nd2b", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nd2b", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form ND2B with PI-ND2B sheet", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_must_match_id", "type": null, "when": "A new name is not supported by the new HKID or passport." }, { "code": "no_changes_supplied", "type": null, "when": "changes is empty or repeats the registered values." }, { "code": "po_box_not_accepted", "type": null, "when": "An address is a PO box or, for the PI sheet, a 'care of' address." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_verified", "type": null, "when": "A person is below the required verification level or has an open sanctions alert." } ] } }, "Params_hk_officer_remove": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the director, alternate director or secretary who is ceasing." }, "capacity": { "type": "string", "enum": [ "director", "alternate_director", "company_secretary" ], "description": "Office that is ending." }, "effective_date": { "type": "string", "format": "date", "description": "Date of cessation." }, "reason": { "type": "string", "enum": [ "resignation", "removal", "vacation_of_office", "death" ], "description": "Why the office ended." }, "continues_in_other_capacity": { "type": "boolean", "description": "Whether the person still holds office as another director or alternate director." }, "resignation_letter_document_id": { "type": "string", "pattern": "^doc_", "description": "Resignation notice to the company." }, "removal_document_id": { "type": "string", "pattern": "^doc_", "description": "Removal of a director: minutes of the general meeting." }, "replacement_action_id": { "type": "string", "description": "act_ id of the hk.director.appoint or hk.company_secretary.appoint action that restores the minimum officers, filed together." } }, "required": [ "person", "capacity", "effective_date", "reason" ], "description": "Records the end of a director's, alternate director's or company secretary's office and files the cessation part of Form ND2A within 15 days." }, "Create_hk_officer_remove": { "type": "object", "properties": { "type": { "const": "hk.officer.remove" }, "params": { "$ref": "#/components/schemas/Params_hk_officer_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a director or company secretary, or record a resignation or death", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Notice of resignation to the company", "source": "uploaded", "required": false }, { "key": "removal_record", "title": "Minutes of the general meeting or board decision", "source": "generated", "required": false }, { "key": "form_nd2a", "title": "Form ND2A", "source": "generated", "required": true }, { "key": "nd2a_receipt", "title": "Registered ND2A and CR acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "removal_record", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_nd2a", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nd2a", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form ND2A, cessation section", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "minimum_directors_not_met", "type": null, "when": "Removal would leave a private company without a natural-person director, or a public or guarantee company with fewer than two directors." }, { "code": "no_replacement_secretary", "type": null, "when": "A secretary is ceasing and no replacement takes office on or before cessation_date (s.474)." }, { "code": "sole_director_would_be_secretary", "type": null, "when": "The remaining sole director of a private company is also its secretary (Cap. 622 s.475)." }, { "code": "written_resolution_not_permitted", "type": null, "when": "Removal by members is proposed as a written resolution." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." }, { "code": "person_not_on_register", "type": null, "when": "The person is not on the register in the stated capacity." } ] } }, "Params_hk_principal_office_change": { "type": "object", "properties": { "principal_office_address": { "$ref": "#/components/schemas/Address", "description": "The new address of the principal office." }, "effective_date": { "type": "string", "format": "date", "description": "Date the office moved; starts the 28-day clock." }, "signing_trustee": { "type": "string", "pattern": "^per_", "description": "A current trustee who signs the notification." }, "delivery_method": { "type": "string", "enum": [ "post", "in_person" ], "description": "post or in_person at the CR, 14th floor, Queensway Government Offices." } }, "required": [ "principal_office_address", "effective_date", "signing_trustee" ], "description": "Records a change of the principal office of a registered trustees corporation and gives the Registrar written notice within 28 days. No fee is prescribed." }, "Create_hk_principal_office_change": { "type": "object", "properties": { "type": { "const": "hk.principal_office.change" }, "params": { "$ref": "#/components/schemas/Params_hk_principal_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar of a change of principal office (Cap. 306 s.9)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "registered_trustees_corporation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "principal_office_resolution", "title": "Record of the decision to move the principal office", "source": "generated", "required": false }, { "key": "principal_office_notice", "title": "Notice of change of principal office", "source": "generated", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "principal_office_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "principal_office_notice", "signer_role": "trustee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Written notice of change of principal office", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_invalid", "type": null, "when": "[invalid_request_error] The new address is blank or a PO box." }, { "code": "office_unchanged", "type": null, "when": "[invalid_request_error] The address matches the registered principal office." } ] } }, "Params_hk_protected_information_withhold": { "type": "object", "properties": { "applicant": { "type": "string", "pattern": "^per_", "description": "The data subject." }, "documents": { "type": "array", "items": {}, "description": "One object per registered document: document_name, document_reference_number, capacity, withhold, id_location and address_location." }, "public_correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Required if an address is withheld: shown instead (s.49); no PO box." }, "applicant_correspondence_address": { "$ref": "#/components/schemas/Address", "description": "The applicant's own correspondence address." }, "identification_check": { "type": "string", "enum": [ "original_in_person", "certified_copy" ], "description": "original_in_person at the CR e-Services Centre, or certified_copy sent with the form." }, "certifier_type": { "type": "string", "enum": [ "notary_public", "solicitor", "practising_cpa", "court_officer", "professional_company_secretary", "consular_officer" ], "description": "Required for certified_copy." }, "delivery_method": { "type": "string", "enum": [ "post", "in_person" ], "description": "post to the Public Search Section, or in_person at the CR e-Services Centre, 13/F Queensway Government Offices." } }, "required": [ "applicant", "documents", "applicant_correspondence_address", "identification_check" ], "description": "A director, company secretary or other data subject applies to the Registrar to withhold their usual residential address and/or full HKID or passport number from registered documents. The public sees a correspondence address and partial ID." }, "Create_hk_protected_information_withhold": { "type": "object", "properties": { "type": { "const": "hk.protected_information.withhold" }, "params": { "$ref": "#/components/schemas/Params_hk_protected_information_withhold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withhold a residential address or ID number from public inspection", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "mpi", "title": "Form MPI", "source": "generated", "required": true }, { "key": "mpi_signed_original", "title": "Signed Form MPI", "source": "uploaded", "required": true }, { "key": "applicant_id_certified_copy", "title": "Certified copy of the applicant's HKID or passport", "source": "uploaded", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "mpi", "signer_role": "applicant", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "applicant_id_certified_copy", "signer_role": "lawyer", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong: Public Search Section", "form": "Form MPI, Application to Withhold Residential Address or Identification Number from Public", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_withholding_not_available_for_capacity", "type": null, "when": "[requirement_error] An address is to be withheld for a capacity other than current or former director, reserve director or company secretary (s.49); any person may withhold a full." }, { "code": "five_year_restriction_applies", "type": null, "when": "[requirement_error] The address was made public as a protected address and the five-year period in s.56 or has not ended." }, { "code": "document_not_on_register", "type": null, "when": "[invalid_request_error] A named document is not on the register at that reference." }, { "code": "applicant_not_data_subject", "type": null, "when": "[permission_error] The applicant is not the person whose data is in the documents; an agent or company cannot apply for them." } ] } }, "Params_hk_reserve_director_cease": { "type": "object", "properties": { "reserve_director": { "type": "string", "pattern": "^per_", "description": "Registered reserve director; defaults to the one on the register." }, "effective_date": { "type": "string", "format": "date", "description": "Date the nomination ended." }, "reason": { "type": "string", "enum": [ "revoked_by_general_meeting", "reserve_director_resigned", "no_longer_single_member_sole_director", "reserve_director_died", "became_director_on_death_of_sole_director" ], "description": "no_longer_single_member_sole_director covers the sole director resigning, a share transfer, or members or directors rising to two (ND5 note 1).." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "written_record", "general_meeting" ], "description": "For a revocation: written_resolution, written_record or general_meeting." }, "triggering_action_id": { "type": "string", "description": "The share or director action that ended the single-member structure." }, "resignation_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "For a resignation: the written notice to the company, if required (s.464)." }, "death_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for a death." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Set to a director to have them sign personally; omit and Entiva signs." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "effective_date", "reason" ], "description": "Records that a reserve director's nomination ended and files ND5 section 2 within 15 days." }, "Create_hk_reserve_director_cease": { "type": "object", "properties": { "type": { "const": "hk.reserve_director.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_reserve_director_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End a reserve director's nomination", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "revocation_resolution", "title": "Sole member's resolution revoking the nomination", "source": "generated", "required": false }, { "key": "reserve_director_resignation_notice", "title": "Reserve director's notice of resignation", "source": "uploaded", "required": false }, { "key": "death_evidence", "title": "Evidence of death", "source": "uploaded", "required": false }, { "key": "nd5", "title": "Form ND5", "source": "generated", "required": true } ], "people": [ { "role": "reserve_director", "verification_level": "identity" }, { "role": "reserve_director", "verification_level": "none" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "sole_director", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "revocation_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "reserve_director_resignation_notice", "signer_role": "reserve_director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nd5", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nd5", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND5, section 2", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_reserve_director_registered", "type": null, "when": "[invalid_request_error] The register shows no reserve director." }, { "code": "cessation_reason_not_supported_by_register", "type": null, "when": "[requirement_error] The registers show no change in members or directors to support no_longer_single_member_sole_director (ND5 note 1)." }, { "code": "cessation_date_in_future", "type": null, "when": "[invalid_request_error] ND5 reports a cessation that has happened." } ] } }, "Params_hk_reserve_director_change": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "nominate", "cease" ], "description": "Nominate a reserve director or end the nomination." }, "person": { "type": "string", "pattern": "^per_", "description": "per_ id of the reserve director: a natural person aged 18 or over, never a body corporate." }, "effective_date": { "type": "string", "format": "date", "description": "Date of nomination or cessation." }, "sole_member": { "type": "string", "pattern": "^per_", "description": "Nominations: the sole member who is also the sole director." }, "reason": { "type": "string", "enum": [ "resigned", "revoked_by_members", "no_longer_sole_member_and_director", "members_or_directors_changed", "appointed_director_after_death_of_sole_director", "deceased" ], "description": "Cessations: why the nomination ended (ND5 notes 1-)." }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "Executed members' resolution." }, "trigger_action_id": { "type": "string", "description": "Cessations: act_ id of the share, allotment or director action that ended the nomination." }, "usual_residential_address": { "$ref": "#/components/schemas/Address", "description": "Nominations: reported on the PI-ND5 sheet, withheld from public inspection." } }, "required": [ "operation", "person", "effective_date" ], "description": "Nominates a reserve director or reports the end of a nomination, on Form ND5 within 15 days." }, "Create_hk_reserve_director_change": { "type": "object", "properties": { "type": { "const": "hk.reserve_director.change" }, "params": { "$ref": "#/components/schemas/Params_hk_reserve_director_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Nominate a reserve director or end a reserve director's nomination", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' resolution nominating or revoking the nomination", "source": "generated", "required": true }, { "key": "form_nd5", "title": "Form ND5 with PI-ND5 sheet", "source": "generated", "required": true }, { "key": "identity_document", "title": "HKID card or passport of the nominee", "source": "uploaded", "required": false } ], "people": [ { "role": "reserve_director", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "form_nd5", "signer_role": "reserve_director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_nd5", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_nd5", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form ND5 with PI-ND5 sheet", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_not_single_member_single_director", "type": null, "when": "Nomination: the company does not have exactly one member who is also its only director." }, { "code": "reserve_director_not_individual", "type": null, "when": "The nominee is a body corporate or under 18." }, { "code": "company_type_not_eligible", "type": null, "when": "The company is public or limited by guarantee; only private companies may nominate." }, { "code": "no_reserve_director_on_register", "type": null, "when": "Cessation: no reserve director is registered." }, { "code": "registry_rejected", "type": null, "when": "The CR rejects the form; the action returns to requirements_pending with the CR's reasons." } ] } }, "Params_hk_reserve_director_nominate": { "type": "object", "properties": { "reserve_director": { "type": "string", "pattern": "^per_", "description": "Nominee: an individual aged 18 or over, never a body corporate (s.455)." }, "sole_member": { "type": "string", "pattern": "^per_", "description": "The individual who is both only member and sole director." }, "confirm_single_member_sole_director": { "type": "boolean", "description": "Must be true; the form carries this confirmation." }, "nomination_date": { "type": "string", "format": "date", "description": "Date of the sole member's decision; starts the 15-day clock." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "written_record", "general_meeting" ], "description": "written_resolution, written_record or general_meeting." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Nominee's correspondence address; may be abroad; no PO box." }, "usual_residential_address": { "$ref": "#/components/schemas/Address", "description": "Reported only on the protected PI-ND5 sheet; no care-of or PO box." }, "replace_existing": { "type": "boolean", "description": "True if a reserve director is already registered; the form then also reports their cessation as of nomination_date." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Set to a director to have them sign personally; omit and Entiva signs." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "reserve_director", "sole_member", "confirm_single_member_sole_director", "nomination_date", "correspondence_address", "usual_residential_address" ], "description": "Records the sole member's nomination of a reserve director to act if the sole director dies, adds the nominee to the register of directors and files ND5 within 15 days. Only for a private company whose one member is also its sole director." }, "Create_hk_reserve_director_nominate": { "type": "object", "properties": { "type": { "const": "hk.reserve_director.nominate" }, "params": { "$ref": "#/components/schemas/Params_hk_reserve_director_nominate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Nominate a reserve director", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sole_member_resolution", "title": "Sole member's resolution nominating the reserve director", "source": "generated", "required": true }, { "key": "nd5", "title": "Form ND5", "source": "generated", "required": true }, { "key": "pi_nd5", "title": "PI-ND5 protected-information sheet", "source": "generated", "required": true }, { "key": "cr_user_identity_copy", "title": "Certified ID copy for CR e-Services registration", "source": "uploaded", "required": false } ], "people": [ { "role": "reserve_director", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "sole_director", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "sole_member_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nd5", "signer_role": "reserve_director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nd5", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nd5", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND5, Notice of Change of Reserve Director", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_not_single_member_sole_director", "type": null, "when": "[requirement_error] The registers do not show one member who is also the sole director of a private company (s.455)." }, { "code": "company_not_private", "type": null, "when": "[requirement_error] Public, guarantee or public unlimited company; only a private company can nominate." }, { "code": "reserve_director_must_be_individual", "type": null, "when": "[invalid_request_error] The nominee is a body corporate or under 18." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a step only the person can do: a verification selfie or government login, an acceptance, or a registry signature." } ] } }, "Params_hk_reserve_director_resignation_notice_file": { "type": "object", "properties": { "reserve_director": { "type": "string", "pattern": "^per_", "description": "The resigning reserve director, for whom the account or mandate acts." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the resignation." }, "notice_to_company": { "type": "string", "enum": [ "required_and_given", "required_not_given_but_sent_or_left_at_registered_office", "not_required" ], "description": "The form's three ticks: notice to the company required and given; required, not given as required but sent or left at the registered office; or not required." }, "grounds_for_belief": { "type": "string", "description": "Why the person has reasonable grounds to believe the company will not deliver ND5 (s.464)." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "reserve_director", "effective_date", "notice_to_company", "grounds_for_belief" ], "description": "A reserve director who resigned and has reasonable grounds to believe the company will not file ND5 delivers ND8 to the Companies Registry in their own name. Entiva prepares the form and routes the signing request to the person." }, "Create_hk_reserve_director_resignation_notice_file": { "type": "object", "properties": { "type": { "const": "hk.reserve_director_resignation_notice.file" }, "params": { "$ref": "#/components/schemas/Params_hk_reserve_director_resignation_notice_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reserve director files their own resignation notice", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice_to_company", "title": "Notice of resignation sent to the company", "source": "uploaded", "required": false }, { "key": "nd8", "title": "Form ND8", "source": "generated", "required": true }, { "key": "cr_user_identity_copy", "title": "Certified ID copy for CR e-Services registration", "source": "uploaded", "required": false } ], "people": [ { "role": "reserve_director", "verification_level": "identity" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nd8", "signer_role": "reserve_director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resignation_notice_to_company", "signer_role": "reserve_director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND8, Notice of Resignation of Reserve Director, Spec. No. 1/2023", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_already_notified", "type": null, "when": "[requirement_error] The register already shows the reserve director ceased." }, { "code": "not_a_registered_reserve_director", "type": null, "when": "[invalid_request_error] The person is not the registered reserve director." }, { "code": "grounds_missing", "type": null, "when": "[invalid_request_error] grounds_for_belief is empty (s.464)." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a step only the person can do: a verification selfie or government login, an acceptance, or a registry signature." } ] } }, "Params_hk_resignation_notice_file": { "type": "object", "properties": { "roles": { "type": "array", "items": {}, "description": "Offices resigned from: director, alternate_director, company_secretary." }, "resigning": { "type": "string", "pattern": "^per_", "description": "The resigning individual." }, "resigning_entity_id": { "type": "string", "pattern": "^ent_", "description": "A resigning body-corporate officer; it signs through its authorised officer." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the resignation." }, "notice_to_company": { "type": "string", "enum": [ "required_and_given", "required_not_given_but_sent_or_left_at_registered_office", "not_required" ], "description": "The form's three ticks: notice to the company required and given; required, not given as required but sent or left at the registered office; or not required." }, "grounds_for_belief": { "type": "string", "description": "Why the officer has reasonable grounds to believe the company will not deliver ND2A (ss.464, 477)." }, "continues_in_other_office": { "type": "boolean", "description": "Required for director or alternate_director: will the person still hold a directorship or alternate directorship?" }, "alternate_fors": { "type": "array", "items": {}, "description": "Required for alternate_director: the principal directors." }, "delivery_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online via CR e-Services or paper." } }, "required": [ "roles", "effective_date", "notice_to_company", "grounds_for_belief" ], "description": "A resigning director, alternate director or company secretary who has reasonable grounds to believe the company will not file ND2A delivers ND4 to the Companies Registry in their own name. Entiva prepares the form and routes the signing." }, "Create_hk_resignation_notice_file": { "type": "object", "properties": { "type": { "const": "hk.resignation_notice.file" }, "params": { "$ref": "#/components/schemas/Params_hk_resignation_notice_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Director or company secretary files their own resignation notice", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter_to_company", "title": "Notice of resignation sent to the company", "source": "uploaded", "required": false }, { "key": "nd4", "title": "Form ND4", "source": "generated", "required": true }, { "key": "cr_user_identity_copy", "title": "Certified ID copy for CR e-Services registration", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nd4", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resignation_letter_to_company", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Form ND4, Notice of Resignation of Company Secretary and Director, Spec. No. 1/2023", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_reserve_director_form", "type": null, "when": "[invalid_request_error] The person is the registered reserve director; use ND8." }, { "code": "officer_not_on_register", "type": null, "when": "[invalid_request_error] The person or body does not hold that office on the register." }, { "code": "company_already_notified", "type": null, "when": "[requirement_error] The register already shows the cessation." }, { "code": "grounds_missing", "type": null, "when": "[invalid_request_error] grounds_for_belief is empty (ss.464, 477)." } ] } }, "Params_hk_trustee_appoint": { "type": "object", "properties": { "trustee": { "type": "string", "pattern": "^per_", "description": "The new trustee; name, aliases, nationality and residential address come from the verified person record." }, "occupation": { "type": "string", "description": "The new trustee's occupation (s.9)." }, "effective_date": { "type": "string", "format": "date", "description": "Date of appointment; starts the 28-day clock." }, "appointment_basis": { "type": "string", "enum": [ "constitution_or_rules", "conditions_in_certificate", "trustees_resolution", "court_order", "other" ], "description": "The legal means that filled the vacancy." }, "appointment_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Evidence of the appointment the Registrar may require (s.9): minutes, resolution or deed." }, "signing_trustee": { "type": "string", "pattern": "^per_", "description": "A current trustee who signs the notification." }, "delivery_method": { "type": "string", "enum": [ "post", "in_person" ], "description": "post or in_person at the CR, 14th floor, Queensway Government Offices." } }, "required": [ "trustee", "occupation", "effective_date", "appointment_basis", "appointment_evidence_document_id", "signing_trustee" ], "description": "Records the appointment of a new trustee of a registered trustees corporation and delivers the Notification of Changes of Trustees, with the trustee's original written consent, to the Registrar within 28 days. HK$11 per trustee." }, "Create_hk_trustee_appoint": { "type": "object", "properties": { "type": { "const": "hk.trustee.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_trustee_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar of a new trustee (Cap. 306 s.9)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "registered_trustees_corporation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustee_appointment_resolution", "title": "Record of the appointment under the constitution", "source": "generated", "required": true }, { "key": "appointment_evidence", "title": "Evidence of the appointment", "source": "uploaded", "required": true }, { "key": "trustee_consent", "title": "New trustee's consent to act", "source": "generated", "required": true }, { "key": "notification_of_changes_of_trustees", "title": "Notification of Changes of Trustees", "source": "generated", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notification_of_changes_of_trustees", "signer_role": "trustee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "trustee_appointment_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "trustee_consent", "signer_role": "trustee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Notification of Changes of Trustees", "channel": "paper", "government_fee": { "amount": 11, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "consent_original_missing", "type": null, "when": "[requirement_error] The new trustee has not signed the original consent (s.9)." }, { "code": "occupation_missing", "type": null, "when": "[invalid_request_error] occupation is empty (s.9)." }, { "code": "trustee_already_registered", "type": null, "when": "[invalid_request_error] The person is already a registered trustee." } ] } }, "Params_hk_trustee_remove": { "type": "object", "properties": { "departing_trustee": { "type": "string", "pattern": "^per_", "description": "The trustee who died, resigned or was removed." }, "reason": { "type": "string", "enum": [ "death", "resignation", "removal" ], "description": "death, resignation or removal." }, "event_date": { "type": "string", "format": "date", "description": "Date of the death, resignation or removal; starts the 28-day clock." }, "evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Evidence the Registrar may require (s.9): death certificate, resignation letter or removal resolution." }, "signing_trustee": { "type": "string", "pattern": "^per_", "description": "A current trustee who signs the notification." }, "delivery_method": { "type": "string", "enum": [ "post", "in_person" ], "description": "post or in_person at the CR, 14th floor, Queensway Government Offices." } }, "required": [ "departing_trustee", "reason", "event_date", "evidence_document_id", "signing_trustee" ], "description": "Records that a trustee of a registered trustees corporation has died, resigned or been removed and delivers the Notification of Changes of Trustees to the Registrar within 28 days. HK$11 per trustee." }, "Create_hk_trustee_remove": { "type": "object", "properties": { "type": { "const": "hk.trustee.remove" }, "params": { "$ref": "#/components/schemas/Params_hk_trustee_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar of a trustee's death, resignation or removal (Cap. 306 s.9)", "x-entiva": { "jurisdiction": "hk", "stage": "officers_and_people", "applies_to": [ "registered_trustees_corporation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustee_departure_record", "title": "Record of the trustee's departure", "source": "generated", "required": true }, { "key": "departure_evidence", "title": "Evidence of death, resignation or removal", "source": "uploaded", "required": true }, { "key": "notification_of_changes_of_trustees", "title": "Notification of Changes of Trustees", "source": "generated", "required": true } ], "people": [ { "role": "trustee", "verification_level": "none" }, { "role": "trustee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notification_of_changes_of_trustees", "signer_role": "trustee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "trustee_departure_record", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry, Hong Kong", "form": "Notification of Changes of Trustees", "channel": "paper", "government_fee": { "amount": 11, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trustee_not_on_register", "type": null, "when": "[invalid_request_error] The person is not a registered trustee." }, { "code": "evidence_missing", "type": null, "when": "[requirement_error] No evidence of the death, resignation or removal (s.9)." }, { "code": "trustee_vacancy_warning", "type": null, "when": "[requirement_error] Warning only: fewer trustees remain than the constitution requires." } ] } }, "Params_hk_charge_discharge": { "type": "object", "properties": { "charge": { "type": "string", "description": "Id or CR reference of the registered charge." }, "discharge_type": { "type": "string", "enum": [ "debt_paid_whole", "debt_paid_part", "property_released", "property_ceased_to_form_part" ], "description": "What happened." }, "discharge_date": { "type": "string", "format": "date", "description": "Date of payment, release or cessation." }, "evidence": { "type": "string", "pattern": "^doc_", "description": "Certified copy of the evidence, required even if the chargee signs." }, "current_chargee_change": { "type": "object", "description": "If the chargee changed: date entitled and evidence." } }, "required": [ "charge", "discharge_type", "discharge_date", "evidence" ], "description": "Notifies the Registrar that the debt secured by a registered charge is paid or satisfied, or that property is released or has left the company's property. Files NM2 with a certified copy of the evidence." }, "Create_hk_charge_discharge": { "type": "object", "properties": { "type": { "const": "hk.charge.discharge" }, "params": { "$ref": "#/components/schemas/Params_hk_charge_discharge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register satisfaction or release of a charge", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_evidence", "title": "Certified copy of evidence of discharge", "source": "uploaded", "required": true }, { "key": "nm2_notification", "title": "Form NM2", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "certified_evidence", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nm2_notification", "signer_role": "chargee", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NM2 Notification of Payment, Satisfaction of Debt, Release from Charge, etc", "channel": "online", "government_fee": { "amount": 190, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "charge_not_found", "type": null, "when": "No registered charge matches." }, { "code": "evidence_not_certified", "type": null, "when": "The evidence is not a certified copy." } ] } }, "Params_hk_charge_register": { "type": "object", "properties": { "instrument_description": { "type": "string", "description": "For example Mortgage, Debenture, Floating Charge, Trust Deed." }, "date_of_creation": { "type": "string", "format": "date", "description": "Starts the one-month period." }, "chargees": { "type": "array", "items": {}, "description": "Rows: name, type, address." }, "certified_copy": { "type": "string", "pattern": "^doc_", "description": "Certified true copy of the instrument, never the original." }, "series_basis": { "type": "string", "enum": [ "by_reference_to_other_instrument", "contained_in_debenture" ], "description": "Debenture series with equal holders: files NM8 instead of NM1." }, "acquisition": { "type": "object", "description": "For acquired property: acquisition_date and evidence document." }, "commission_allowance_or_discount": { "type": "object", "description": "Amount and percentage payable on the debenture (s.342)." } }, "required": [ "instrument_description", "date_of_creation", "chargees", "certified_copy" ], "description": "Registers a specified charge created by a Hong Kong company, existing on property it acquires, or on Hong Kong property of a registered non-Hong Kong company. Files NM1, or NM8 for a debenture series with equal holders, with a certified." }, "Create_hk_charge_register": { "type": "object", "properties": { "type": { "const": "hk.charge.register" }, "params": { "$ref": "#/components/schemas/Params_hk_charge_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charge", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_copy", "title": "Certified copy of the charge instrument", "source": "uploaded", "required": true }, { "key": "board_resolution_charge", "title": "Directors' resolution approving the charge", "source": "generated", "required": false }, { "key": "nm1_statement", "title": "Form NM1 or NM8", "source": "generated", "required": true }, { "key": "certificate_of_registration_of_charge", "title": "Certificate of Registration of Charge", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_charge", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_copy", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nm1_statement", "signer_role": "chargee", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NM1 Statement of Particulars of Charge", "channel": "online", "government_fee": { "amount": 340, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registration_period_expired", "type": null, "when": "One month has passed; a court order is needed." }, { "code": "original_instrument_uploaded", "type": null, "when": "Only a certified copy may be delivered." }, { "code": "use_nm10_form", "type": null, "when": "A re-domiciled company's pre-domiciliation charge needs NM10." } ] } }, "Params_hk_charge_enforcement_notify": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "possession_started", "possession_ended", "receiver_appointed" ], "description": "NM3, NM4 or NM5." }, "event_date": { "type": "string", "format": "date", "description": "Starts the 7-day period." }, "charge": { "type": "string", "description": "Id or CR reference of the charge." }, "mortgagee": { "type": "object", "description": "Mortgagee or appointor: name, type, address; for an individual the partial HKID or passport number." }, "receiver": { "type": "object", "description": "For receiver_appointed: name, address, email, partial ID number." }, "appointment_basis": { "type": "string", "enum": [ "court_order", "instrument" ], "description": "For receiver_appointed." } }, "required": [ "event", "event_date", "charge", "mortgagee" ], "description": "A mortgagee that enters into possession of a company's property, or appoints or obtains a receiver or manager, files NM3 or NM5 within 7 days; on going out of possession it files NM4 within 7 days. The filer is the mortgagee or appointor." }, "Create_hk_charge_enforcement_notify": { "type": "object", "properties": { "type": { "const": "hk.charge_enforcement.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_charge_enforcement_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify mortgagee possession or receiver appointment", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nm3_nm4_or_nm5_notice", "title": "Form NM3, NM4 or NM5, with PI sheet for an individual", "source": "generated", "required": true }, { "key": "mortgagee_authority", "title": "Mortgagee's authority for Entiva to act", "source": "uploaded", "required": true } ], "people": [ { "role": "chargee", "verification_level": "none" }, { "role": "receiver", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nm3_nm4_or_nm5_notice", "signer_role": "chargee", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NM3 Mortgagee Entering into Possession", "channel": "both", "government_fee": { "amount": 40, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notice_overdue", "type": null, "when": "More than 7 days since the event." }, { "code": "mortgagee_signatory_missing", "type": null, "when": "No signatory with a CR credential." }, { "code": "instrument_description_mismatch", "type": null, "when": "NM5 description differs from the registered NM1." } ] } }, "Params_hk_debenture_allot": { "type": "object", "properties": { "amount_allotted": { "$ref": "#/components/schemas/Money", "description": "Amount allotted." }, "allotment_date": { "type": "string", "format": "date", "description": "Date of allotment." }, "transferable_by_delivery": { "type": "boolean", "description": "If true, allottee names are not listed on NDB1." }, "allottees": { "type": "array", "items": {}, "description": "Rows: name, address, amount; required unless transferable by delivery." }, "redemption_date": { "type": "string", "format": "date", "description": "Date of redemption, if fixed." }, "series_charge": { "type": "string", "description": "Registered series charge; if set, NM9 is filed too." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "amount_allotted", "allotment_date", "transferable_by_delivery" ], "description": "Records an allotment of debentures or debenture stock and files Form NDB1 within one month. An issue under a registered series charge also files NM9." }, "Create_hk_debenture_allot": { "type": "object", "properties": { "type": { "const": "hk.debenture.allot" }, "params": { "$ref": "#/components/schemas/Params_hk_debenture_allot" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Allot debentures", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_debentures", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "ndb1_return", "title": "Form NDB1 with allottee schedule", "source": "generated", "required": true }, { "key": "nm9_statement", "title": "Form NM9", "source": "generated", "required": false }, { "key": "register_of_debenture_holders", "title": "Register of debenture holders", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_debentures", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ndb1_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NDB1 Return of Allotment of Debentures or Debenture Stock", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ndb1_overdue", "type": null, "when": "More than one month since the allotment." }, { "code": "allottees_missing", "type": null, "when": "Not transferable by delivery but no allottees given." }, { "code": "series_charge_not_registered", "type": null, "when": "series_charge has no registered NM8." } ] } }, "Params_hk_limited_partnership_admit_partner": { "type": "object", "properties": { "partner": { "type": "string", "pattern": "^ent_", "description": "Incoming partner." }, "partner_status": { "type": "string", "enum": [ "general", "limited" ], "description": "Status on admission." }, "effective_date": { "type": "string", "format": "date", "description": "Starts the 7-day period." }, "contribution": { "$ref": "#/components/schemas/Money", "description": "Sum contributed by a limited partner." }, "contribution_in_kind": { "type": "string", "description": "Particulars if not paid in cash." } }, "required": [ "partner", "partner_status", "effective_date" ], "description": "Admits a new general or limited partner to a Cap. 37 limited partnership: Form 2 within 7 days, Gazette advertisement, and notice to the Business Registration Office within a month." }, "Create_hk_limited_partnership_admit_partner": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.admit_partner" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_admit_partner" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Admit a partner to a limited partnership", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deed_of_admission", "title": "Deed of admission or amendment to the partnership agreement", "source": "generated", "required": true }, { "key": "form_2_notice", "title": "Form 2 Notice of change", "source": "generated", "required": true }, { "key": "gazette_advertisement", "title": "Gazette advertisement", "source": "generated", "required": true }, { "key": "irbr64_notice", "title": "IRBR 64 notice of partner change", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "deed_of_admission", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_2_notice", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "irbr64_notice", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form 2 Notice of change in the limited partnership", "channel": "paper", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_2_overdue", "type": null, "when": "More than 7 days since the change." }, { "code": "no_general_or_limited_partner_left", "type": null, "when": "The change leaves no general or no limited partner." }, { "code": "gazette_not_published", "type": null, "when": "The change has no effect until advertised." } ] } }, "Params_hk_limited_partnership_assign_limited_partner_share": { "type": "object", "properties": { "assignor": { "type": "string", "pattern": "^ent_", "description": "Limited partner assigning." }, "assignee": { "type": "string", "pattern": "^ent_", "description": "Person or entity taking the share." }, "share_assigned": { "type": "string", "description": "Whole share or the portion assigned." }, "effective_date": { "type": "string", "format": "date", "description": "Date of assignment." }, "contribution_assigned": { "$ref": "#/components/schemas/Money", "description": "Contribution transferred." }, "general_partners_consent": { "type": "string", "pattern": "^doc_", "description": "Consent where the agreement requires it." } }, "required": [ "assignor", "assignee", "share_assigned", "effective_date" ], "description": "Assigns a limited partner's share in a Cap. 37 limited partnership. Files Form 2, advertises in the Gazette and notifies the Business Registration Office." }, "Create_hk_limited_partnership_assign_limited_partner_share": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.assign_limited_partner_share" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_assign_limited_partner_share" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Assign a limited partner's share", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deed_of_assignment", "title": "Deed of assignment", "source": "generated", "required": true }, { "key": "form_2_notice", "title": "Form 2 Notice of change", "source": "generated", "required": true }, { "key": "gazette_advertisement", "title": "Gazette advertisement", "source": "generated", "required": true }, { "key": "irbr64_notice", "title": "IRBR 64 notice of partner change", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "deed_of_assignment", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_2_notice", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "irbr64_notice", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form 2 Notice of change in the limited partnership", "channel": "paper", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_2_overdue", "type": null, "when": "More than 7 days since the change." }, { "code": "no_general_or_limited_partner_left", "type": null, "when": "The change leaves no general or no limited partner." }, { "code": "gazette_not_published", "type": null, "when": "The change has no effect until advertised." } ] } }, "Params_hk_limited_partnership_convert_partner_status": { "type": "object", "properties": { "partner": { "type": "string", "pattern": "^ent_", "description": "Partner changing status." }, "from_status": { "type": "string", "enum": [ "general", "limited" ], "description": "Current status." }, "to_status": { "type": "string", "enum": [ "general", "limited" ], "description": "New status." }, "effective_date": { "type": "string", "format": "date", "description": "Date of conversion." }, "contribution": { "$ref": "#/components/schemas/Money", "description": "Contribution as a limited partner afterwards." } }, "required": [ "partner", "from_status", "to_status", "effective_date" ], "description": "Changes a partner's status in a Cap. 37 limited partnership from general to limited or the reverse (Form 2 item), with Gazette advertisement and notice to the Business Registration Office." }, "Create_hk_limited_partnership_convert_partner_status": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.convert_partner_status" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_convert_partner_status" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a partner between general and limited", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deed_of_conversion", "title": "Deed or amendment recording the change of status", "source": "generated", "required": true }, { "key": "form_2_notice", "title": "Form 2 Notice of change", "source": "generated", "required": true }, { "key": "gazette_advertisement", "title": "Gazette advertisement", "source": "generated", "required": true }, { "key": "irbr64_notice", "title": "IRBR 64 notice of partner change", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "deed_of_conversion", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_2_notice", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "irbr64_notice", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form 2 Notice of change in the limited partnership", "channel": "paper", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_2_overdue", "type": null, "when": "More than 7 days since the change." }, { "code": "no_general_or_limited_partner_left", "type": null, "when": "The change leaves no general or no limited partner." }, { "code": "gazette_not_published", "type": null, "when": "The change has no effect until advertised." } ] } }, "Params_hk_limited_partnership_resign_partner": { "type": "object", "properties": { "partner": { "type": "string", "pattern": "^ent_", "description": "Departing partner." }, "reason": { "type": "string", "enum": [ "retirement", "withdrawal", "death", "expulsion" ], "description": "Death must also be notified on Form 2." }, "effective_date": { "type": "string", "format": "date", "description": "Starts the 7-day period." }, "contribution_returned": { "$ref": "#/components/schemas/Money", "description": "Contribution returned or reduced (Form 2 item)." } }, "required": [ "partner", "reason", "effective_date" ], "description": "Records a partner leaving a Cap. 37 limited partnership by retirement, withdrawal, death or expulsion: Form 2, Gazette advertisement and notice to the Business Registration Office." }, "Create_hk_limited_partnership_resign_partner": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.resign_partner" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_resign_partner" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Retire or remove a partner from a limited partnership", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deed_of_retirement", "title": "Deed or agreement recording the departure", "source": "generated", "required": true }, { "key": "form_2_notice", "title": "Form 2 Notice of change", "source": "generated", "required": true }, { "key": "gazette_advertisement", "title": "Gazette advertisement", "source": "generated", "required": true }, { "key": "irbr64_notice", "title": "IRBR 64 notice of partner change", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "deed_of_retirement", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_2_notice", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "irbr64_notice", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form 2 Notice of change in the limited partnership", "channel": "paper", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_2_overdue", "type": null, "when": "More than 7 days since the change." }, { "code": "no_general_or_limited_partner_left", "type": null, "when": "The change leaves no general or no limited partner." }, { "code": "gazette_not_published", "type": null, "when": "The change has no effect until advertised." } ] } }, "Params_hk_members_increase_notify": { "type": "object", "properties": { "registered_number_before": { "type": "integer", "description": "Registered number of members before the increase." }, "total_members": { "type": "integer", "description": "Number of members after the increase." }, "increase_date": { "type": "string", "format": "date", "description": "Date the increase is resolved or takes place, whichever is earlier." }, "members": { "type": "array", "items": {}, "description": "New members for the register." } }, "required": [ "registered_number_before", "total_members", "increase_date" ], "description": "A guarantee company that increases its members beyond the registered number files Form NMEM1 within 15 days after the increase is resolved or takes place, whichever is earlier, and updates the register of members." }, "Create_hk_members_increase_notify": { "type": "object", "properties": { "type": { "const": "hk.members_increase.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_members_increase_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify increase in number of members", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "guarantee_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_admission_decision", "title": "Decision admitting the new members", "source": "generated", "required": true }, { "key": "membership_applications", "title": "Applications for membership", "source": "uploaded", "required": false }, { "key": "nmem1_notice", "title": "Form NMEM1", "source": "generated", "required": true }, { "key": "register_of_members", "title": "Register of members updated", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_admission_decision", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "membership_applications", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nmem1_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NMEM1 Notice of Increase in Number of Members of Company Limited", "channel": "online", "government_fee": { "amount": 18, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nmem1_overdue", "type": null, "when": "More than 15 days since the increase." }, { "code": "not_above_registered_number", "type": null, "when": "new_total_members does not exceed the registered number; no notice needed." }, { "code": "entity_not_guarantee_company", "type": null, "when": "The entity has share capital." } ] } }, "Params_hk_minority_shares_notify": { "type": "object", "properties": { "notice_kind": { "type": "string", "enum": [ "squeeze_out", "sell_out_right" ], "description": "squeeze_out: NRE1 or NRE3. sell_out_right: NRE2 or NRE4." }, "offer_type": { "type": "string", "enum": [ "takeover", "general_buy_back_offer" ], "description": "takeover: the offeror gives the notice. general_buy_back_offer: the repurchasing company gives it." }, "offeror": { "type": "string", "pattern": "^ent_", "description": "Takeover only: the offeror." }, "offer_date": { "type": "string", "format": "date", "description": "Day the offer was made." }, "acceptance_level": { "type": "object", "description": "Squeeze-out: shares_acquired_or_contracted, shares_offer_relates_to, percentage; at least 90% unless the Court authorised the notice." }, "offer_period_end": { "type": "string", "format": "date", "description": "Sell-out right: end of the offer period." }, "notice_given_during_offer": { "type": "boolean", "description": "Sell-out right: true if the offer is still open." }, "reply_address": { "$ref": "#/components/schemas/Address", "description": "Address for shareholders' letters." }, "minority_shareholders": { "type": "array", "items": {}, "description": "Rows: holder, class_of_shares, number_of_shares." }, "consideration_terms": { "type": "object", "description": "choices[], default_if_no_choice and any option, exactly as in the offer." }, "court_order_authorising_notice": { "type": "string", "pattern": "^doc_", "description": "Squeeze-out below 90%: the Court order authorising the notice." } }, "required": [ "notice_kind", "offer_type", "offer_date", "reply_address", "minority_shareholders" ], "description": "Compulsory acquisition after a takeover offer or general buy-back offer reaches 90% of the shares it covers. Serves each non-accepting shareholder either the squeeze-out notice or the sell-out notice." }, "Create_hk_minority_shares_notify": { "type": "object", "properties": { "type": { "const": "hk.minority_shares.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_minority_shares_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Serve minority shareholder notices", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "offer_document", "title": "Takeover or general offer document", "source": "uploaded", "required": true }, { "key": "ninety_percent_evidence", "title": "Evidence of the 90% level", "source": "uploaded", "required": true }, { "key": "minority_notices", "title": "Notice to each minority shareholder", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising the notices", "source": "generated", "required": true }, { "key": "proof_of_service", "title": "Proof of service on each shareholder", "source": "uploaded", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minority_notices", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None: CR lists NRE1 to NRE4 as 'NOT for delivery to the Registrar'", "form": "NRE1", "channel": "none", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ninety_percent_not_reached", "type": null, "when": "The 90% condition is not met; a Court order is needed." }, { "code": "notice_period_expired", "type": null, "when": "The statutory notice period has passed." }, { "code": "service_proof_missing", "type": null, "when": "A shareholder has no proof of service." } ] } }, "Params_hk_share_allot": { "type": "object", "properties": { "allotment_date_from": { "type": "string", "format": "date", "description": "First allotment date in the return." }, "allotment_date_to": { "type": "string", "format": "date", "description": "Last date, if several allotments fall in one month." }, "allotments": { "type": "array", "items": {}, "description": "Rows: class_of_shares, currency, number_of_shares, amount_paid_per_share, amount_unpaid_per_share, allottee, consideration_type." }, "non_cash_consideration": { "type": "object", "description": "For non-cash rows: basis, particulars, contract_document." }, "members_authority": { "type": "object", "description": "basis and resolution_document; Entiva drafts the resolution if absent." }, "rights_attached": { "type": "array", "items": {}, "description": "Rights per class; needed if more than one class." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "allotment_date_from", "allotments" ], "description": "Allots new shares, writes up the register of members and files Form NSC1 within one month. Founder shares taken on incorporation are not reported on NSC1." }, "Create_hk_share_allot": { "type": "object", "properties": { "type": { "const": "hk.share.allot" }, "params": { "$ref": "#/components/schemas/Params_hk_share_allot" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Allot shares", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_allotment", "title": "Directors' resolution approving the allotment", "source": "generated", "required": true }, { "key": "members_resolution_allotment", "title": "Members' resolution authorising the directors to allot", "source": "generated", "required": false }, { "key": "nsc1_return", "title": "Form NSC1 with statement of capital and allottee schedule", "source": "generated", "required": true }, { "key": "share_certificates", "title": "Share certificates, due within 2 months", "source": "generated", "required": false }, { "key": "register_of_members", "title": "Register of members written up", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "ai_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_allotment", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution_allotment", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nsc1_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "share_certificates", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC1 Return of Allotment", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "allotment_return_overdue", "type": null, "when": "Allotment is over a month old." }, { "code": "members_authority_missing", "type": null, "when": "No ordinary resolution or exemption recorded." }, { "code": "allottee_verification_required", "type": null, "when": "" } ] } }, "Params_hk_share_repurchase": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "off_market_buy_back", "on_market_buy_back", "general_offer_buy_back", "redemption" ], "description": "Type of purchase." }, "funding_source": { "type": "string", "enum": [ "distributable_profits", "fresh_issue_proceeds" ], "description": "Source of payment." }, "sellers": { "type": "array", "items": {}, "description": "Rows: seller, class_of_shares, number_of_shares, price_per_share." }, "delivery_date": { "type": "string", "format": "date", "description": "Shares delivered to the company; starts the 15-day clock." }, "aggregate_amount_paid": { "$ref": "#/components/schemas/Money", "description": "Total paid." }, "member_approval_basis": { "type": "string", "enum": [ "ordinary_resolution", "special_resolution", "articles_authority" ], "description": "Approval relied on." }, "shares_held_as_treasury": { "type": "integer", "description": "Listed companies: number held in treasury." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "mode", "funding_source", "sellers", "delivery_date", "aggregate_amount_paid", "member_approval_basis" ], "description": "Records a buy-back or redemption funded from distributable profits or a fresh issue and files Form NSC2 within 15 days after the shares are delivered to the company. Payment out of capital uses hk.shares.buy_back_out_of_capital." }, "Create_hk_share_repurchase": { "type": "object", "properties": { "type": { "const": "hk.share.repurchase" }, "params": { "$ref": "#/components/schemas/Params_hk_share_repurchase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Buy back or redeem shares", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_buy_back", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "members_resolution_buy_back", "title": "Members' resolution", "source": "generated", "required": true }, { "key": "buy_back_contract", "title": "Buy-back or redemption agreement", "source": "generated", "required": true }, { "key": "nsc2_return", "title": "Form NSC2", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_buy_back", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution_buy_back", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nsc2_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC2 Return of Share Redemption or Buy-back", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nsc2_overdue", "type": null, "when": "More than 15 days since delivery." }, { "code": "funding_not_distributable", "type": null, "when": "Distributable profits do not cover the price." }, { "code": "use_out_of_capital_action", "type": null, "when": "Payment is out of capital; a solvency statement is needed." } ] } }, "Params_hk_share_repurchase_out_of_capital": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "buy_back", "redemption" ], "description": "Buy-back or redemption." }, "sellers": { "type": "array", "items": {}, "description": "Rows: seller, class_of_shares, number_of_shares, price_per_share." }, "payment_out_of_capital": { "$ref": "#/components/schemas/Money", "description": "Amount paid out of capital." }, "winding_up_intended_within_12_months": { "type": "boolean", "description": "Selects the NSC17 opinion." }, "creditor_notice_method": { "type": "string", "enum": [ "newspaper", "written_notice_to_creditors" ], "description": "Notice besides the Gazette." }, "target_special_resolution_date": { "type": "string", "format": "date", "description": "Within 15 days after the solvency statement." }, "planned_payment_date": { "type": "string", "format": "date", "description": "5 to 7 weeks after the resolution unless the Court orders otherwise." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "mode", "sellers", "payment_out_of_capital", "winding_up_intended_within_12_months", "creditor_notice_method", "target_special_resolution_date" ], "description": "Buy-back or redemption paid out of capital: all directors sign a solvency statement, members resolve within 15 days, notices are published, the 5-week challenge period runs, payment falls 5 to 7 weeks after the resolution and NSC2 is filed." }, "Create_hk_share_repurchase_out_of_capital": { "type": "object", "properties": { "type": { "const": "hk.share.repurchase_out_of_capital" }, "params": { "$ref": "#/components/schemas/Params_hk_share_repurchase_out_of_capital" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Buy back or redeem shares out of capital", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nsc17_solvency_statement", "title": "Form NSC17", "source": "generated", "required": true }, { "key": "special_resolution_buy_back", "title": "Special resolution", "source": "generated", "required": true }, { "key": "gazette_and_creditor_notice", "title": "Gazette and creditor notices", "source": "generated", "required": true }, { "key": "buy_back_contract", "title": "Buy-back agreement", "source": "generated", "required": true }, { "key": "nsc2_return", "title": "Form NSC2 with particulars of payment out of capital", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nsc17_solvency_statement", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_buy_back", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nsc2_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC17, special resolution copy, then NSC2", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "solvency_statement_incomplete", "type": null, "when": "Not every director has signed NSC17." }, { "code": "payment_outside_window", "type": null, "when": "Payment is not 5 to 7 weeks after the resolution." }, { "code": "court_challenge_filed", "type": null, "when": "A creditor or member applied to cancel the resolution." } ] } }, "Params_hk_share_transfer": { "type": "object", "properties": { "transferor": { "type": "string", "pattern": "^per_", "description": "Member transferring." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Person or entity receiving the shares." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class transferred." }, "number_of_shares": { "type": "integer", "description": "Number of shares." }, "transfer_basis": { "type": "string", "enum": [ "sale", "gift", "other_consideration", "compulsory_acquisition" ], "description": "sale uses bought and sold notes; gift is a voluntary disposition; compulsory_acquisition follows a squeeze-out notice." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price in major units; required for a sale." }, "market_value": { "$ref": "#/components/schemas/Money", "description": "Required for gift and other_consideration." }, "transfer_date": { "type": "string", "format": "date", "description": "Date the instrument is executed." }, "executed_in_hong_kong": { "type": "boolean", "description": "False if a party signs abroad." }, "shares_listed": { "type": "boolean", "description": "Must be false; listed shares settle through HKEX and are out of scope." }, "valuation_accounts": { "type": "string", "pattern": "^doc_", "description": "Audited accounts within 6 months, or management accounts within 3 months, for unlisted shares." }, "attorney_signing": { "type": "object", "description": "attorney and power_of_attorney; the power must be signed and sealed on paper." } }, "required": [ "transferor", "transferee", "share_class", "number_of_shares", "transfer_basis", "transfer_date", "executed_in_hong_kong" ], "description": "Transfers unlisted shares between members. Prepares the instrument of transfer and bought and sold notes for wet-ink signing, stamps them through IRD e-Stamping, updates the register of members and the SCR." }, "Create_hk_share_transfer": { "type": "object", "properties": { "type": { "const": "hk.share.transfer" }, "params": { "$ref": "#/components/schemas/Params_hk_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer shares", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "instrument_of_transfer", "title": "Instrument of transfer", "source": "generated", "required": true }, { "key": "bought_note", "title": "Bought note", "source": "generated", "required": false }, { "key": "sold_note", "title": "Sold note", "source": "generated", "required": false }, { "key": "signed_originals_scan", "title": "Scan of signed originals; the company keeps them", "source": "uploaded", "required": true }, { "key": "e_stamping_application", "title": "IRD e-Stamping application", "source": "generated", "required": true }, { "key": "stamp_certificates", "title": "IRD stamp certificates", "source": "registry_issued", "required": true }, { "key": "register_of_members", "title": "Register of members updated", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "ai_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "instrument_of_transfer", "signer_role": "lawyer", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "instrument_of_transfer", "signer_role": "lawyer", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "bought_note", "signer_role": "shareholder", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "sold_note", "signer_role": "shareholder", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "e_stamping_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Stamp Office", "form": "Instrument of transfer and contract notes stamped via 'Stamping on Share Transfer Document", "channel": "online", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "listed_shares_not_supported", "type": null, "when": "shares_listed is true." }, { "code": "e_stamping_not_available", "type": null, "when": "Derivatives, debt or adjustable consideration, shares sold with loans, trust declarations, or several classes in an unlisted company: Stamp Office counter instead." }, { "code": "signed_originals_missing", "type": null, "when": "Wet-ink originals not scanned, so stamping cannot start." } ] } }, "Params_hk_share_capital_change": { "type": "object", "properties": { "alteration_type": { "type": "string", "enum": [ "increase_from_members_funds", "capitalise_profits_without_allotment", "convert_into_more_or_fewer_shares", "cancel_untaken_shares", "cancel_forfeited_shares", "redenominate_share_capital", "reconvert_stock_into_shares" ], "description": "s.170 way; redenominate_share_capital; reconvert_stock_into_shares." }, "effective_date": { "type": "string", "format": "date", "description": "Date the alteration takes effect." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the members' resolution." }, "classes_affected": { "type": "array", "items": {}, "description": "Rows: class_of_shares, shares_before, shares_after, amount_paid_up_after." }, "conversion_terms": { "type": "string", "description": "For example '1 share into 10'." }, "redenomination": { "type": "object", "description": "For NSC13: from_currency, to_currency, exchange_rate specified in the resolution." }, "stock_value": { "$ref": "#/components/schemas/Money", "description": "For NSC14: value of the stock reconverted." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "alteration_type", "effective_date", "resolution_date", "classes_affected" ], "description": "Alters share capital by resolution of the company and files the notice within one month: NSC11 for s.170 ways that allot no shares, NSC13 to redenominate, NSC14 to reconvert legacy stock. Alterations that allot shares use hk.shares.allot." }, "Create_hk_share_capital_change": { "type": "object", "properties": { "type": { "const": "hk.share_capital.change" }, "params": { "$ref": "#/components/schemas/Params_hk_share_capital_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter share capital by resolution", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution_alteration", "title": "Members' resolution", "source": "generated", "required": true }, { "key": "nsc_notice", "title": "Form NSC11, NSC13 or NSC14 with statement of capital", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution_alteration", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nsc_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC11 Notice of Alteration of Share Capital", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_shares_allot", "type": null, "when": "The alteration allots shares; NSC1 applies, not NSC11." }, { "code": "share_count_changed", "type": null, "when": "A redenomination may not change the class or number of shares." }, { "code": "alteration_notice_overdue", "type": null, "when": "More than one month since the alteration." } ] } }, "Params_hk_share_capital_reduce": { "type": "object", "properties": { "route": { "type": "string", "enum": [ "solvency_statement", "court_confirmed" ], "description": "solvency_statement or court_confirmed." }, "reduction_amount": { "$ref": "#/components/schemas/Money", "description": "Amount of the reduction." }, "classes_affected": { "type": "array", "items": {}, "description": "Rows: class_of_shares, shares_cancelled, amount_reduced." }, "winding_up_intended_within_12_months": { "type": "boolean", "description": "Solvency route: selects the opinion in NSC17." }, "creditor_notice_method": { "type": "string", "enum": [ "newspaper", "written_notice_to_creditors" ], "description": "Solvency route: notice besides the Gazette." }, "target_special_resolution_date": { "type": "string", "format": "date", "description": "Solvency route: within 15 days after the solvency statement." }, "court_order_date": { "type": "string", "format": "date", "description": "Court route: starts the 15-day clock." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "route", "reduction_amount", "classes_affected" ], "description": "Reduces share capital by special resolution. Solvency route: all directors sign NSC17, members resolve within 15 days, notices are published, a 5-week challenge period runs, then NSC19." }, "Create_hk_share_capital_reduce": { "type": "object", "properties": { "type": { "const": "hk.share_capital.reduce" }, "params": { "$ref": "#/components/schemas/Params_hk_share_capital_reduce" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reduce share capital", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nsc17_solvency_statement", "title": "Form NSC17", "source": "generated", "required": false }, { "key": "special_resolution_reduction", "title": "Special resolution", "source": "generated", "required": true }, { "key": "gazette_and_creditor_notice", "title": "Gazette and creditor notices", "source": "generated", "required": false }, { "key": "petition_and_affidavit", "title": "Petition and affidavit", "source": "generated", "required": false }, { "key": "nsc19_or_nsc20_return", "title": "Form NSC19, or NSC20 with office copy of order and approved minute", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nsc17_solvency_statement", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_reduction", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "petition_and_affidavit", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "nsc19_or_nsc20_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC17, copy of the special resolution, then NSC19", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "special_resolution_out_of_window", "type": null, "when": "Resolution is over 15 days after the solvency statement." }, { "code": "solvency_statement_incomplete", "type": null, "when": "Not every director has signed NSC17." }, { "code": "court_challenge_filed", "type": null, "when": "A creditor or member applied to cancel the resolution." } ] } }, "Params_hk_share_class_rights_change": { "type": "object", "properties": { "share_class": { "type": "string", "pattern": "^shc_", "description": "Class whose rights change." }, "consent_type": { "type": "string", "enum": [ "full_consent", "class_approval", "articles_procedure" ], "description": "full_consent: every holder (s.180); class_approval: short of that, 28-day court-objection window; articles_procedure." }, "consent_date": { "type": "string", "format": "date", "description": "Date of the consent or resolution." }, "varied_rights": { "type": "array", "items": {}, "description": "Rows: class_of_shares and rights after the variation." }, "court_objection_made": { "type": "boolean", "description": "True if a holder applied to court under s.182." }, "authorising_document": { "type": "string", "pattern": "^doc_", "description": "Resolution or document authorising the variation." } }, "required": [ "share_class", "consent_type", "consent_date", "varied_rights" ], "description": "Varies the rights of a share class with class consent and files Form NSC15 within one month after the variation takes effect, with the authorising resolution unless already delivered." }, "Create_hk_share_class_rights_change": { "type": "object", "properties": { "type": { "const": "hk.share_class_rights.change" }, "params": { "$ref": "#/components/schemas/Params_hk_share_class_rights_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Vary rights attached to a class of shares", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "class_consent", "title": "Class consent or resolution", "source": "uploaded", "required": true }, { "key": "nsc15_notice", "title": "Form NSC15 with the authorising document", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "class_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "nsc15_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC15 Notice of Variation of Rights Attached to Shares", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "court_objection_pending", "type": null, "when": "A s.182 application is pending; the variation has not taken effect." }, { "code": "class_consent_missing", "type": null, "when": "No class consent is recorded." }, { "code": "variation_notice_overdue", "type": null, "when": "More than one month since the effective date." } ] } }, "Params_hk_treasury_share_cancel": { "type": "object", "properties": { "cancellation_basis": { "type": "string", "enum": [ "cancelled_by_company", "regarded_cancelled_on_delisting" ], "description": "Cancelled by the company (s.272D) or regarded as cancelled on delisting (s.272B)." }, "cancellations": { "type": "array", "items": {}, "description": "Rows: date, class_of_shares, number_of_shares." }, "listed_company_confirmation": { "type": "boolean", "description": "Company is, or was, listed." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "cancellation_basis", "cancellations", "listed_company_confirmation" ], "description": "A listed company cancels treasury shares, or records shares regarded as cancelled on delisting, and files Form NSC23 within 15 days. The number of issued shares falls; capital amounts do not change." }, "Create_hk_treasury_share_cancel": { "type": "object", "properties": { "type": { "const": "hk.treasury_share.cancel" }, "params": { "$ref": "#/components/schemas/Params_hk_treasury_share_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel treasury shares", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_treasury_cancel", "title": "Directors' resolution", "source": "generated", "required": false }, { "key": "nsc23_return", "title": "Form NSC23 with statement of capital", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_treasury_cancel", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nsc23_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC23 Return of Cancellation of Treasury Shares", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_not_listed", "type": null, "when": "The regime applies only to listed companies." }, { "code": "treasury_balance_exceeded", "type": null, "when": "More shares than are held in treasury." }, { "code": "nsc23_overdue", "type": null, "when": "More than 15 days since the cancellation." } ] } }, "Params_hk_treasury_share_transfer": { "type": "object", "properties": { "transfers": { "type": "array", "items": {}, "description": "Rows: date, class_of_shares, number_of_treasury_shares, consideration_type, amount_paid_per_share, buyer." }, "listed_company_confirmation": { "type": "boolean", "description": "Company is, or was, listed." }, "non_cash_particulars": { "type": "string", "description": "Contract particulars (s.272F)." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "transfers", "listed_company_confirmation" ], "description": "A listed company sells or transfers shares held in treasury and files Form NSC22 within 15 days. Sales and transfers need the same approvals as allotting new shares." }, "Create_hk_treasury_share_transfer": { "type": "object", "properties": { "type": { "const": "hk.treasury_share.transfer" }, "params": { "$ref": "#/components/schemas/Params_hk_treasury_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Sell or transfer treasury shares", "x-entiva": { "jurisdiction": "hk", "stage": "ownership_and_capital", "applies_to": [ "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_treasury_sale", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "members_authority", "title": "Members' authority as for an allotment", "source": "generated", "required": false }, { "key": "nsc22_return", "title": "Form NSC22", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_treasury_sale", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_authority", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nsc22_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NSC22 Return of Sale or Transfer of Treasury Shares", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_not_listed", "type": null, "when": "The regime applies only to listed companies." }, { "code": "treasury_balance_exceeded", "type": null, "when": "More shares than are held in treasury." }, { "code": "nsc22_overdue", "type": null, "when": "More than 15 days since the sale." } ] } }, "Params_hk_accounting_reference_date_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ] }, "accounting_reference_date": { "type": "string", "format": "date", "description": "The new accounting reference date.", "examples": [ "2027-03-31" ] }, "period_affected": { "type": "string", "enum": [ "current", "previous" ], "description": "current: the current accounting reference period. previous: the one immediately before it." }, "period_end_date_before_change": { "type": "string", "format": "date", "description": "End date of the current or previous accounting reference period before the change.", "examples": [ "2026-12-31" ] }, "effect_on_period": { "type": "string", "enum": [ "shorten", "extend" ], "description": "shorten or extend." }, "resulting_period_end_date": { "type": "string", "format": "date", "description": "End date of the affected period after the change." }, "directors_resolution_date": { "type": "string", "format": "date", "description": "Date of the directors' resolution specifying the new date, if taken outside Entiva." }, "extension_basis": { "type": "string", "enum": [ "no_earlier_extension_in_5_years", "coincides_with_holding_company", "approved_by_members_resolution" ], "description": "Required when extending: why a further extension within 5 years is allowed. no_earlier_extension_in_5_years: no new date was specified to extend an earlier." }, "members_resolution": { "type": "string", "pattern": "^doc_", "description": "Members' resolution, required when extension_basis is approved_by_members_resolution." } }, "required": [ "accounting_reference_date", "period_affected", "period_end_date_before_change" ], "description": "Directors specify a new accounting reference date for the current or previous accounting reference period (Cap. 622 s.371). A public company or company limited by guarantee delivers Form NAC4 within 15 days after the directors' resolution." }, "Create_hk_accounting_reference_date_change": { "type": "object", "properties": { "type": { "const": "hk.accounting_reference_date.change" }, "params": { "$ref": "#/components/schemas/Params_hk_accounting_reference_date_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change accounting reference date", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution specifying the new accounting reference date", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution approving a further extension", "source": "generated", "required": false }, { "key": "nac4", "title": "Form NAC4 Notice of Alteration of Accounting Reference Date", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NAC4", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nac4", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nac4", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAC4 Notice of Alteration of Accounting Reference Date", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "previous_period_reporting_deadline_expired", "type": null, "when": "period_affected is previous and the time to lay or send (s.430) the reporting documents for it has expired." }, { "code": "extension_exceeds_18_months", "type": null, "when": "The extension would make the accounting reference period longer than 18 months." }, { "code": "extension_basis_required", "type": null, "when": "The period is being extended and extension_basis was not supplied, or none of the three bases applies." }, { "code": "date_unchanged", "type": null, "when": "The new date equals the existing accounting reference date." }, { "code": "person_verification_required", "type": null, "when": "A director or signer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after the directors' resolution." } ] } }, "Params_hk_articles_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ] }, "alteration_means": { "type": "string", "enum": [ "special_resolution", "ordinary_resolution", "court_order" ], "description": "How the articles are altered. special_resolution is the default route. ordinary_resolution only where the Ordinance permits it. court_order for an alteration." }, "change_summary": { "type": "string", "description": "Plain-language summary of the changes." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "Full text of the articles as altered." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the resolution was passed, if passed outside Entiva." }, "effective_date": { "type": "string", "format": "date", "description": "Date the alteration takes effect.", "examples": [ "2026-11-01" ] }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "How members pass the resolution when Entiva collects it." }, "court_order": { "type": "object", "description": "For alteration_means court_order: order_date, order_reference, office_copy of the order." } }, "required": [ "alteration_means", "change_summary", "effective_date" ], "description": "Amends a Hong Kong company's articles by resolution or Court order and files Form NAA1 with the certified amended articles within 15 days after the alteration takes effect. No CR fee." }, "Create_hk_articles_amend": { "type": "object", "properties": { "type": { "const": "hk.articles.amend" }, "params": { "$ref": "#/components/schemas/Params_hk_articles_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend articles of association", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the proposed amendments", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution altering the articles", "source": "generated", "required": false }, { "key": "amended_articles", "title": "Articles of association as altered", "source": "uploaded", "required": true }, { "key": "certified_amended_articles", "title": "Copy of the articles as altered, certified by an officer of the company as correct", "source": "generated", "required": true }, { "key": "court_order_office_copy", "title": "Office copy of the Court order and the articles as altered by it", "source": "uploaded", "required": false }, { "key": "naa1", "title": "Form NAA1 Notice of Alteration of Company's Articles", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NAA1", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_amended_articles", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa1", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa1", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAA1 Notice of Alteration of Company's Articles", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "alteration_touches_objects", "type": null, "when": "The amendment changes objects stated in the articles; use hk.objects.amend, which has a different deadline and a possible Court challenge." }, { "code": "alteration_touches_memorandum_provisions", "type": null, "when": "The company was formed under a former Companies Ordinance and the amendment affects a provision that sat in its memorandum; use hk.memorandum_provisions.amend." }, { "code": "resolution_not_passed", "type": null, "when": "The resolution lapsed or fell short of the required majority." }, { "code": "amended_articles_missing", "type": null, "when": "No amended articles were uploaded and the generated consolidated copy has not been approved." }, { "code": "person_verification_required", "type": null, "when": "A director or signer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after effective_date." } ] } }, "Params_hk_business_registration_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership", "lp", "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lpf", "open_ended_fund_company" ] }, "business_name": { "type": "object", "description": "New business name: english and chinese." }, "business_address": { "$ref": "#/components/schemas/Address", "description": "New business address in Hong Kong." }, "nature_of_business": { "type": "string", "description": "New nature of business." }, "commencement_particulars": { "type": "object", "description": "Commencement date and business particulars for a company or OFC or an LP fund: commencement_date and any corrections to the particulars first notified." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change.", "examples": [ "2026-11-02" ] }, "filing_route": { "type": "string", "enum": [ "etax", "in_person", "post" ], "description": "How Entiva delivers it." }, "address_proof": { "type": "string", "pattern": "^doc_", "description": "Tenancy agreement or recent utility bill, which the IRD may ask for on an address change." } }, "required": [ "effective_date" ], "description": "Notifies the Business Registration Office of a change in a business's name, business address, nature of business or commencement particulars within one month, using IRC3110A, IRC3111A, IRBR193, IRBR200 or IRBR200A, or a letter. Changes a." }, "Create_hk_business_registration_change": { "type": "object", "properties": { "type": { "const": "hk.business_registration.change" }, "params": { "$ref": "#/components/schemas/Params_hk_business_registration_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the IRD of changes to business registration particulars", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "sole_proprietorship", "general_partnership", "lp", "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "lpf", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "btp_authorisation", "title": "Evidence that the Responsible Person appointed Entiva on the Business Tax Portal", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of the new business address", "source": "uploaded", "required": false }, { "key": "ird_notification", "title": "IRD notification", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "IRD acknowledgement and updated Business Registration Certificate where issued", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "btp_authorisation", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ird_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ird_notification", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "IRC3110A", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "change_passed_automatically_by_registry", "type": null, "when": "The only change requested is passed to the IRD by the CR once the CR filing is registered; nothing is filed." }, { "code": "btp_authorisation_missing", "type": null, "when": "The Responsible Person has not appointed Entiva on the Business Tax Portal; Entiva offers the paper route instead." }, { "code": "business_address_not_in_hong_kong", "type": null, "when": "The business address is outside Hong Kong." }, { "code": "no_change_supplied", "type": null, "when": "None of business_name, business_address, nature_of_business or commencement_particulars was sent." }, { "code": "person_verification_required", "type": null, "when": "The Responsible Person or an owner has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on an owner or controller pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the change." } ] } }, "Params_hk_business_registration_partners_change": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "One object per change: type, partner and effective_date." }, "existing_partners_confirmed": { "type": "boolean", "description": "Entiva lists the current partners from the record; true confirms the list is complete.", "examples": [ "true" ] }, "partner_identity_documents": { "type": "array", "items": {}, "description": "document_ref values: copies of identity documents of new individual partners, or business registration certificates of corporate partners, which the IRD may." }, "delivery_route": { "type": "string", "enum": [ "in_person", "post" ], "description": "in_person or post." } }, "required": [ "changes" ], "description": "Notifies the Business Registration Office of a partner joining or leaving a general partnership or Cap. 37 limited partnership within one month on Form IRBR 64, signed by the incoming or retiring partners and all existing partners. Not for." }, "Create_hk_business_registration_partners_change": { "type": "object", "properties": { "type": { "const": "hk.business_registration_partners.change" }, "params": { "$ref": "#/components/schemas/Params_hk_business_registration_partners_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the IRD of the admission or retirement of partners", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "general_partnership", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "irbr64", "title": "Form IRBR 64 Notification of admission or retirement of partners", "source": "generated", "required": true }, { "key": "partner_identity_documents", "title": "Identity documents of new individual partners or BR certificates of corporate partners", "source": "uploaded", "required": false }, { "key": "partnership_agreement_amendment", "title": "Amended partnership agreement", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "IRD acknowledgement of the notification", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity" }, { "role": "partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "irbr64", "signer_role": "partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office, 2/F Inland Revenue Centre, Kai Ta", "form": "Form IRBR 64 Notification of admission or retirement of partners", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is a limited partnership fund; its general partner changes pass from the CR, and IRBR 64A applied only to changes registered before 27 December 2023." }, { "code": "partner_signature_missing", "type": null, "when": "A partner has not signed IRBR 64; the IRD requires all existing partners plus the incoming or retiring partners." }, { "code": "person_verification_required", "type": null, "when": "An incoming partner has not completed identity verification." }, { "code": "wet_ink_signature_pending", "type": null, "when": "The signed paper form has not been received by the Entiva." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on an incoming or existing partner pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the change." } ] } }, "Params_hk_company_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ] }, "name_en": { "type": "string", "description": "New English name.", "examples": [ "Harbour Lane Capital Limited" ] }, "name_zh": { "type": "string", "description": "New Chinese name in traditional characters.", "examples": [ "港灣資本有限公司" ] }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed, if already passed outside Entiva." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "How members pass the special resolution when Entiva collects it." }, "name_swap_with": { "type": "string", "pattern": "^ent_", "description": "Another Entiva entity in the same group whose name is being swapped." }, "s103_licence": { "type": "string", "pattern": "^doc_", "description": "The Registrar's s.103 licence, if the new name omits 'Limited' / 有限公司." }, "restricted_name_approval": { "type": "string", "pattern": "^doc_", "description": "The Registrar's approval where the name uses words listed in Cap. 622A or suggests a link with the Central People's Government or the HKSAR Government." } }, "description": "Changes the English and/or Chinese name of a Hong Kong company by special resolution and files Form NNC2 within 15 days. The name changes on the date the Certificate of Change of Name is issued, and the CR passes the new name to the BRO." }, "Create_hk_company_name_change": { "type": "object", "properties": { "type": { "const": "hk.company_name.change" }, "params": { "$ref": "#/components/schemas/Params_hk_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change company name", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the proposed name and proposing the special resolution", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution of members changing the name", "source": "generated", "required": true }, { "key": "name_search_report", "title": "CR exact-name and left-partial name search report", "source": "generated", "required": true }, { "key": "name_swap_consent_letters", "title": "Mutual consent letters releasing the names", "source": "uploaded", "required": false }, { "key": "nnc2", "title": "Form NNC2 Notice of Change of Company Name", "source": "generated", "required": true }, { "key": "certificate_of_change_of_name", "title": "Certificate of Change of Name", "source": "registry_issued", "required": true }, { "key": "amended_br_certificate", "title": "Amended Business Registration Certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nnc2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nnc2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NNC2 Notice of Change of Company Name", "channel": "both", "government_fee": { "amount": 295, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_not_available", "type": null, "when": "The name is the same as one in the CR Index of Company Names, ignoring 'Limited', 'Company', case, spacing, accents and punctuation, or is the same as a body corporate's name." }, { "code": "name_requires_registrar_approval", "type": null, "when": "The name uses words listed in Cap. 622A or suggests a connection with the Central or HKSAR Government and no approval is attached." }, { "code": "name_invalid_form", "type": null, "when": "The English name does not end with 'Limited', mixes English and Chinese characters, or the Chinese name is not in traditional characters." }, { "code": "name_offensive_or_unlawful", "type": null, "when": "The Registrar may refuse a name that is criminal in its opinion or offensive or contrary to the public interest." }, { "code": "resolution_not_passed", "type": null, "when": "The members' written resolution lapsed or fell short of 75%; no NNC2 can be filed." }, { "code": "person_verification_required", "type": null, "when": "A director or signer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a director, member or beneficial owner pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after the special resolution." } ] } }, "Params_hk_company_name_licence_apply": { "type": "object", "properties": { "proposed_english_name": { "type": "string", "description": "Proposed English name without 'Limited'.", "examples": [ "Harbour Lane Arts Foundation" ] }, "proposed_chinese_name": { "type": "string", "description": "Proposed Chinese name without 有限公司, in traditional characters.", "examples": [ "港灣藝術基金會" ] }, "objects_statement": { "type": "string", "description": "Statement of the company's objects." }, "profits_applied_to_objects": { "type": "boolean", "description": "The articles require profits and other income to be applied to promoting the objects.", "examples": [ "true" ] }, "dividends_prohibited": { "type": "boolean", "description": "The articles prohibit the payment of dividends to members.", "examples": [ "true" ] }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "Articles containing the objects, profit-application and no-dividend provisions." }, "file_name_change_after_licence": { "type": "boolean", "description": "Default true: once the licence is issued, Entiva runs the special resolution and files NNC2 in the same action. false stops after the licence.", "examples": [ "true" ] }, "board_decision_date": { "type": "string", "format": "date", "description": "Date of the board decision to apply, if taken outside Entiva." } }, "required": [ "objects_statement", "profits_applied_to_objects", "dividends_prohibited" ], "description": "For an existing non-profit company: applies to the Registrar for a licence under s.103 allowing the name to omit 'Limited' / 有限公司, then changes the name by special resolution and Form NNC2. CR fees HK$9,080 for the licence and HK$295 for." }, "Create_hk_company_name_licence_apply": { "type": "object", "properties": { "type": { "const": "hk.company_name_licence.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_company_name_licence_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a licence to omit 'Limited' from the name", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "guarantee_company", "private_ltd_shares", "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the licence application", "source": "generated", "required": true }, { "key": "licence_application", "title": "Application to the Registrar for a licence under s.103, with the objects and the articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles with the s.103 provisions", "source": "uploaded", "required": false }, { "key": "s103_licence", "title": "Registrar's licence under s.103", "source": "registry_issued", "required": true }, { "key": "special_resolution", "title": "Special resolution changing the name", "source": "generated", "required": false }, { "key": "nnc2", "title": "Form NNC2 Notice of Change of Company Name", "source": "generated", "required": false }, { "key": "certificate_of_change_of_name", "title": "Certificate of Change of Name", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "licence_application", "signer_role": "filing_agent", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nnc2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nnc2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Application for a licence under Cap. 622 s.103", "channel": "paper", "government_fee": { "amount": 9080, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "objects_not_eligible", "type": null, "when": "The objects are not restricted to promoting commerce, art, science, religion, charity or another useful object." }, { "code": "articles_lack_required_provisions", "type": null, "when": "The articles do not require profits to be applied to the objects or do not prohibit dividends." }, { "code": "licence_refused", "type": null, "when": "The Registrar refused the licence; the action is rejected and no NNC2 is filed." }, { "code": "name_not_available", "type": null, "when": "The proposed name is the same as an existing name in the CR index." }, { "code": "person_verification_required", "type": null, "when": "A director or signer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." } ] } }, "Params_hk_limited_partnership_amend": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "One object per change, each with kind, effective_date and the details. kind is one of: firm_name, nature_of_business, principal_place_of_business." }, "certificate_number": { "type": "string", "description": "Number on the limited partnership's certificate of registration." }, "partners_consent_date": { "type": "string", "format": "date", "description": "Date the partners consented to the changes, if outside Entiva." } }, "required": [ "changes" ], "description": "Notifies the Registrar of changes in the registered particulars of a limited partnership: firm name, nature of business, principal place of business, partners, term or character, a partner's contribution, or a partner changing between." }, "Create_hk_limited_partnership_amend": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.amend" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify changes in a Cap. 37 limited partnership", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_consent", "title": "Written consent of the partners to the changes, under the partnership agreement", "source": "generated", "required": true }, { "key": "amended_partnership_agreement", "title": "Amended partnership agreement", "source": "uploaded", "required": false }, { "key": "form_2", "title": "Form 2 Notice of change in the limited partnership", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered Form 2", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "form_2", "signer_role": "general_partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form 2 Notice of change in the limited partnership", "channel": "both", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_registrable_change", "type": null, "when": "Every item in changes matches the register." }, { "code": "limited_partner_participates_in_management", "type": null, "when": "A requested change would give a limited partner a management role in a way the partnership agreement or Cap. 37 does not allow; Entiva stops for review." }, { "code": "non_cash_contribution_unspecified", "type": null, "when": "A contribution is not in cash and no particulars were given (Form 2 division)." }, { "code": "person_verification_required", "type": null, "when": "An incoming partner, general partner or over-25% limited partner has not completed verification." }, { "code": "wet_ink_signature_pending", "type": null, "when": "The signed paper Form 2 has not been received by the Entiva." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a partner pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 7 days after the change." } ] } }, "Params_hk_lpf_address_change": { "type": "object", "properties": { "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office of the fund." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "New principal place of business of the fund." }, "records_location": { "type": "object", "description": "New place where the Cap. 637 s.29 records are kept: address and remarks." }, "investment_scope": { "type": "string", "description": "New investment scope statement." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change occurs." }, "general_partner_decision_date": { "type": "string", "format": "date", "description": "Date of the general partner's decision, if already taken outside Entiva." }, "notify_ird_business_address": { "type": "boolean", "description": "Default true when the principal place of business changes: Entiva raises a linked hk.business_registration.update, because the LPF's duty to tell the IRD." } }, "required": [ "effective_date" ], "description": "Notifies the Companies Registry of a change in a limited partnership fund's registered office, principal place of business, the place where its statutory records are kept, or its investment scope. The general Entiva files within 15." }, "Create_hk_lpf_address_change": { "type": "object", "properties": { "type": { "const": "hk.lpf_address.change" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change LPF address, records location or investment scope", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_decision", "title": "General partner's decision", "source": "generated", "required": true }, { "key": "lpa_amendment", "title": "Amendment to the limited partnership agreement for an investment-scope change", "source": "uploaded", "required": false }, { "key": "lpf4a", "title": "Form LPF4A Notification of Change in Address, Location of Records and Investment Scope", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered LPF4A", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_decision", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf4a", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf4a", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF4A Notification of Change in Address, Location of Records and Investment Scope of ", "channel": "both", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_supplied", "type": null, "when": "None of registered_office, principal_place_of_business, records_location or investment_scope differs from the register." }, { "code": "records_location_not_in_hong_kong", "type": null, "when": "The records location is outside Hong Kong; Cap. 637 s.29 records must be kept at the registered office or another Hong Kong place made known to the Registrar." }, { "code": "person_verification_required", "type": null, "when": "The general partner or its signing director has not completed identity verification." }, { "code": "signer_credentials_missing", "type": null, "when": "The signing general partner or director has no CR e-Services credentials and Entiva is not the company secretary." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on the general partner or a controller pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after the change." } ] } }, "Params_hk_lpf_name_change": { "type": "object", "properties": { "name_en": { "type": "string", "description": "New English fund name." }, "name_zh": { "type": "string", "description": "New Chinese fund name in traditional characters." }, "partners_resolution_date": { "type": "string", "format": "date", "description": "Date the partners passed the resolution, if passed outside Entiva." } }, "description": "Changes the English and/or Chinese name of a Hong Kong LPF after the partners pass a resolution. The general Entiva files Form LPF3 within 15 days; the change takes effect when the CR issues the Certificate of Change of Name." }, "Create_hk_lpf_name_change": { "type": "object", "properties": { "type": { "const": "hk.lpf_name.change" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change name of a limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_resolution", "title": "Resolution of the partners changing the fund name", "source": "generated", "required": true }, { "key": "lpf3", "title": "Form LPF3 Notification of Change of Name of Limited Partnership Fund", "source": "generated", "required": true }, { "key": "certificate_of_change_of_name", "title": "Certificate of Change of Name of the fund", "source": "registry_issued", "required": true }, { "key": "amended_br_certificate", "title": "Amended Business Registration Certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lpf3", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpf3", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF3 Notification of Change of Name of Limited Partnership Fund", "channel": "both", "government_fee": { "amount": 1405, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_barred", "type": null, "when": "The new name is barred under Cap. 637 s.9; the CR refuses the certificate and refunds the HK$1,245." }, { "code": "no_name_change_supplied", "type": null, "when": "Neither name differs from the current registered names." }, { "code": "resolution_threshold_not_met", "type": null, "when": "Votes collected fall short of the threshold in the limited partnership agreement." }, { "code": "person_verification_required", "type": null, "when": "The general partner or its signing director has not completed identity verification." }, { "code": "signer_credentials_missing", "type": null, "when": "The signing general partner or director has no CR e-Services credentials and Entiva is not the company secretary." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on the general partner or a controller pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after the resolution." } ] } }, "Params_hk_memorandum_provisions_amend": { "type": "object", "properties": { "formed_under_former_ordinance": { "type": "boolean", "description": "Must be true." }, "provisions_altered": { "type": "array", "items": {}, "description": "The provisions being altered, as text: current wording and new wording." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "The articles as altered; Entiva certifies them as correct by an officer." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed, if outside Entiva." }, "court_application_made": { "type": "boolean", "description": "Private companies only: an application was made to the Court within 28 days to cancel the alteration." }, "court_order_date": { "type": "string", "format": "date", "description": "Date of the Court order confirming the alteration, when court_application_made is true." }, "court_order_office_copy": { "type": "string", "pattern": "^doc_", "description": "Office copy of the confirming order." } }, "required": [ "formed_under_former_ordinance", "provisions_altered", "amended_articles" ], "description": "For a company formed under a former Companies Ordinance: alters by special resolution a provision of its articles that was originally in its memorandum and could lawfully have been in the articles. Files Form NAA3 with the certified." }, "Create_hk_memorandum_provisions_amend": { "type": "object", "properties": { "type": { "const": "hk.memorandum_provisions.amend" }, "params": { "$ref": "#/components/schemas/Params_hk_memorandum_provisions_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter certain articles by an existing company", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the alteration and proposing the special resolution", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Special resolution of members altering the provisions", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles of association as altered", "source": "uploaded", "required": true }, { "key": "certified_amended_articles", "title": "Copy of the articles as altered, certified by an officer as correct", "source": "generated", "required": true }, { "key": "court_order_office_copy", "title": "Office copy of the Court order confirming the alteration", "source": "uploaded", "required": false }, { "key": "naa3", "title": "Form NAA3 Notice of Alteration of Certain Articles by Existing Company", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NAA3", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_amended_articles", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa3", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa3", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAA3 Notice of Alteration of Certain Articles", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_an_existing_company", "type": null, "when": "The company was not formed under a former Companies Ordinance; use hk.articles.amend." }, { "code": "provision_not_alterable", "type": null, "when": "The provision was not in the memorandum or could not lawfully have been in the articles, or s.90 bars the alteration." }, { "code": "court_challenge_window_open", "type": null, "when": "A private company tried to file before the 28-day application period ended; Entiva holds the filing until day 29." }, { "code": "resolution_not_passed", "type": null, "when": "The resolution lapsed or fell short of 75%." }, { "code": "person_verification_required", "type": null, "when": "A director or signer has not completed identity verification." }, { "code": "deadline_passed", "type": null, "when": "The filing period has ended." } ] } }, "Params_hk_non_hk_company_address_change": { "type": "object", "properties": { "hk_principal_place_of_business": { "type": "object", "description": "Change to the Hong Kong principal place of business: new_address and effective_date." }, "incorporation_registered_office": { "type": "object", "description": "Change to the registered office in the place of incorporation: new_address and effective_date." }, "incorporation_principal_place_of_business": { "type": "object", "description": "Change to the principal place of business in the place of incorporation: new_address and effective_date." }, "contact_updates": { "type": "object", "description": "hk_email, hk_email_effective_date, hk_phone, hk_phone_effective_date, incorporation_email, incorporation_email_effective_date." }, "governing_body_decision_date": { "type": "string", "format": "date", "description": "Date the foreign company's governing body authorised the change." } }, "description": "Notifies the Companies Registry of a change in a registered non-Hong Kong company's Hong Kong principal place of business, its registered office or principal place of business in its place of incorporation, or its contact email and Hong." }, "Create_hk_non_hk_company_address_change": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_address.change" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change address of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "governing_body_resolution", "title": "Resolution or written decision of the foreign company authorising the change", "source": "generated", "required": true }, { "key": "nn9", "title": "Form NN9 Return of Change of Address of Registered Non-Hong Kong Company", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NN9", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "governing_body_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nn9", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn9", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN9 Return of Change of Address of Registered Non-Hong Kong Company", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_supplied", "type": null, "when": "None of the four change objects was sent, or every address equals the current register." }, { "code": "hk_address_invalid", "type": null, "when": "The Hong Kong principal place of business is outside Hong Kong, is a care-of address or is a PO box." }, { "code": "person_verification_required", "type": null, "when": "The authorized representative or instructing officer has not completed identity verification." }, { "code": "signer_credentials_missing", "type": null, "when": "No eligible signer has CR e-Services credentials and Entiva is not the authorized representative." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on an instructing officer or beneficial owner pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the change." } ] } }, "Params_hk_non_hk_company_approved_name_file": { "type": "object", "properties": { "trigger": { "type": "string", "enum": [ "registrar_notice_s780", "change_of_approved_name" ], "description": "registrar_notice_s780: the Registrar served a s.780 notice on the corporate name or an approved name. change_of_approved_name: the company wants to replace a." }, "registrar_notice_reference": { "type": "string", "description": "Reference of the Registrar's s.780 notice." }, "registrar_notice_date": { "type": "string", "format": "date", "description": "Date the notice was served.", "examples": [ "2026-09-30" ] }, "current_approved_name": { "type": "string", "description": "The approved name being replaced." }, "name_en": { "type": "string", "description": "Proposed substitute name in English." }, "name_zh": { "type": "string", "description": "Proposed substitute name in traditional Chinese characters." }, "registrar_approval_reference": { "type": "string", "description": "Reference of the Registrar's written approval of the name." }, "registrar_approval_date": { "type": "string", "format": "date", "description": "Date of the Registrar's approval." } }, "required": [ "trigger" ], "description": "Handles the substitute name a registered non-Hong Kong company must use in Hong Kong after the Registrar serves a notice under Cap. 622 s.780, or when it later changes an approved name. The company applies in writing for approval, then." }, "Create_hk_non_hk_company_approved_name_file": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_approved_name.file" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_approved_name_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an approved name for carrying on business in Hong Kong", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "approval_application_letter", "title": "Written application to the Registrar for approval of the substitute name", "source": "generated", "required": true }, { "key": "registrar_approval_letter", "title": "Registrar's written approval of the name", "source": "registry_issued", "required": true }, { "key": "nn12", "title": "Form NN12 Return of Approved Name for Carrying on Business in Hong Kong", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Fresh Certificate of Registration of Non-Hong Kong Company", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "approval_application_letter", "signer_role": "filing_agent", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "approval_application_letter", "signer_role": "authorised_representative", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "nn12", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn12", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN12 Return of Approved Name for Carrying on Business in Hong Kong", "channel": "both", "government_fee": { "amount": 1425, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "registrar_approval_missing", "type": null, "when": "NN12 cannot be prepared for submission until the Registrar's written approval is attached." }, { "code": "registrar_refused_name", "type": null, "when": "The Registrar did not approve the proposed name; propose another." }, { "code": "notice_details_missing", "type": null, "when": "trigger is registrar_notice_s780 and the notice reference or date is not supplied." }, { "code": "person_verification_required", "type": null, "when": "The authorized representative or instructing officer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." }, { "code": "working_deadline_passed", "type": null, "when": "Two months from service of the s.780 notice have passed and the company is still trading under the objected name; Entiva flags the exposure to the authorized representative." } ] } }, "Params_hk_non_hk_company_constitution_amend": { "type": "object", "properties": { "instrument_changed": { "type": "string", "enum": [ "charter", "statutes", "memorandum_and_articles", "other" ], "description": "Which instrument changed." }, "other_instrument_name": { "type": "string", "description": "Name of the instrument when instrument_changed is other." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the change.", "examples": [ "2026-10-05" ] }, "change_details": { "type": "string", "description": "Details of the change." }, "certified_copy_of_changed_instrument": { "type": "string", "pattern": "^doc_", "description": "Certified copy of the instrument as changed." }, "certified_translation": { "type": "string", "pattern": "^doc_", "description": "Certified English or Chinese translation, required when the instrument is in neither language." }, "form_language": { "type": "string", "enum": [ "english", "chinese" ], "description": "Language of NN5." } }, "required": [ "instrument_changed", "effective_date", "change_details", "certified_copy_of_changed_instrument" ], "description": "Reports a change in the charter, statutes or memorandum or another instrument defining the constitution of a registered non-Hong Kong company. Form NN5 is filed within one month with a certified copy of the changed instrument." }, "Create_hk_non_hk_company_constitution_amend": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_constitution.amend" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_constitution_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report a change in the constitution of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_copy_of_changed_instrument", "title": "Certified copy of the charter, statutes, memorandum or other instrument as changed", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified translation into English or Chinese", "source": "uploaded", "required": false }, { "key": "home_registry_extract", "title": "Current extract or good-standing certificate from the place of incorporation", "source": "uploaded", "required": false }, { "key": "nn5", "title": "Form NN5 Return of Change in the Charter, Statutes or Memorandum etc. of Registered Non-Hong Kong.", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NN5", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "certified_copy_of_changed_instrument", "signer_role": "lawyer", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn5", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn5", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN5 Return of Change in the Charter, Statutes or Memorandum etc. of Registered Non-Ho", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "certified_copy_missing", "type": null, "when": "No certified copy of the changed instrument is attached." }, { "code": "certification_invalid", "type": null, "when": "A copy is not certified by a person listed in Cap. 622 s.775, or a translation is not certified under s.4." }, { "code": "form_language_mismatch", "type": null, "when": "The form language differs from the language of the instrument delivered with it." }, { "code": "person_verification_required", "type": null, "when": "The authorized representative or instructing officer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the change." } ] } }, "Params_hk_non_hk_company_name_change": { "type": "object", "properties": { "alteration_type": { "type": "string", "enum": [ "domestic_name_changed", "translation_added", "translation_changed", "translation_ceased" ], "description": "What changed. domestic_name_changed: the name in the place of incorporation changed. translation_added, translation_changed, translation_ceased: only the." }, "former_corporate_name": { "type": "string", "description": "Name exactly as on the last Certificate of Registration issued by the CR.", "examples": [ "Northwind Holdings Pte. Ltd." ] }, "corporate_name_english": { "type": "string", "description": "New English corporate name, if any." }, "corporate_name_chinese": { "type": "string", "description": "New Chinese corporate name or translation, in traditional characters, if any." }, "continuing_registered_names": { "type": "array", "items": {}, "description": "Other names that stay registered after the alteration (NN10 note 9)." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the alteration.", "examples": [ "2026-10-01" ] }, "foreign_certificate_of_change_of_name": { "type": "string", "pattern": "^doc_", "description": "Certificate of change of name from the place of incorporation showing the alteration and its effective date." }, "certified_translation": { "type": "string", "pattern": "^doc_", "description": "Certified English or Chinese translation, required when the foreign document is in another language and, for an added translation, the certified translation of." }, "authorising_special_resolution": { "type": "string", "pattern": "^doc_", "description": "Special resolution authorising the change and stating its effective date." }, "home_registry_extract": { "type": "string", "pattern": "^doc_", "description": "Current extract or good-standing certificate from the place of incorporation showing the new name." } }, "required": [ "alteration_type", "former_corporate_name", "effective_date" ], "description": "Reports a change, addition or cessation of the corporate name under which a Part 16 company is registered in Hong Kong. Filed on Form NN10 within one month with the foreign certificate of change of name; CR fee HK$1,425." }, "Create_hk_non_hk_company_name_change": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_name.change" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter corporate name of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_certificate_of_change_of_name", "title": "Certificate of change of name from the place of incorporation, certified", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified translation into English or Chinese", "source": "uploaded", "required": false }, { "key": "authorising_special_resolution", "title": "Special resolution authorising a translation change", "source": "uploaded", "required": false }, { "key": "home_registry_extract", "title": "Current extract or good-standing certificate showing the new name", "source": "uploaded", "required": true }, { "key": "nn10", "title": "Form NN10 Return of Alteration of Corporate Name of Registered Non-Hong Kong Company", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Fresh Certificate of Registration of Non-Hong Kong Company", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "foreign_certificate_of_change_of_name", "signer_role": "lawyer", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn10", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn10", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN10 Return of Alteration of Corporate Name of Registered Non-Hong Kong Company", "channel": "both", "government_fee": { "amount": 1425, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "foreign_certificate_missing", "type": null, "when": "alteration_type is domestic_name_changed and no certified certificate of change of name is attached." }, { "code": "certification_invalid", "type": null, "when": "A copy is not certified by a person listed in Cap. 622 s.775, or a translation is not certified under s.4." }, { "code": "name_restricted_by_registrar", "type": null, "when": "The new name is the same as or too like a registered name, or misleads; the Registrar may require a substitute approved name." }, { "code": "former_name_mismatch", "type": null, "when": "former_corporate_name differs from the last Certificate of Registration." }, { "code": "person_verification_required", "type": null, "when": "The authorized representative or instructing officer has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "The renamed company or a beneficial owner has an open sanctions alert, which pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the alteration." } ] } }, "Params_hk_non_hk_company_place_of_incorporation_change": { "type": "object", "properties": { "place_of_incorporation": { "type": "string", "description": "Jurisdiction in which the company is now registered after transferring its domicile.", "examples": [ "KY" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change of place of incorporation.", "examples": [ "2026-10-07" ] }, "foreign_certificate_of_registration": { "type": "string", "pattern": "^doc_", "description": "Certificate of registration or continuation issued by the new jurisdiction." }, "update_display_materials": { "type": "boolean", "description": "Default true: Entiva lists the Cap. 622M display changes as follow-up tasks." } }, "required": [ "place_of_incorporation", "effective_date" ], "description": "Reports that a registered non-Hong Kong company has transferred its domicile to another jurisdiction. New obligation since 23 May 2025 under Cap. 622 s.791: Form NN16 within one month." }, "Create_hk_non_hk_company_place_of_incorporation_change": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_place_of_incorporation.change" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_place_of_incorporation_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report a change of place of incorporation of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_certificate_of_registration", "title": "Certificate of registration or continuation from the new jurisdiction", "source": "uploaded", "required": false }, { "key": "home_registry_extract", "title": "Current extract or good-standing certificate from the new jurisdiction", "source": "uploaded", "required": true }, { "key": "nn16", "title": "Form NN16 Return of Change of Place of Incorporation of Registered Non-Hong Kong Company", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NN16", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nn16", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn16", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN16 Return of Change of Place of Incorporation of Registered Non-Hong Kong Company", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "place_of_incorporation_unchanged", "type": null, "when": "new_place_of_incorporation equals the place already registered." }, { "code": "home_registry_mismatch", "type": null, "when": "The new home registry does not show the company as registered there, or shows a different name or number." }, { "code": "person_verification_required", "type": null, "when": "The authorized representative, an instructing officer or a beneficial owner has not completed verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on the company or an owner pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the change." } ] } }, "Params_hk_objects_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ] }, "objects_removed_or_restricted": { "type": "array", "items": {}, "description": "Objects being abandoned or restricted (s.89), as text." }, "objects_added": { "type": "array", "items": {}, "description": "New objects being adopted (s.89)." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "The articles as altered; Entiva certifies them as correct by an officer." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed, if outside Entiva." }, "notice_given_to_all_members": { "type": "boolean", "description": "Confirms notice of the special resolution was given to all members.", "examples": [ "true" ] }, "court_application_made": { "type": "boolean", "description": "Private companies only: a member applied to the Court within 28 days to cancel the alteration." }, "court_order_date": { "type": "string", "format": "date", "description": "Date of the Court order confirming the alteration, when court_application_made is true." }, "court_order_office_copy": { "type": "string", "pattern": "^doc_", "description": "Office copy of the confirming order." } }, "required": [ "amended_articles" ], "description": "Alters the objects stated in a Hong Kong company's articles by special resolution and files Form NAA2 with the certified amended articles. A private company can be challenged in Court for 28 days, so it files within 15 days after that." }, "Create_hk_objects_amend": { "type": "object", "properties": { "type": { "const": "hk.objects.amend" }, "params": { "$ref": "#/components/schemas/Params_hk_objects_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter a company's objects", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the new objects and proposing the special resolution", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Special resolution of members altering the objects", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles of association as altered", "source": "uploaded", "required": true }, { "key": "certified_amended_articles", "title": "Copy of the articles as altered, certified by an officer as correct", "source": "generated", "required": true }, { "key": "court_order_office_copy", "title": "Office copy of the Court order confirming the alteration", "source": "uploaded", "required": false }, { "key": "naa2", "title": "Form NAA2 Notice of Alteration of Company's Objects", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NAA2", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_amended_articles", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NAA2 Notice of Alteration of Company's Objects", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_objects_clause", "type": null, "when": "The articles state no objects, so there is nothing to alter; use hk.articles.amend." }, { "code": "notice_to_members_missing", "type": null, "when": "Notice of the special resolution was not given to all members." }, { "code": "court_challenge_window_open", "type": null, "when": "A private company tried to file before the 28-day application period ended; Entiva holds the filing until day 29." }, { "code": "alteration_cancelled_by_court", "type": null, "when": "The Court cancelled the alteration; the action is closed without a filing." }, { "code": "resolution_not_passed", "type": null, "when": "The resolution lapsed or fell short of 75%." }, { "code": "person_verification_required", "type": null, "when": "A director or signer has not completed identity verification." }, { "code": "deadline_passed", "type": null, "when": "The filing period has ended." } ] } }, "Params_hk_ofc_name_change": { "type": "object", "properties": { "name_en": { "type": "string", "description": "Proposed English name." }, "name_zh": { "type": "string", "description": "Proposed Chinese name in traditional characters." }, "board_decision_date": { "type": "string", "format": "date", "description": "Date of the board decision, if taken outside Entiva." }, "sfc_approval_reference": { "type": "string", "description": "Reference of the SFC's approval of the name change." }, "sfc_approval_date": { "type": "string", "format": "date", "description": "Date the OFC was given notice of the approval." } }, "description": "Changes an OFC's name. An OFC may not change its name unless the SFC approves (Cap. 571AQ rule 9)." }, "Create_hk_ofc_name_change": { "type": "object", "properties": { "type": { "const": "hk.ofc_name.change" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change name of an open-ended fund company (SFC approval, Form OFCNC2)", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the name change and the SFC application", "source": "generated", "required": true }, { "key": "sfc_approval_application", "title": "Application to the SFC for approval of the name change", "source": "generated", "required": true }, { "key": "sfc_approval_notice", "title": "SFC notice approving the name change", "source": "uploaded", "required": true }, { "key": "ofcnc2", "title": "Form OFCNC2 Notice of Change of Company Name", "source": "generated", "required": true }, { "key": "certificate_of_change_of_name", "title": "Certificate of Change of Name of Open-ended Fund Company", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "manager", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ofcnc2", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Securities and Futures Commission", "form": "Form OFCNC2", "channel": "paper", "government_fee": { "amount": 1405, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "sfc_approval_pending", "type": null, "when": "The SFC has not yet approved the name; the action waits in requirements_pending." }, { "code": "sfc_approval_refused", "type": null, "when": "The SFC refused the name; the action is rejected and no fee is payable to the CR." }, { "code": "wet_ink_signature_pending", "type": null, "when": "The signed paper OFCNC2 has not been received by Entiva." }, { "code": "person_verification_required", "type": null, "when": "The signing director has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after notice of the SFC's approval." } ] } }, "Params_hk_ofc_registered_office_change": { "type": "object", "properties": { "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office in Hong Kong." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change." }, "contact_updates": { "type": "object", "description": "Optional OFCR1 items 2 and 2: email, email_effective_date, hk_phone, hk_phone_effective_date." }, "board_decision_date": { "type": "string", "format": "date", "description": "Date of a board decision already taken outside Entiva." }, "notify_ird_business_address": { "type": "boolean", "description": "Default true: Entiva raises a linked hk.business_registration.update for the business address, due within one month." } }, "required": [ "registered_office", "effective_date" ], "description": "Notifies the Companies Registry that an OFC's registered office in Hong Kong has changed. A director signs OFCR1 and it is delivered to the CR within 15 days." }, "Create_hk_ofc_registered_office_change": { "type": "object", "properties": { "type": { "const": "hk.ofc_registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_hk_ofc_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change registered office of an open-ended fund company", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the new registered office", "source": "generated", "required": true }, { "key": "ofcr1", "title": "Form OFCR1 Notice of Change of Address of Registered Office", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered OFCR1", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ofcr1", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form OFCR1 Notice of Change of Address of Registered Office", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "new_office_not_in_hong_kong", "type": null, "when": "The address is outside Hong Kong, is a care-of address or is a PO box." }, { "code": "registered_office_unchanged", "type": null, "when": "The new address equals the registered office on the register." }, { "code": "person_verification_required", "type": null, "when": "The signing director has not completed identity verification." }, { "code": "wet_ink_signature_pending", "type": null, "when": "The signed paper OFCR1 has not been received by the Entiva; the filing cannot be submitted." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a director or controller pauses live filings." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after the change." } ] } }, "Params_hk_registered_document_rectify": { "type": "object", "properties": { "rectified_document": { "type": "object", "description": "The registered document to correct: form_number, document_name, filing_date and document_reference_number." }, "corrections": { "type": "array", "items": {}, "description": "One object per correction. kind personal_particulars: capacity, person, corrected_name_english, corrected_name_chinese, previous_names, aliases." }, "original_signer_capacity": { "type": "string", "enum": [ "director", "company_secretary", "authorized_representative", "manager", "liquidator", "receiver", "other" ], "description": "Capacity of the person who signed the document being corrected." }, "corrected_pages": { "type": "string", "pattern": "^doc_", "description": "Corrected copy of the relevant pages, headed 'Amended copy' with corrections underlined." }, "explanation": { "type": "string", "description": "Short explanation of how the error arose, for the Registrar if it asks for clarification." } }, "required": [ "rectified_document", "corrections", "original_signer_capacity" ], "description": "Applies to the Registrar under Cap. 622 s.41 to correct a typographical or clerical error in a document already on the register. One Form AD corrects one registered document." }, "Create_hk_registered_document_rectify": { "type": "object", "properties": { "type": { "const": "hk.registered_document.rectify" }, "params": { "$ref": "#/components/schemas/Params_hk_registered_document_rectify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rectify a typographical or clerical error in a registered document", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registered_document_copy", "title": "Copy of the registered document being corrected", "source": "uploaded", "required": false }, { "key": "corrected_pages", "title": "Corrected pages marked 'Amended copy'", "source": "uploaded", "required": false }, { "key": "identity_document", "title": "HKID or passport of the person whose personal particulars are corrected", "source": "uploaded", "required": false }, { "key": "form_ad", "title": "Form AD Rectification of Typographical or Clerical Error in Registered Document, with PI-AD sheets", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered Form AD", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_ad", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_ad", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_ad", "signer_role": "other", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form AD Rectification of Typographical or Clerical Error in Registered Document", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "correction_not_eligible", "type": null, "when": "The correction would change the company name, the type of company or a founder member, or would vary the capital structure without authority." }, { "code": "more_than_one_document", "type": null, "when": "The corrections concern more than one registered document; raise one action per document." }, { "code": "prosecution_or_objection_pending", "type": null, "when": "The Registrar has started prosecution over the document or received an objection or conflicting evidence; the Registrar may reject the form." }, { "code": "identity_mismatch", "type": null, "when": "The corrected name or ID number does not match the person's HKID or passport." }, { "code": "signer_capacity_mismatch", "type": null, "when": "The chosen signer does not have the capacity of the original document's signer." }, { "code": "person_verification_required", "type": null, "when": "The person whose particulars are corrected, or the signer, has not completed identity verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live filings." } ] } }, "Params_hk_registered_office_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Send it only to assert the expected type; a mismatch returns entity_type_not_supported." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office.", "examples": [ "Unit 1203, 12/F, Sample Tower, 88 Queen's Road Central, Central, Hong Kong" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the registered office moves.", "examples": [ "2026-11-02" ] }, "office_provider": { "type": "string", "enum": [ "entiva_partner", "customer_premises", "third_party_provider" ], "description": "Who provides the new address. entiva_partner moves the registered-office service to Entiva's Entiva." }, "contact_updates": { "type": "object", "description": "Optional NR1 items 2 and 2: email, email_effective_date, hk_phone and hk_phone_effective_date." }, "business_address_follows_registered_office": { "type": "boolean", "description": "true asks the CR e-Services one-stop service to move the IRD business address to the new registered office from the NR1 effective date. false makes Entiva.", "examples": [ "true" ] }, "registers_kept_at_new_office": { "type": "boolean", "description": "Default true: the statutory registers move with the registered office. false keeps them where they are and Entiva raises a linked.", "examples": [ "true" ] }, "board_decision_date": { "type": "string", "format": "date", "description": "Date of a board decision already taken outside Entiva." } }, "required": [ "registered_office", "effective_date" ], "description": "Moves a Hong Kong company's registered office to a new Hong Kong address and files Form NR1 with the Companies Registry within 15 days. The CR passes the new registered office address to the Business Registration Office, but the IRD." }, "Create_hk_registered_office_change": { "type": "object", "properties": { "type": { "const": "hk.registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_hk_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change registered office address", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the new registered office", "source": "generated", "required": true }, { "key": "nr1", "title": "Form NR1 Notice of Change of Address of Registered Office", "source": "generated", "required": true }, { "key": "proof_of_address", "title": "Proof of the new business address", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "CR acknowledgement of the registered NR1 with its document reference", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nr1", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nr1", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NR1 Notice of Change of Address of Registered Office", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "new_office_not_in_hong_kong", "type": null, "when": "The address is outside Hong Kong, is a care-of address or is a PO box; NR1 does not accept them." }, { "code": "registered_office_unchanged", "type": null, "when": "The new address equals the registered office already on the register." }, { "code": "action_already_in_progress", "type": null, "when": "Another registered-office change for this entity has not completed." }, { "code": "person_verification_required", "type": null, "when": "A director or secretary who must approve or sign has not completed identity verification." }, { "code": "signer_credentials_missing", "type": null, "when": "No eligible signer has CR e-Services credentials or iAM Smart+, and Entiva is not the secretary." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a director, secretary or beneficial owner pauses live filings for the entity." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after effective_date." }, { "code": "entity_not_active", "type": null, "when": "The entity is dissolved, struck off or deregistered." } ] } }, "Params_hk_society_particulars_notify": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "One object per change, each with kind and effective_date. kind society_name: new_name_english, new_name_chinese, translation. objects: new_objects.." }, "society_registration_number": { "type": "string", "description": "Registration or exemption number kept by the Societies Office.", "examples": [ "SR/2019/04512" ] }, "original_certificate": { "type": "string", "pattern": "^doc_", "description": "Scan of the original Certificate of Registration or Exemption, which the Societies Office needs returned for a name change, a principal-place change or a." }, "police_loss_report_reference": { "type": "string", "description": "Reference of a Police lost-property report, if the original certificate is lost." }, "submission_route": { "type": "string", "enum": [ "online", "paper" ], "description": "online or paper." }, "committee_decision_date": { "type": "string", "format": "date", "description": "Date of the committee or general meeting decision, if outside Entiva." } }, "required": [ "changes" ], "description": "Notifies the Societies Officer within one month of a change in a society's or branch's name, objects, office-bearers or principal place of business, or the closure of a branch, using the Application for Changes of Particulars. No fee." }, "Create_hk_society_particulars_notify": { "type": "object", "properties": { "type": { "const": "hk.society_particulars.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_society_particulars_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Societies Officer of changes to a registered or exempted society", "x-entiva": { "jurisdiction": "hk", "stage": "changes", "applies_to": [ "society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "committee_minutes", "title": "Minutes of the meeting deciding the change", "source": "generated", "required": true }, { "key": "pol1148", "title": "Application for Changes of Particulars of Registered and Exempted Societies", "source": "generated", "required": true }, { "key": "office_bearer_id_copies", "title": "Copies of the HKID card or other valid identity document of each incoming office-bearer", "source": "uploaded", "required": false }, { "key": "proof_of_address", "title": "Proof of the principal place of business", "source": "uploaded", "required": false }, { "key": "occupier_consent_letter", "title": "Consent letter from the lawful occupier of the premises, with ID copy", "source": "uploaded", "required": false }, { "key": "name_consent_letters", "title": "Consent letters of associations or persons whose names the new name relates to", "source": "uploaded", "required": false }, { "key": "constitution", "title": "Amended constitution or articles of association", "source": "uploaded", "required": false }, { "key": "officer_qualifications", "title": "Certificates supporting the office-bearers' qualifications for the stated objects, if any", "source": "uploaded", "required": false }, { "key": "original_certificate", "title": "Original Certificate of Registration or Exemption", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Acknowledgement of amendment and updated certificate where the name or address changed", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "officer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "committee_minutes", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "pol1148", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "pol1148", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "pol1148", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "pol1148", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Societies Officer, Hong Kong Police Force", "form": "Application for Changes of Particulars of Registered and Exempted Societies, form POL.1148", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_conflicts_with_existing_society", "type": null, "when": "The new name is identical to, or closely resembles, a currently listed society's name, or is likely to mislead the public about its character or purpose." }, { "code": "fewer_than_three_office_bearers", "type": null, "when": "The change would leave fewer than three office-bearers." }, { "code": "person_in_charge_missing", "type": null, "when": "No registered office-bearer is designated person in charge after the change." }, { "code": "principal_place_not_in_hong_kong", "type": null, "when": "The principal place of business is outside Hong Kong or is a PO box." }, { "code": "address_proof_invalid", "type": null, "when": "The proof is older than 3 months, or comes from the Hong Kong Police." }, { "code": "original_certificate_missing", "type": null, "when": "A name, principal-place or branch-closure change was requested without the original certificate or a Police loss-report reference." }, { "code": "outgoing_office_bearer_unconfirmed", "type": null, "when": "An outgoing office-bearer has neither signed nor given reasons." }, { "code": "person_verification_required", "type": null, "when": "A person in charge, endorsing office-bearer or incoming office-bearer has not completed identity verification." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month after the change." } ] } }, "Params_hk_branch_register": { "type": "object", "properties": { "branch_name": { "type": "string", "description": "Business name of the branch." }, "branch_address": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address where the branch business is carried on." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the branch started business." }, "nature_of_business": { "type": "string", "description": "What the branch does." }, "is_additional_business_name": { "type": "boolean", "description": "True if the branch is only an extra trading name at an existing location." }, "certificate_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "Term of the branch registration certificate." }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Person the IRD may contact about the branch." } }, "required": [ "branch_name", "branch_address", "commencement_date", "nature_of_business", "is_additional_business_name", "certificate_period" ], "description": "Register a branch business, including each additional business name, with the Business Registration Office on Form 1, usually through eTAX, within one month of starting business at the branch." }, "Create_hk_branch_register": { "type": "object", "properties": { "type": { "const": "hk.branch.register" }, "params": { "$ref": "#/components/schemas/Params_hk_branch_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a branch or additional business name with the IRD", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "general_partnership", "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_1d", "title": "Form 1 application for registration of branch business carried on in Hong Kong", "source": "generated", "required": true }, { "key": "branch_registration_certificate", "title": "Branch registration certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_1d", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Form 1", "channel": "both", "government_fee": { "amount": 230, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "btp_access_missing", "type": null, "when": "[requirement_error] The Responsible Person has not appointed Entiva on the Business Tax Portal." }, { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity type cannot hold a branch registration through this action." }, { "code": "branch_name_unavailable", "type": null, "when": "[registry_error] The branch name breaks the naming rules or duplicates a registered name." }, { "code": "registration_deadline_passed", "type": null, "when": "[requirement_error] More than one month has passed since the branch started business." }, { "code": "parent_br_missing", "type": null, "when": "[requirement_error] The entity has no business registration to attach the branch to." } ] } }, "Params_hk_company_continue_in": { "type": "object", "properties": { "applicant_name": { "type": "string", "description": "Name of the non-HK corporation as registered at its place of incorporation." }, "applicant_place_of_incorporation": { "type": "string", "description": "Jurisdiction where it is incorporated and registered on the application date." }, "applicant_registration_number": { "type": "string", "description": "Number on its home registry." }, "home_entity_id": { "type": "string", "pattern": "^ent_", "description": "Existing Entiva entity for the applicant, to carry its history across." }, "is_listed": { "type": "boolean", "description": "Whether the applicant is a listed company; affects Schedule 2 of NNC6." }, "part16_registered": { "type": "boolean", "description": "Whether it is a registered non-HK company under Part 16." }, "part16_business_registration_number": { "type": "string", "description": "First 8 digits of its BR number." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "description": "Type of the intended re-domiciled company; it must be the same or substantially the same as the applicant's type." }, "is_public": { "type": "boolean", "description": "For unlimited_company: true for a public unlimited company." }, "name_en": { "type": "string", "description": "English name; limited companies end in 'Limited'." }, "name_zh": { "type": "string", "description": "Chinese name; limited companies end in 有限公司." }, "nature_of_business_code": { "type": "string", "description": "CR business nature category code for the main business." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address from the re-domiciliation date." }, "contact_email": { "type": "string", "description": "Company email for CR communications." }, "contact_phone": { "type": "string", "description": "Hong Kong contact number, +852." }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Defaults to Entiva's Entiva." }, "directors": { "type": "array", "items": {}, "description": "List of {person_or_entity_ref, is_director_of_applicant, appointed_on, consent_in_form}." }, "departing_officers": { "type": "array", "items": {}, "description": "Directors and secretaries of the applicant who will not hold office in the Hong Kong company." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "Director of the applicant who signs NNC6, confirms its statements and certifies compliance." }, "share_reference_date": { "type": "string", "format": "date", "description": "Date at which issued share capital is stated; not earlier than 15 days before the application date." }, "issued_shares": { "type": "array", "items": {}, "description": "List of {class, number_of_shares, currency, total_amount, paid_up, unpaid, rights:{voting, dividends, capital, redeemable}}." }, "members": { "type": "array", "items": {}, "description": "List of {name, address, class, number_of_shares, amount, jointly_held, joint_holders}." }, "members_consent_route": { "type": "string", "enum": [ "consent_required_by_foreign_law_or_constitution", "members_resolution_75_percent" ], "description": "Consent obtained as the home law or constitution requires, or else a members' resolution at a meeting or in writing by at least 75%." }, "board_certificate_date": { "type": "string", "format": "date", "description": "Date of the board certificate; within 35 days before the application date." }, "board_certificate_attestations": { "type": "object", "description": "Booleans for Schedule 6C s.2-: one place of incorporation; registered there; no winding-up petition, order or resolution; no receiver or liquidator; no." }, "creditor_notice_date": { "type": "string", "format": "date", "description": "Date notice of the proposal was served on all creditors directly." }, "legal_opinion_date": { "type": "string", "format": "date", "description": "Date of the home-law legal opinion; within 35 days before the application date." }, "proposed_application_date": { "type": "string", "format": "date", "description": "Date Entiva will lodge NNC6." }, "br_certificate_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "BR term to buy." } }, "required": [ "applicant_name", "applicant_place_of_incorporation", "applicant_registration_number", "is_listed", "part16_registered", "entity_type", "nature_of_business_code", "registered_office", "contact_email", "contact_phone", "directors", "signing_director", "share_reference_date", "issued_shares", "members", "members_consent_route", "board_certificate_date", "board_certificate_attestations", "creditor_notice_date", "legal_opinion_date", "proposed_application_date" ], "description": "A non-Hong Kong corporation comparable to a Hong Kong company limited by shares, or an unlimited company with share capital, applies on Form NNC6 with IRBR5 and the Schedule 6C documents. It continues as the same legal entity, becomes a." }, "Create_hk_company_continue_in": { "type": "object", "properties": { "type": { "const": "hk.company.continue_in" }, "params": { "$ref": "#/components/schemas/Params_hk_company_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-domicile a non-Hong Kong company to Hong Kong", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nnc6", "title": "Form NNC6 re-domiciliation form", "source": "generated", "required": true }, { "key": "irbr5", "title": "Form IRBR5 notice to the Business Registration Office", "source": "generated", "required": true }, { "key": "proposed_articles", "title": "Proposed articles of association", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_certified", "title": "Certified copy of certificate of incorporation, plus certificate of registration if the domicile.", "source": "uploaded", "required": true }, { "key": "constitutional_documents_certified", "title": "Certified copy of each constitutional document", "source": "uploaded", "required": true }, { "key": "members_resolution_certified", "title": "Certified copy of the members' resolution", "source": "uploaded", "required": false }, { "key": "accounts", "title": "Accounts at the latest practicable date", "source": "uploaded", "required": true }, { "key": "board_certificate", "title": "Board certificate signed by a director authorised by board resolution", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution approving the application and the certificate signatory", "source": "generated", "required": true }, { "key": "legal_opinion", "title": "Legal opinion from a practitioner of the home law", "source": "uploaded", "required": true }, { "key": "creditor_notice_evidence", "title": "Evidence that notice was served on creditors", "source": "uploaded", "required": true }, { "key": "certified_translations", "title": "Certified translation of any document not in English or Chinese", "source": "uploaded", "required": false }, { "key": "certificate_of_re_domiciliation", "title": "Certificate of Re-domiciliation", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nnc6", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nnc6", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_certificate", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "proposed_articles", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution_certified", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "legal_opinion", "signer_role": "other", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "certificate_of_incorporation_certified", "signer_role": "other", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "irbr5", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NNC6 with Form IRBR5 and the Schedule 6C documents", "channel": "both", "government_fee": { "amount": 6050, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "applicant_type_not_eligible", "type": null, "when": "[requirement_error] The applicant is not comparable to a private or public company limited by shares or an unlimited company with share capital." }, { "code": "first_financial_year_not_ended", "type": null, "when": "[requirement_error] The first financial year at the place of incorporation has not ended by the application date." }, { "code": "board_certificate_stale", "type": null, "when": "[requirement_error] The board certificate is dated more than 35 days before the application date." }, { "code": "legal_opinion_stale", "type": null, "when": "[requirement_error] The legal opinion is dated more than 35 days before the application date." }, { "code": "creditor_notice_missing", "type": null, "when": "[requirement_error] No evidence of direct notice to creditors; a Gazette or newspaper notice does not suffice." }, { "code": "applicant_in_insolvency", "type": null, "when": "[requirement_error] A winding-up petition, order, receiver or insolvency scheme is attested to exist." }, { "code": "company_name_unavailable", "type": null, "when": "[registry_error] The name matches the Index of Company Names or a statutory body, or is mixed-script." }, { "code": "officer_requirements_not_met", "type": null, "when": "[requirement_error] Director or secretary numbers, residence or body-corporate rules are not met." }, { "code": "share_particulars_stale", "type": null, "when": "[requirement_error] The share reference date is older than 15 days before the application." }, { "code": "agent_cannot_sign", "type": null, "when": "[permission_error] An agent tried to sign NNC6 or a director's consent." } ] } }, "Params_hk_company_merge": { "type": "object", "properties": { "amalgamation_type": { "type": "string", "enum": [ "vertical", "horizontal" ], "description": "Vertical: the holding company is the amalgamated company and each subsidiary's shares are cancelled." }, "amalgamating_companies": { "type": "array", "items": {}, "description": "The other companies that merge into the amalgamated company." }, "wholly_owned_attestation": { "type": "boolean", "description": "Directors confirm the group structure qualifies: every subsidiary is wholly owned by the holding company." }, "amalgamation_proposal": { "type": "string", "pattern": "^doc_", "description": "The approved amalgamation proposal for each company." }, "amalgamated_company_directors": { "type": "array", "items": {}, "description": "person_ref list of directors of the amalgamated company to be notified on NAMA4, each with capacity director or alternate director." }, "creditor_prejudice_certified": { "type": "boolean", "description": "NAMA5 statement: where the amalgamated company's creditor claims are proportionately greater than an amalgamating company's, no creditor will be prejudiced." }, "presentor_reference": { "type": "string", "description": "Customer file reference." } }, "required": [ "amalgamation_type", "amalgamating_companies", "wholly_owned_attestation", "amalgamation_proposal", "amalgamated_company_directors", "creditor_prejudice_certified" ], "description": "Vertical or horizontal amalgamation under Division 3 of Part 13. Each amalgamating company delivers NAMA1 to NAMA3 within 15 days of approval, the amalgamated company delivers NAMA4 and NAMA5, and the Registrar issues a certificate of." }, "Create_hk_company_merge": { "type": "object", "properties": { "type": { "const": "hk.company.merge" }, "params": { "$ref": "#/components/schemas/Params_hk_company_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Court-free amalgamation of wholly-owned group companies", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amalgamation_proposal", "title": "Amalgamation proposal approved by each amalgamating company", "source": "uploaded", "required": true }, { "key": "approval_resolution", "title": "Directors' resolution approving the amalgamation (s.680 or s.681) for each company", "source": "generated", "required": true }, { "key": "nama1", "title": "Form NAMA1 approved amalgamation proposal (s.684)", "source": "generated", "required": true }, { "key": "nama2", "title": "Form NAMA2 certificate on solvency statement (s.684, s.683)", "source": "generated", "required": true }, { "key": "nama3", "title": "Form NAMA3 certificate of approval (s.684)", "source": "generated", "required": true }, { "key": "nama4", "title": "Form NAMA4 notice of appointment of directors of the amalgamated company (s.684)", "source": "generated", "required": true }, { "key": "nama5", "title": "Form NAMA5 certificate on creditor claims (s.684)", "source": "generated", "required": true }, { "key": "certificate_of_amalgamation", "title": "Certificate of amalgamation stating the effective date", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "approval_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nama1", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nama2", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nama3", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nama4", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nama4", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nama5", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Forms NAMA1, NAMA2, NAMA3", "channel": "online", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] A company is a guarantee company, registered non-HK company or other type outside this regime." }, { "code": "group_structure_ineligible", "type": null, "when": "[requirement_error] A subsidiary is not wholly owned, or the companies are not in a vertical or horizontal relationship." }, { "code": "solvency_statement_incomplete", "type": null, "when": "[requirement_error] A director who voted for the statement has not signed NAMA2." }, { "code": "approval_not_recorded", "type": null, "when": "[requirement_error] An amalgamating company has no recorded approval resolution." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] More than 15 days have passed since approval of the proposal." }, { "code": "agent_cannot_sign", "type": null, "when": "[permission_error] An agent tried to sign NAMA2, NAMA3, NAMA5 or a consent for a director." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The Registrar rejected a NAMA form, for example because director names do not match the CR record." } ] } }, "Params_hk_company_status_convert_to_private": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_shares", "unlimited_company" ], "description": "Current type." }, "is_listed": { "type": "boolean", "description": "True if the company or its shares are listed." }, "resolution_mode": { "type": "string", "enum": [ "meeting", "written" ], "description": "How the special resolution is passed." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution is passed." }, "effective_date": { "type": "string", "format": "date", "description": "Date the alteration takes effect and the company becomes private." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "Articles as altered." }, "member_count": { "type": "integer", "description": "Number of members on the effective date." }, "directors": { "type": "array", "items": {}, "description": "person_ref list of directors after the change." }, "business_registration_number": { "type": "string", "description": "First 8 digits of the BR number." }, "presentor_reference": { "type": "string", "description": "Customer file reference for the Presentor's Reference box." } }, "required": [ "entity_type", "is_listed", "resolution_mode", "resolution_date", "effective_date", "amended_articles", "member_count", "directors" ], "description": "Members pass a special resolution altering the articles so they carry the private-company restrictions in Cap. 622 s.11. The company delivers the alteration documents and Form NAA4 within 15 days of the change taking effect." }, "Create_hk_company_status_convert_to_private": { "type": "object", "properties": { "type": { "const": "hk.company_status.convert_to_private" }, "params": { "$ref": "#/components/schemas/Params_hk_company_status_convert_to_private" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a public company to a private company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing the alteration", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution altering the articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles of association as altered", "source": "uploaded", "required": true }, { "key": "register_of_members_extract", "title": "Register of members extract showing the member count", "source": "generated", "required": true }, { "key": "naa1", "title": "Form NAA1 notice of alteration of articles (s.88 documents)", "source": "generated", "required": true }, { "key": "naa4", "title": "Form NAA4 notice of change of company status", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "naa1", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa4", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Special resolution copy", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] Guarantee companies and registered non-Hong Kong companies cannot change status with this action." }, { "code": "company_already_private", "type": null, "when": "[invalid_request_error] The entity is already a private company." }, { "code": "listed_company_not_eligible", "type": null, "when": "[requirement_error] is_listed is true." }, { "code": "member_limit_exceeded", "type": null, "when": "[requirement_error] member_count is above 50." }, { "code": "natural_person_director_missing", "type": null, "when": "[requirement_error] No director is a natural person." }, { "code": "articles_missing_private_restrictions", "type": null, "when": "[requirement_error] The amended articles lack the transfer restriction, the 50-member limit or the ban on public invitations." }, { "code": "special_resolution_not_passed", "type": null, "when": "[requirement_error] The special resolution has not reached 75% or is not recorded." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The 15-day window after the effective date has already closed." } ] } }, "Params_hk_company_status_convert_to_public": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "unlimited_company" ], "description": "Current type." }, "resolution_mode": { "type": "string", "enum": [ "meeting", "written" ], "description": "How the members' special resolution is passed." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution altering the articles is passed." }, "effective_date": { "type": "string", "format": "date", "description": "Date the alteration takes effect; the company is public from this date." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "Full articles as altered." }, "prior_year_financial_statements": { "type": "string", "pattern": "^doc_", "description": "Certified true copy of the annual financial statements prepared under s.379 for the financial year immediately before the year in which the alteration takes." }, "directors": { "type": "array", "items": {}, "description": "person_ref list of the directors after the change." }, "business_registration_number": { "type": "string", "description": "First 8 digits of the BR number." }, "presentor_reference": { "type": "string", "description": "Customer file reference printed in the Presentor's Reference box." } }, "required": [ "entity_type", "resolution_mode", "resolution_date", "effective_date", "amended_articles", "prior_year_financial_statements", "directors" ], "description": "Members pass a special resolution altering the articles so they no longer carry the private-company restrictions in Cap. 622 s.11. The company then delivers the alteration documents and Form NAA4 within 15 days of the change taking effect." }, "Create_hk_company_status_convert_to_public": { "type": "object", "properties": { "type": { "const": "hk.company_status.convert_to_public" }, "params": { "$ref": "#/components/schemas/Params_hk_company_status_convert_to_public" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a private company to a public company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing the alteration", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution altering the articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles of association as altered", "source": "uploaded", "required": true }, { "key": "prior_year_financial_statements", "title": "Certified true copy of prior-year annual financial statements", "source": "uploaded", "required": true }, { "key": "naa1", "title": "Form NAA1 notice of alteration of articles (s.88 documents)", "source": "generated", "required": true }, { "key": "naa4", "title": "Form NAA4 notice of change of company status", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "naa1", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "naa4", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Special resolution copy", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] Guarantee companies and registered non-Hong Kong companies cannot change status with this action." }, { "code": "company_already_public", "type": null, "when": "[invalid_request_error] The entity is already a public company." }, { "code": "directors_below_minimum", "type": null, "when": "[requirement_error] Fewer than two directors are listed for the public company." }, { "code": "body_corporate_director_not_allowed", "type": null, "when": "[requirement_error] A body corporate is listed as director; a public company cannot have one." }, { "code": "financial_statements_missing", "type": null, "when": "[requirement_error] The certified prior-year s.379 financial statements are not uploaded." }, { "code": "articles_still_private", "type": null, "when": "[requirement_error] The amended articles still contain the transfer restriction, 50-member limit or ban on public invitations." }, { "code": "special_resolution_not_passed", "type": null, "when": "[requirement_error] The members' special resolution has not reached 75% or is not recorded." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The 15-day window after the effective date has already closed; the filing is late." } ] } }, "Params_hk_eligible_company_register": { "type": "object", "properties": { "existing_name_en": { "type": "string", "description": "Current English name." }, "existing_name_zh": { "type": "string", "description": "Current Chinese name." }, "formed_under": { "type": "string", "description": "Ordinance or instrument under which the company was formed or constituted." }, "formation_date": { "type": "string", "format": "date", "description": "Date of formation; it must be after 1 May 1865." }, "entity_type": { "type": "string", "enum": [ "guarantee_company", "unlimited_company" ], "description": "Cap. 622 type to register as." }, "is_public": { "type": "boolean", "description": "For unlimited_company: true for a public unlimited company." }, "nature_of_business_code": { "type": "string", "description": "CR business nature category code." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address; no c/o or PO box." }, "contact_email": { "type": "string", "description": "Company email for CR communications." }, "contact_phone": { "type": "string", "description": "Hong Kong contact number." }, "member_count": { "type": "integer", "description": "Guarantee company: number of members on registration." }, "member_undertakings": { "type": "array", "items": {}, "description": "Guarantee company: list of {class_of_members, currency, amount} the members undertake to contribute on winding up (s.810)." }, "share_capital": { "type": "array", "items": {}, "description": "Unlimited company: list of {class, currency, shares_issued, subscribed_amount, paid_up, unpaid, rights}." }, "members": { "type": "array", "items": {}, "description": "Unlimited company: list of {name, address, class, shares, subscribed_amount}." }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Defaults to Entiva's Entiva." }, "directors": { "type": "array", "items": {}, "description": "person_ref list." }, "signing_member": { "type": "string", "pattern": "^per_", "description": "A member named in NNC5, authorised by the other members, who signs and certifies the member's statement." }, "constitutional_documents": { "type": "array", "items": {}, "description": "document_ref list of every constitutional document." }, "s810_resolution": { "type": "string", "pattern": "^doc_", "description": "Guarantee company: the resolution complying with s.810." }, "members_assent_date": { "type": "string", "format": "date", "description": "Date of the general meeting at which members assented." }, "liability_confirmation": { "type": "boolean", "description": "Unlimited company: members' liability is not limited by an Ordinance or otherwise." } }, "required": [ "formed_under", "formation_date", "entity_type", "nature_of_business_code", "registered_office", "contact_email", "contact_phone", "directors", "signing_member", "constitutional_documents", "members_assent_date" ], "description": "A company formed after 1 May 1865 under another Ordinance, or otherwise constituted by law, applies on Form NNC5 to register as a company limited by guarantee or an unlimited company. A member signs and certifies the application." }, "Create_hk_eligible_company_register": { "type": "object", "properties": { "type": { "const": "hk.eligible_company.register" }, "params": { "$ref": "#/components/schemas/Params_hk_eligible_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an eligible company as a Cap. 622 company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "unlimited_company", "guarantee_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nnc5", "title": "Form NNC5 application for registration of eligible company", "source": "generated", "required": true }, { "key": "constitutional_documents", "title": "Copy of every constitutional document", "source": "uploaded", "required": true }, { "key": "s810_resolution", "title": "Resolution complying with s.810", "source": "uploaded", "required": false }, { "key": "members_meeting_minutes", "title": "Minutes of the general meeting recording members' assent", "source": "generated", "required": true }, { "key": "director_consents", "title": "Consent to act as director from each director", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of Registration of eligible company", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nnc5", "signer_role": "member", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_consents", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "members_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NNC5", "channel": "online", "government_fee": { "amount": 1545, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_an_eligible_company", "type": null, "when": "[requirement_error] The company was formed before 1 May 1865, under the Companies Ordinance, or is not constituted according to law." }, { "code": "members_assent_insufficient", "type": null, "when": "[requirement_error] The meeting did not reach the required assent." }, { "code": "member_undertaking_missing", "type": null, "when": "[requirement_error] A guarantee company has no member undertaking amount." }, { "code": "officer_requirements_not_met", "type": null, "when": "[requirement_error] Director or secretary numbers, residence or body-corporate rules are not met." }, { "code": "name_not_registrable", "type": null, "when": "[registry_error] The English name lacks 'Limited' or the Chinese name lacks 有限公司 for a guarantee company." }, { "code": "agent_cannot_sign", "type": null, "when": "[permission_error] An agent tried to sign NNC5 or a director consent." } ] } }, "Params_hk_limited_partnership_as_lpf_register": { "type": "object", "properties": { "name_en": { "type": "string", "description": "English name ending in 'Limited Partnership Fund' or 'LPF'." }, "name_zh": { "type": "string", "description": "Chinese name ending in 有限合夥基金." }, "general_partner": { "type": "string", "pattern": "^per_", "description": "person_ref or entity_ref of the proposed general partner: an adult individual, private company limited by shares, registered non-HK company, re-domiciled." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Required if the general partner is an LPF or a non-HK limited partnership without legal personality." }, "limited_partners": { "type": "array", "items": {}, "description": "List of {person_or_entity_ref, contribution}." }, "investment_manager": { "type": "string", "pattern": "^per_", "description": "Hong Kong resident adult, company or registered non-HK company." }, "responsible_person": { "type": "string", "pattern": "^per_", "description": "AML/CFT responsible person: an authorized institution, licensed corporation, accounting professional or legal professional." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address; no c/o address or PO box." }, "communications_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong office for communications and notices." }, "investment_scope": { "type": "string", "description": "Description of the fund's investment scope, a registered particular later changed on Form LPF4A." }, "limited_partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "The agreement constituting the fund; it must not contravene Cap. 637 or other law." }, "attest_s7_eligibility": { "type": "boolean", "description": "General partner confirms the s.7 eligibility conditions: one general partner, at least one limited partner, lawful purpose, compliant name, Hong Kong office." }, "holds_valid_br_certificate": { "type": "boolean", "description": "True if the partnership already holds a valid BR certificate." }, "br_certificate_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "BR certificate term to buy when holds_valid_br_certificate is false." } }, "required": [ "general_partner", "limited_partners", "investment_manager", "responsible_person", "registered_office", "communications_office", "investment_scope", "limited_partnership_agreement", "attest_s7_eligibility", "holds_valid_br_certificate" ], "description": "A fund registered as a limited partnership under Cap. 37 applies on Form LPF2, through a Hong Kong law firm acting for the proposed general partner. The partnership is not dissolved: it continues as an LPF and stops being registered under." }, "Create_hk_limited_partnership_as_lpf_register": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership_as_lpf.register" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_as_lpf_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Migrate a Cap. 37 limited partnership fund to a limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "lpf2", "title": "Form LPF2 application for registration of a specified fund as an LPF", "source": "generated", "required": true }, { "key": "irbr4", "title": "Form IRBR4 notice to the Business Registration Office", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Limited partnership agreement", "source": "uploaded", "required": true }, { "key": "partner_consent", "title": "Partners' consent to the migration, if the agreement requires it", "source": "uploaded", "required": false }, { "key": "certificate_of_registration_lpf", "title": "Certificate of Registration of a Specified Fund as an LPF", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "lpf2", "signer_role": "general_partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "lpf2", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "limited_partnership_agreement", "signer_role": "general_partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF2 with Form IRBR4", "channel": "both", "government_fee": { "amount": 3034, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is not a Cap. 37 limited partnership that is a fund." }, { "code": "law_firm_required", "type": null, "when": "[requirement_error] No Hong Kong law firm or solicitor is instructed to submit (Cap. 637 s.11)." }, { "code": "lpf_name_invalid", "type": null, "when": "[registry_error] Name lacks the required ending or matches an existing index entry." }, { "code": "general_partner_ineligible", "type": null, "when": "[requirement_error] The proposed general partner is not one of the permitted types." }, { "code": "authorised_representative_missing", "type": null, "when": "[requirement_error] The general partner is an LPF or non-HK limited partnership without legal personality and no representative is named." }, { "code": "hk_office_invalid", "type": null, "when": "[requirement_error] The registered or communications office is outside Hong Kong, a c/o address or a PO box." }, { "code": "partners_all_same_group", "type": null, "when": "[requirement_error] Every partner is a corporation of the same group." } ] } }, "Params_hk_limited_partnership_fund_continue_in": { "type": "object", "properties": { "current_fund_name": { "type": "string", "description": "Name under which the fund is established abroad." }, "place_of_establishment": { "type": "string", "description": "Jurisdiction of establishment." }, "foreign_registration_number": { "type": "string", "description": "Number on the home registry, if any." }, "home_entity_id": { "type": "string", "pattern": "^ent_", "description": "Existing Entiva entity for the fund." }, "name_en": { "type": "string", "description": "English name ending in 'Limited Partnership Fund' or 'LPF'." }, "name_zh": { "type": "string", "description": "Chinese name ending in 有限合夥基金." }, "general_partner": { "type": "string", "pattern": "^per_", "description": "Proposed general partner: adult individual, private company limited by shares, registered non-HK company, re-domiciled private company, Cap. 37 limited." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Required if the general partner is an LPF or a non-HK limited partnership without legal personality." }, "limited_partners": { "type": "array", "items": {}, "description": "List of {person_or_entity_ref, contribution}." }, "investment_manager": { "type": "string", "pattern": "^per_", "description": "Hong Kong resident adult, company or registered non-HK company." }, "responsible_person": { "type": "string", "pattern": "^per_", "description": "Authorized institution, licensed corporation, accounting professional or legal professional." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address; no c/o or PO box." }, "communications_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong office for communications and notices." }, "investment_scope": { "type": "string", "description": "Investment scope, a registered particular." }, "limited_partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "The agreement constituting the fund." }, "attest_s7_eligibility": { "type": "boolean", "description": "General partner confirms the s.7 conditions are met." }, "holds_valid_br_certificate": { "type": "boolean", "description": "True if the original partnership holds a valid BR certificate; IRBR4 is still delivered." }, "br_certificate_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "BR term to buy if none is held." } }, "required": [ "current_fund_name", "place_of_establishment", "general_partner", "limited_partners", "investment_manager", "responsible_person", "registered_office", "communications_office", "investment_scope", "limited_partnership_agreement", "attest_s7_eligibility", "holds_valid_br_certificate" ], "description": "A fund set up as a limited partnership under non-Hong Kong law applies on Form LPF10, through a Hong Kong law firm for the proposed general partner. The partnership continues as an LPF with no new legal entity, and must deregister in its." }, "Create_hk_limited_partnership_fund_continue_in": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership_fund.continue_in" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_fund_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a non-Hong Kong fund as an LPF", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "lpf10", "title": "Form LPF10 application to register a non-Hong Kong fund as an LPF", "source": "generated", "required": true }, { "key": "irbr4", "title": "Form IRBR4 notice to the Business Registration Office", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Limited partnership agreement", "source": "uploaded", "required": true }, { "key": "foreign_establishment_evidence", "title": "Certified evidence that the fund is established as a limited partnership under foreign law", "source": "uploaded", "required": true }, { "key": "certificate_of_registration_lpf", "title": "Certificate of Registration of a Non-Hong Kong Fund as an LPF", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": false }, { "key": "foreign_deregistration_evidence", "title": "Evidence of deregistration in the place of establishment", "source": "uploaded", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "lpf10", "signer_role": "general_partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "lpf10", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "foreign_establishment_evidence", "signer_role": "other", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form LPF10 with Form IRBR4", "channel": "both", "government_fee": { "amount": 3034, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fund_not_limited_partnership", "type": null, "when": "[requirement_error] The fund is not a limited partnership under its home law." }, { "code": "law_firm_required", "type": null, "when": "[requirement_error] No Hong Kong law firm or solicitor is instructed (Cap. 637 s.11)." }, { "code": "lpf_name_invalid", "type": null, "when": "[registry_error] Name lacks the required ending or matches an index entry." }, { "code": "general_partner_ineligible", "type": null, "when": "[requirement_error] The proposed general partner is not a permitted type." }, { "code": "hk_office_invalid", "type": null, "when": "[requirement_error] The office is outside Hong Kong, c/o or a PO box." }, { "code": "deregistration_overdue", "type": null, "when": "[registry_error] The 60-day period has run without evidence or an extension; the name may be struck off the LPF Register." } ] } }, "Params_hk_non_hk_company_register": { "type": "object", "properties": { "home_company_name": { "type": "string", "description": "Domestic name as registered at its place of incorporation." }, "place_of_incorporation": { "type": "string", "description": "Jurisdiction where it is incorporated and registered (s.774)." }, "home_registration_number": { "type": "string", "description": "Number on the home registry." }, "home_entity_id": { "type": "string", "pattern": "^ent_", "description": "Existing Entiva entity for the foreign company." }, "additional_hk_name_en": { "type": "string", "description": "Optional certified-translation name to register in English." }, "additional_hk_name_zh": { "type": "string", "description": "Optional certified-translation name to register in Chinese." }, "place_of_business_established_on": { "type": "string", "format": "date", "description": "Date the Hong Kong place of business was established." }, "revocation_order_s820f": { "type": "boolean", "description": "True if re-registering after a revocation order under s.820F, which restarts the one-month period." }, "hk_principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal place of business in Hong Kong." }, "home_registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or equivalent in the place of incorporation." }, "home_principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal place of business there, if any." }, "contact_email": { "type": "string", "description": "Company email for CR communications." }, "contact_phone": { "type": "string", "description": "Hong Kong contact number, +852." }, "nature_of_business_code": { "type": "string", "description": "CR business nature category code." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Hong Kong resident natural person, solicitor corporation, firm of solicitors, CPA corporate practice or CPA firm." }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Secretary, if the company has one." }, "directors": { "type": "array", "items": {}, "description": "List of {person_or_entity_ref, capacity: director or alternate_director, alternate_for}." }, "constitution_documents": { "type": "array", "items": {}, "description": "document_ref list of the charter, statutes, memorandum, articles or other instruments, certified under s.775." }, "specified_certificates": { "type": "array", "items": {}, "description": "document_ref list of the certificate of incorporation and, if the domicile moved, the current registration certificate." }, "accounts_mode": { "type": "string", "enum": [ "accounts_delivered", "none_required_by_law", "incorporated_under_18_months" ], "description": "Latest published accounts delivered, or the Cap. 622J s.4/ statement that none exist." }, "accounts_document": { "type": "string", "pattern": "^doc_", "description": "Certified accounts when accounts_mode is accounts_delivered." }, "br_certificate_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "BR term to buy if the company has no BR number." } }, "required": [ "home_company_name", "place_of_incorporation", "home_registration_number", "place_of_business_established_on", "hk_principal_place_of_business", "home_registered_office", "contact_email", "contact_phone", "nature_of_business_code", "authorised_representative", "directors", "constitution_documents", "specified_certificates", "accounts_mode" ], "description": "A foreign company that establishes a place of business in Hong Kong registers within one month on Form NN1 with IRBR2, certified constitution, specified certificates and accounts. It must keep a Hong Kong authorized representative." }, "Create_hk_non_hk_company_register": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company.register" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nn1", "title": "Form NN1 application for registration as registered non-Hong Kong company", "source": "generated", "required": true }, { "key": "irbr2", "title": "Form IRBR2 notice to the Business Registration Office", "source": "generated", "required": true }, { "key": "constitution_certified", "title": "Certified copy of constitution", "source": "uploaded", "required": true }, { "key": "specified_certificate_certified", "title": "Certified copy of each specified certificate", "source": "uploaded", "required": true }, { "key": "accounts_certified", "title": "Certified latest published accounts", "source": "uploaded", "required": false }, { "key": "certified_translations", "title": "Certified translations of documents not in English or Chinese", "source": "uploaded", "required": false }, { "key": "authorised_representative_authorisation", "title": "Authorisation of the Hong Kong authorized representative", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution approving Hong Kong registration", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of Registration of Non-Hong Kong Company", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nn1", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "irbr2", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "constitution_certified", "signer_role": "other", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "authorised_representative_authorisation", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN1 with Form IRBR2", "channel": "online", "government_fee": { "amount": 1545, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "authorized_representative_ineligible", "type": null, "when": "[requirement_error] The named representative is not a Hong Kong resident natural person or an eligible solicitor or CPA body." }, { "code": "constitution_not_certified", "type": null, "when": "[requirement_error] A constitutional document or certificate is not certified under s.775." }, { "code": "translation_missing", "type": null, "when": "[requirement_error] A document is not in English or Chinese and has no certified translation." }, { "code": "accounts_statement_invalid", "type": null, "when": "[requirement_error] No accounts and the no-accounts statement does not fit the company." }, { "code": "name_not_registrable", "type": null, "when": "[registry_error] The name conflicts with Division 4 of Part 16 rules or the index." }, { "code": "registration_deadline_passed", "type": null, "when": "[requirement_error] More than one month has passed since the place of business was established." } ] } }, "Params_hk_open_ended_fund_company_continue_in": { "type": "object", "properties": { "current_fund_name": { "type": "string", "description": "Name of the fund company abroad." }, "place_of_incorporation": { "type": "string", "description": "Jurisdiction where it is registered on the application date." }, "foreign_registration_number": { "type": "string", "description": "Number on the home registry." }, "part16_registered": { "type": "boolean", "description": "True if it is already a registered non-HK company; that registration ends on the certificate date." }, "name_en": { "type": "string", "description": "English name ending in 'Open-ended Fund Company' or 'OFC'; the SFC approves it." }, "name_zh": { "type": "string", "description": "Chinese name ending in 開放式基金型公司." }, "instrument_of_incorporation": { "type": "string", "pattern": "^doc_", "description": "Copy of the instrument of incorporation, meeting s.112K SFO and rule 13 of the OFC Rules." }, "directors": { "type": "array", "items": {}, "description": "person_ref list of at least two first directors, all natural persons." }, "process_agent": { "type": "string", "pattern": "^per_", "description": "Required if a director is not resident in Hong Kong: a Hong Kong resident individual, a company, or a Hong Kong firm of solicitors or CPAs." }, "investment_manager": { "type": "string", "pattern": "^ent_", "description": "SFC-licensed or registered investment manager; prior SFC approval (rule 125)." }, "custodian": { "type": "string", "pattern": "^ent_", "description": "Custodian approved by the SFC (rule 114)." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Hong Kong address." }, "br_certificate_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "BR term to buy; applying is deemed a BR application under s.5A of the Business Registration Ordinance." } }, "required": [ "current_fund_name", "place_of_incorporation", "foreign_registration_number", "part16_registered", "instrument_of_incorporation", "directors", "investment_manager", "custodian", "registered_office" ], "description": "A corporate fund set up abroad applies to the SFC on Form OFCN1 with IRBR3. The SFC registers it, the Registrar issues a certificate of re-domiciliation, and within 60 days the fund must deregister abroad and give the SFC evidence." }, "Create_hk_open_ended_fund_company_continue_in": { "type": "object", "properties": { "type": { "const": "hk.open_ended_fund_company.continue_in" }, "params": { "$ref": "#/components/schemas/Params_hk_open_ended_fund_company_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-domicile a non-Hong Kong corporate fund as an OFC", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ofcn1", "title": "Form OFCN1 open-ended fund company re-domiciliation form", "source": "generated", "required": true }, { "key": "irbr3", "title": "Form IRBR3 notice to the Business Registration Office", "source": "generated", "required": true }, { "key": "instrument_of_incorporation", "title": "Instrument of incorporation", "source": "uploaded", "required": true }, { "key": "director_consents", "title": "Consent to act as director from every first director", "source": "generated", "required": true }, { "key": "sfc_approvals", "title": "SFC approvals for directors, investment manager and custodian", "source": "uploaded", "required": true }, { "key": "certificate_of_re_domiciliation_ofc", "title": "Certificate of Re-domiciliation of Open-ended Fund Company", "source": "registry_issued", "required": true }, { "key": "business_registration_certificate", "title": "Business Registration Certificate", "source": "registry_issued", "required": true }, { "key": "foreign_deregistration_evidence", "title": "Evidence of deregistration abroad, given to the SFC", "source": "uploaded", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity" }, { "role": "custodian", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "ofcn1", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "director_consents", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Securities and Futures Commission, then Companies Registry", "form": "Form OFCN1", "channel": "both", "government_fee": { "amount": 3034, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "directors_below_minimum", "type": null, "when": "[requirement_error] Fewer than two directors are listed." }, { "code": "body_corporate_director_not_allowed", "type": null, "when": "[requirement_error] A body corporate is listed as director." }, { "code": "sfc_approval_missing", "type": null, "when": "[requirement_error] SFC approval is not uploaded for a director, the investment manager or the custodian." }, { "code": "process_agent_missing", "type": null, "when": "[requirement_error] A director is not resident in Hong Kong and no process agent is named." }, { "code": "ofc_name_invalid", "type": null, "when": "[registry_error] The name lacks the required ending or the SFC will not approve it." }, { "code": "deregistration_overdue", "type": null, "when": "[registry_error] No deregistration evidence within 60 days of the certificate." } ] } }, "Params_hk_place_of_incorporation_change": { "type": "object", "properties": { "place_of_incorporation": { "type": "string", "description": "Jurisdiction under whose law the company is now registered (s.774); ISO 3166 code, with subdivision if relevant." }, "effective_date": { "type": "string", "format": "date", "description": "Date the place of incorporation changed." }, "evidence_of_change": { "type": "string", "pattern": "^doc_", "description": "Certificate or registry extract from the new jurisdiction showing the continuation." }, "business_registration_number": { "type": "string", "description": "First 8 digits of the BR number." }, "presentor_reference": { "type": "string", "description": "Customer file reference." } }, "required": [ "place_of_incorporation", "effective_date", "evidence_of_change" ], "description": "A registered non-Hong Kong company that moves its domicile abroad delivers Form NN16 within one month. The return states the new place of incorporation and the date of change." }, "Create_hk_place_of_incorporation_change": { "type": "object", "properties": { "type": { "const": "hk.place_of_incorporation.change" }, "params": { "$ref": "#/components/schemas/Params_hk_place_of_incorporation_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report a change of place of incorporation of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nn16", "title": "Form NN16 return of change of place of incorporation", "source": "generated", "required": true }, { "key": "evidence_of_change", "title": "Home-registry evidence of the new place of incorporation", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board resolution noting the change and authorising the filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nn16", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN16", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is not a registered non-Hong Kong company." }, { "code": "evidence_missing", "type": null, "when": "[requirement_error] No home-registry evidence of the change is uploaded." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] More than one month has passed since the change." }, { "code": "name_mismatch", "type": null, "when": "[registry_error] The company name differs from the one on the last registration certificate." } ] } }, "Params_hk_redomiciliation_charge_register": { "type": "object", "properties": { "charge_basis": { "type": "string", "enum": [ "charge_created_before_re_domiciliation", "charge_on_property_acquired_before_re_domiciliation" ], "description": "s.338A charge created by the company, or s.338A property acquired subject to a charge." }, "instrument_type": { "type": "string", "description": "Nature of the instrument, for example Mortgage, Debenture, Floating Charge or Trust Deed." }, "instrument_date": { "type": "string", "format": "date", "description": "Date of the instrument creating or evidencing the charge." }, "certified_instrument": { "type": "string", "pattern": "^doc_", "description": "Certified copy of the instrument." }, "chargees": { "type": "array", "items": {}, "description": "List of {name, address, type}." }, "secured_amount": { "$ref": "#/components/schemas/Money", "description": "Amount secured, major units, as the form requires." }, "property_charged": { "type": "string", "description": "Description of the property or undertaking charged." }, "acquisition_date": { "type": "string", "format": "date", "description": "Date property was acquired subject to the charge." }, "commission_paid": { "type": "boolean", "description": "True if commission, allowance or discount was paid on subscriptions for debentures; its particulars are then added." }, "debenture_series": { "type": "boolean", "description": "True if the charge sits in a series of debentures; the form becomes NM8 or NM9 under EC 4/2025." }, "previously_registered_as_part16": { "type": "boolean", "description": "True if the charge was already registered while the company was a registered non-HK company; then NM10 is not needed." } }, "required": [ "charge_basis", "instrument_type", "instrument_date", "certified_instrument", "chargees", "previously_registered_as_part16" ], "description": "A re-domiciled company registers each charge created before re-domiciliation, or existing on property acquired before it, within one month after the re-domiciliation date, using Form NM10 with a certified copy of the instrument." }, "Create_hk_redomiciliation_charge_register": { "type": "object", "properties": { "type": { "const": "hk.redomiciliation_charge.register" }, "params": { "$ref": "#/components/schemas/Params_hk_redomiciliation_charge_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a pre-re-domiciliation charge", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nm10", "title": "Form NM10 statement of particulars of charge", "source": "generated", "required": true }, { "key": "certified_instrument", "title": "Certified copy of the instrument creating or evidencing the charge", "source": "uploaded", "required": true }, { "key": "acquisition_document", "title": "Document evidencing the acquisition", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified translation if the instrument is not in English or Chinese", "source": "uploaded", "required": false }, { "key": "registered_charge", "title": "Registered charge entry", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nm10", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_instrument", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NM10", "channel": "online", "government_fee": { "amount": 340, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "charge_already_registered", "type": null, "when": "[invalid_request_error] The charge was already registered under ss.336, 339 or 340 while a Part 16 company; NM10 is not required." }, { "code": "wrong_form", "type": null, "when": "[requirement_error] A Part 16 charge still unregistered at re-domiciliation needs Form NM1, not NM10." }, { "code": "instrument_not_certified", "type": null, "when": "[requirement_error] The instrument copy is not certified by an eligible person." }, { "code": "registration_period_missed", "type": null, "when": "[registry_error] The one-month period has passed; only a court extension order allows late delivery." }, { "code": "entity_not_redomiciled", "type": null, "when": "[requirement_error] The entity has no certificate of re-domiciliation." } ] } }, "Params_hk_redomiciliation_deregistration_evidence_file": { "type": "object", "properties": { "place_of_incorporation": { "type": "string", "description": "Jurisdiction the company has left." }, "deregistration_date": { "type": "string", "format": "date", "description": "Date the deregistration took effect abroad." }, "evidence_document": { "type": "string", "pattern": "^doc_", "description": "Home-registry certificate or equivalent evidencing deregistration; certified copy if a copy is sent." }, "foreign_counsel_confirmation": { "type": "string", "pattern": "^doc_", "description": "Letter from home-law counsel that the deregistration is complete." }, "certified_translation": { "type": "string", "pattern": "^doc_", "description": "Certified translation if the evidence is not in English or Chinese." } }, "required": [ "place_of_incorporation", "deregistration_date", "evidence_document" ], "description": "Within 120 days after the re-domiciliation date, the company submits a document evidencing deregistration in its place of incorporation, to the Registrar's satisfaction. No specified form exists." }, "Create_hk_redomiciliation_deregistration_evidence_file": { "type": "object", "properties": { "type": { "const": "hk.redomiciliation_deregistration_evidence.file" }, "params": { "$ref": "#/components/schemas/Params_hk_redomiciliation_deregistration_evidence_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File evidence of deregistration abroad for a re-domiciled company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence_document", "title": "Evidence of deregistration in the place of incorporation", "source": "uploaded", "required": true }, { "key": "foreign_counsel_confirmation", "title": "Home-law counsel confirmation", "source": "uploaded", "required": false }, { "key": "cover_statement", "title": "Cover statement to the Registrar", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cover_statement", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "evidence_document", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "No specified form", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_redomiciled", "type": null, "when": "[requirement_error] The entity has no certificate of re-domiciliation." }, { "code": "evidence_insufficient", "type": null, "when": "[registry_error] The Registrar is not satisfied the evidence shows deregistration." }, { "code": "period_expired", "type": null, "when": "[registry_error] The 120 days have passed with no extension; a s.820F revocation order may issue." }, { "code": "translation_missing", "type": null, "when": "[requirement_error] The evidence is not in English or Chinese and has no certified translation." } ] } }, "Params_hk_redomiciliation_deregistration_period_extend": { "type": "object", "properties": { "requested_new_deadline": { "type": "string", "format": "date", "description": "Date by which deregistration abroad will be complete." }, "reason": { "type": "string", "description": "Why deregistration is delayed, for example a pending home-registry procedure." }, "progress_evidence": { "type": "string", "pattern": "^doc_", "description": "Home-registry correspondence or counsel letter showing the steps taken." }, "conditions_acknowledged": { "type": "boolean", "description": "The company accepts it may be given conditions on the extension." } }, "required": [ "requested_new_deadline", "reason", "conditions_acknowledged" ], "description": "A re-domiciled company that cannot deregister abroad within 120 days applies to the Registrar under s.820E for an extension, which the Registrar may grant on conditions." }, "Create_hk_redomiciliation_deregistration_period_extend": { "type": "object", "properties": { "type": { "const": "hk.redomiciliation_deregistration_period.extend" }, "params": { "$ref": "#/components/schemas/Params_hk_redomiciliation_deregistration_period_extend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Ask the Registrar to extend the 120-day deregistration period", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_application", "title": "Application to extend the s.820E period", "source": "generated", "required": true }, { "key": "progress_evidence", "title": "Evidence of progress abroad", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_application", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Application under s.820E", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_redomiciled", "type": null, "when": "[requirement_error] The entity has no certificate of re-domiciliation." }, { "code": "period_already_expired", "type": null, "when": "[registry_error] The period has run and a revocation order may already have been made." }, { "code": "extension_refused", "type": null, "when": "[registry_error] The Registrar declined the extension or set conditions the company did not accept." } ] } }, "Params_hk_redomiciliation_director_consent_file": { "type": "object", "properties": { "directors": { "type": "array", "items": {}, "description": "List of {person_or_entity_ref, director_type: natural_person or body_corporate, signatory_full_name, signatory_capacity}." }, "certificate_number": { "type": "string", "description": "The 'No.' on the Certificate of Re-domiciliation." } }, "required": [ "directors" ], "description": "A person who consented to be a director on re-domiciliation but did not sign the consent inside Form NNC6 files Form NNC3RD within 15 days after the re-domiciliation date. One form per director." }, "Create_hk_redomiciliation_director_consent_file": { "type": "object", "properties": { "type": { "const": "hk.redomiciliation_director_consent.file" }, "params": { "$ref": "#/components/schemas/Params_hk_redomiciliation_director_consent_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a director's consent for a re-domiciled company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nnc3rd", "title": "Form NNC3RD consent to be a director, one per director", "source": "generated", "required": true }, { "key": "registered_nnc3rd", "title": "Registered NNC3RD", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "nnc3rd", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NNC3RD", "channel": "online", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "consent_already_in_nnc6", "type": null, "when": "[invalid_request_error] The director already signed the consent inside Form NNC6." }, { "code": "agent_cannot_sign", "type": null, "when": "[permission_error] An agent tried to sign a consent for a director." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] More than 15 days have passed since the re-domiciliation date." }, { "code": "cr_account_missing", "type": null, "when": "[requirement_error] The director has no CR Individual User account and has not used the paper route." } ] } }, "Params_hk_redomiciliation_members_return_file": { "type": "object", "properties": { "re_domiciliation_date": { "type": "string", "format": "date", "description": "Date on the Certificate of Re-domiciliation." }, "company_type": { "type": "string", "enum": [ "public_limited_by_shares", "private_limited_by_shares", "public_unlimited_with_share_capital", "private_unlimited_with_share_capital" ], "description": "Type of the re-domiciled company." }, "is_listed": { "type": "boolean", "description": "If true, only members holding at least 5% of any class go in Schedule 2." }, "members": { "type": "array", "items": {}, "description": "List of {name, address, class, number_of_shares, jointly_held, joint_holders, percentage_of_class}." }, "members_file": { "type": "string", "pattern": "^doc_", "description": "Excel file in the CR-specified layout, used instead of the list for large registers." }, "statement_of_capital": { "type": "array", "items": {}, "description": "List of {class, currency, total_number, total_amount, paid_up, unpaid}, complying with s.201." } }, "required": [ "re_domiciliation_date", "company_type", "is_listed", "members", "statement_of_capital" ], "description": "Within 15 days after the re-domiciliation date, the re-domiciled company delivers Form NSC21 with its members and a statement of capital as at that date." }, "Create_hk_redomiciliation_members_return_file": { "type": "object", "properties": { "type": { "const": "hk.redomiciliation_members_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_redomiciliation_members_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the return of members of a re-domiciled company", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nsc21", "title": "Form NSC21 return of particulars of members of re-domiciled company", "source": "generated", "required": true }, { "key": "register_of_members_extract", "title": "Register of members as at the re-domiciliation date", "source": "generated", "required": true }, { "key": "registered_nsc21", "title": "Registered NSC21", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nsc21", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NSC21", "channel": "online", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_redomiciled", "type": null, "when": "[requirement_error] The entity has no certificate of re-domiciliation." }, { "code": "class_totals_mismatch", "type": null, "when": "[requirement_error] Shares per class in the member list differ from the statement of capital." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] More than 15 days have passed since the re-domiciliation date." } ] } }, "Params_hk_scheme_of_arrangement_apply": { "type": "object", "properties": { "scheme_type": { "type": "string", "enum": [ "members", "creditors", "members_and_creditors" ], "description": "Who the scheme binds." }, "applicant_role": { "type": "string", "enum": [ "company", "creditor", "member", "liquidator", "provisional_liquidator" ], "description": "Who applies." }, "company_in_winding_up": { "type": "boolean", "description": "True if the company is being wound up." }, "purpose": { "type": "string", "description": "Commercial purpose, for example debt restructuring or a reorganisation of share capital." }, "scheme_document": { "type": "string", "pattern": "^doc_", "description": "The proposed scheme." }, "explanatory_statement": { "type": "string", "pattern": "^doc_", "description": "Statement explaining the scheme to those who vote." }, "classes": { "type": "array", "items": {}, "description": "List of {class_name, holders_description, rights_summary} for the members or creditors who vote in separate classes." }, "amends_articles": { "type": "boolean", "description": "True if the scheme will amend articles or need resolutions that must go to the Registrar with the order (s.673)." }, "is_listed": { "type": "boolean", "description": "True if the company is listed; extra regulator involvement then applies." }, "instructed_law_firm": { "type": "string", "pattern": "^ent_", "description": "Hong Kong solicitors on the record." }, "target_hearing_window": { "type": "string", "description": "Earliest and latest acceptable hearing dates." } }, "required": [ "scheme_type", "applicant_role", "company_in_winding_up", "purpose", "scheme_document", "explanatory_statement", "classes", "amends_articles", "is_listed" ], "description": "Entiva coordinates a Hong Kong law firm that applies to the High Court under s.673 for a scheme of arrangement or compromise with members or creditors. Court proceedings are outside the Electronic Transactions Ordinance, so the." }, "Create_hk_scheme_of_arrangement_apply": { "type": "object", "properties": { "type": { "const": "hk.scheme_of_arrangement.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_scheme_of_arrangement_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the High Court to sanction a scheme of arrangement", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "originating_process", "title": "Originating process for the s.673 application", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Affidavit in support", "source": "generated", "required": true }, { "key": "scheme_document", "title": "Scheme of arrangement", "source": "uploaded", "required": true }, { "key": "explanatory_statement", "title": "Explanatory statement", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board resolution proposing the scheme", "source": "generated", "required": true }, { "key": "notice_of_meeting", "title": "Notice of the court-convened meetings", "source": "generated", "required": true }, { "key": "meeting_results_report", "title": "Chairman's report on the meetings", "source": "generated", "required": true }, { "key": "sanction_order", "title": "Sanction order", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "supporting_affidavit", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "originating_process", "signer_role": "lawyer", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_meeting", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court of Hong Kong", "form": "Court application under s.673 Cap. 622", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "law_firm_required", "type": null, "when": "[requirement_error] No Hong Kong solicitors are instructed; the court application needs them." }, { "code": "applicant_not_permitted", "type": null, "when": "[requirement_error] The applicant is a company, creditor or member while the company is in winding up." }, { "code": "classes_undefined", "type": null, "when": "[requirement_error] No voting classes are defined for the meetings." }, { "code": "affidavit_not_sworn", "type": null, "when": "[requirement_error] The supporting affidavit has not been sworn before an authorised officer." }, { "code": "court_refused", "type": null, "when": "[registry_error] The Court declined to convene meetings or to sanction the scheme." } ] } }, "Params_hk_scheme_of_arrangement_order_register": { "type": "object", "properties": { "court_case_number": { "type": "string", "description": "High Court case number." }, "order_date": { "type": "string", "format": "date", "description": "Date the Court made the sanction order." }, "office_copy_of_order": { "type": "string", "pattern": "^doc_", "description": "Office copy of the sanction order." }, "order_amends_articles_or_resolutions": { "type": "boolean", "description": "True if the order amends articles or resolutions, which must then be delivered with it (s.673)." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "Articles as amended by the order." }, "resolutions": { "type": "array", "items": {}, "description": "document_ref list of resolutions amended or required by the order." }, "scheme_effective_date": { "type": "string", "format": "date", "description": "Date the scheme is intended to take effect after registration." } }, "required": [ "court_case_number", "order_date", "office_copy_of_order", "order_amends_articles_or_resolutions" ], "description": "After the Court sanctions a scheme, the office copy of the order is delivered to the Registrar with any amended articles or resolutions. The order has no effect until the Registrar registers it." }, "Create_hk_scheme_of_arrangement_order_register": { "type": "object", "properties": { "type": { "const": "hk.scheme_of_arrangement_order.register" }, "params": { "$ref": "#/components/schemas/Params_hk_scheme_of_arrangement_order_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a scheme sanction order with the Companies Registry", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "office_copy_of_order", "title": "Office copy of the sanction order", "source": "uploaded", "required": true }, { "key": "amended_articles", "title": "Amended articles", "source": "uploaded", "required": false }, { "key": "resolutions", "title": "Amended resolutions", "source": "uploaded", "required": false }, { "key": "cover_letter", "title": "Cover letter to the Registrar", "source": "generated", "required": true }, { "key": "registered_order", "title": "Registered order on the public record", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cover_letter", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "office_copy_of_order", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Office copy of the sanction order with amended articles or resolutions", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "amended_documents_missing", "type": null, "when": "[requirement_error] The order amends articles or resolutions but they are not attached; the company and responsible persons risk a level 3 fine (s.673)." }, { "code": "order_not_office_copy", "type": null, "when": "[requirement_error] The uploaded order is not an office copy." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The Registrar rejected the delivery." } ] } }, "Params_hk_unlimited_company_convert_to_limited": { "type": "object", "properties": { "resolution_date": { "type": "string", "format": "date", "description": "Date the s.130 special resolution is passed." }, "name_after_reregistration_en": { "type": "string", "description": "English name ending in 'Limited' as set in the resolution." }, "name_after_reregistration_zh": { "type": "string", "description": "Chinese name ending in 有限公司 as set in the resolution." }, "share_capital": { "type": "array", "items": {}, "description": "List of {class, currency, total_issued_shares, total_subscribed_amount, total_paid_up}." }, "amended_articles": { "type": "string", "pattern": "^doc_", "description": "Articles as proposed to be altered by the resolution; s.131 requires a copy with the application." }, "resolution_copy_registered_on": { "type": "string", "format": "date", "description": "Date the Registrar received the s.622 resolution copy." }, "presentor_reference": { "type": "string", "description": "Customer file reference for the Presentor's Reference box." } }, "required": [ "resolution_date", "share_capital", "amended_articles" ], "description": "An unlimited company passes a special resolution under s.130, has the copy registered under s.622, then applies on Form NU1 under s.131 with the proposed articles. The Registrar issues a certificate of incorporation as a company limited by." }, "Create_hk_unlimited_company_convert_to_limited": { "type": "object", "properties": { "type": { "const": "hk.unlimited_company.convert_to_limited" }, "params": { "$ref": "#/components/schemas/Params_hk_unlimited_company_convert_to_limited" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register an unlimited company as a company limited by shares", "x-entiva": { "jurisdiction": "hk", "stage": "restructuring", "applies_to": [ "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing re-registration", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution under s.130 with statement of share capital", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as proposed to be altered", "source": "uploaded", "required": true }, { "key": "nu1", "title": "Form NU1 application for re-registration as company limited by shares", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation as a company limited by shares", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nu1", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Special resolution copy", "channel": "online", "government_fee": { "amount": 1545, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is not an unlimited company with a share capital." }, { "code": "resolution_not_registered", "type": null, "when": "[requirement_error] NU1 was prepared before the Registrar received the s.622 resolution copy." }, { "code": "share_capital_mismatch", "type": null, "when": "[requirement_error] The share capital figures differ from the statement in the special resolution." }, { "code": "limited_name_missing", "type": null, "when": "[requirement_error] Neither name after re-registration ends in 'Limited' or 有限公司." }, { "code": "amended_articles_missing", "type": null, "when": "[requirement_error] No copy of the proposed articles is attached." }, { "code": "special_resolution_not_passed", "type": null, "when": "[requirement_error] The members' special resolution has not reached 75%." } ] } }, "Params_hk_business_registration_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership", "lp", "lpf" ], "description": "limited_partnership_fund covers the notice after LPF dissolution or deregistration." }, "br_number": { "type": "string", "description": "Business registration number." }, "effective_date": { "type": "string", "format": "date", "description": "Business ceased, or LPF dissolved or deregistered; the 1 month runs from it." }, "notifier": { "type": "string", "pattern": "^per_", "description": "Owner or partner; for an LPF the general partner, representative or investment manager." }, "post_cessation_address": { "$ref": "#/components/schemas/Address", "description": "Correspondence address after closure." }, "contact_phone": { "type": "string", "description": "Contact number." }, "continues_business_in_hk": { "type": "boolean", "description": "LPF only: continues as a partnership carrying on business." } }, "required": [ "entity_type", "br_number", "effective_date", "notifier", "post_cessation_address", "contact_phone" ], "description": "Tells the IRD Business Registration Office that a sole proprietorship, partnership or LPF has ceased business or closed, on Form IRC3113, in writing or through eTAX. Fee and levy stay payable through the year of cessation." }, "Create_hk_business_registration_cancel": { "type": "object", "properties": { "type": { "const": "hk.business_registration.cancel" }, "params": { "$ref": "#/components/schemas/Params_hk_business_registration_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a Hong Kong business registration", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "sole_proprietorship", "general_partnership", "lp", "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "br_cancellation_notice", "title": "Form IRC3113 or written notice", "source": "generated", "required": true }, { "key": "closure_evidence", "title": "Evidence of cessation; LPF8 acknowledgement or Gazette deregistration notice", "source": "uploaded", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "br_cancellation_notice", "signer_role": "shareholder", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "br_cancellation_notice", "signer_role": "shareholder", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "IRC3113 or written notice", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_missed", "type": null, "when": "More than 1 month since cessation." }, { "code": "br_number_unknown", "type": null, "when": "Number does not match IRD records." }, { "code": "closure_not_recorded", "type": null, "when": "LPF without LPF8 acknowledgement or Gazette deregistration notice on record." } ] } }, "Params_hk_company_deregister": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "guarantee_company" ], "description": "Private and guarantee companies; public and s.749 companies are excluded." }, "applicant_capacity": { "type": "string", "enum": [ "company", "director", "member" ], "description": "Who applies on NDR1 (s.750)." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The director or member applying; signs NDR1 personally." }, "nominated_notice_recipient": { "type": "string", "pattern": "^per_", "description": "Natural person to receive notice; required if the company applies (s.750)." }, "conditions": { "type": "object", "description": "All true: all_members_agree, no_operation_in_last_3_months, no_outstanding_liabilities, not_party_to_legal_proceedings, no_hk_immovable_property." }, "assets_disposed_confirmed": { "type": "boolean", "description": "All property, including bank balances, is disposed of; it vests in the Government on dissolution (NDR1 note 3)." }, "ird_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Existing IRD notice; omit and Entiva applies." }, "records_custody": { "type": "string", "enum": [ "entiva_custody", "director_custody" ], "description": "Who keeps books and papers 6 years after dissolution." } }, "required": [ "entity_type", "applicant_capacity", "nominated_notice_recipient", "conditions", "assets_disposed_confirmed", "records_custody" ], "description": "Voluntary dissolution of a defunct solvent private or guarantee company. Entiva obtains the IRD Notice of No Objection, then delivers Form NDR1 within 3 months." }, "Create_hk_company_deregister": { "type": "object", "properties": { "type": { "const": "hk.company.deregister" }, "params": { "$ref": "#/components/schemas/Params_hk_company_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a defunct solvent Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "guarantee_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "members_agreement", "title": "Written agreement of all members (s.750)", "source": "generated", "required": true }, { "key": "conditions_confirmation", "title": "Director's confirmation of the s.750 conditions", "source": "generated", "required": true }, { "key": "asset_disposal_evidence", "title": "Closing bank statement or other evidence assets are disposed of", "source": "uploaded", "required": true }, { "key": "ird_ir1263_application", "title": "IRD Form IR1263", "source": "generated", "required": false }, { "key": "ird_notice_of_no_objection", "title": "IRD Notice of No Objection", "source": "registry_issued", "required": true }, { "key": "ndr1_form", "title": "Form NDR1 with certified copy of the IRD notice", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "appointee", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_agreement", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "conditions_confirmation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ird_ir1263_application", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ndr1_form", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ndr1_form", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "IR1263, then NDR1 Application for Deregistration of Private Company or Company Limited", "channel": "both", "government_fee": { "amount": 690, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "company_type_excluded", "type": null, "when": "Public company or s.749 company." }, { "code": "members_not_unanimous", "type": null, "when": "A member has not agreed." }, { "code": "conditions_not_met", "type": null, "when": "Recent trading, liabilities, proceedings, Hong Kong property or unfiled returns." }, { "code": "ird_notice_stale", "type": null, "when": "More than 3 months since the IRD notice; reapply." } ] } }, "Params_hk_company_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "description": "Entity type; registered_non_hk_company uses ss.799-801, the others ss.760-762." }, "struck_off_date": { "type": "string", "format": "date", "description": "Date of the Gazette strike-off notice; the 20 or 6 years run from it." }, "strike_off_route": { "type": "string", "enum": [ "s746", "s747", "predecessor_s291", "s798" ], "description": "Only Registrar strike-offs qualify; deregistered or wound-up companies need the court route." }, "applicant": { "type": "string", "pattern": "^per_", "description": "A director or member." }, "applicant_capacity": { "type": "string", "enum": [ "director", "member" ], "description": "Capacity of the applicant." }, "authorisation_basis": { "type": "string", "enum": [ "sole_member", "all_members_authorised", "not_all_members_authorised" ], "description": "Sole member; all members authorise in writing; or not all can be obtained." }, "operating_at_strike_off": { "type": "boolean", "description": "Local: in operation when struck off (s.761)." }, "place_of_business_confirmed": { "type": "boolean", "description": "Non-Hong Kong: Hong Kong place of business now and within the prior 6 months (s.800)." }, "hk_property_vested_in_government": { "type": "boolean", "description": "Local: if true, a land search and the Government's no-objection are needed (s.761)." }, "catch_up_filings": { "type": "object", "description": "annual_return_years and whether address, officer or other change notices are needed." }, "government_costs_acknowledged": { "type": "boolean", "description": "Local: applicant will pay Government costs (s.761)." } }, "required": [ "entity_type", "struck_off_date", "strike_off_route", "applicant", "applicant_capacity", "authorisation_basis", "catch_up_filings" ], "description": "A director or member applies to the Registrar to restore a company whose name was struck off by the Registrar. Local companies: struck off under Cap. 622 s.746 or s.747, application within 20 years of dissolution." }, "Create_hk_company_restore": { "type": "object", "properties": { "type": { "const": "hk.company.restore" }, "params": { "$ref": "#/components/schemas/Params_hk_company_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off Hong Kong company administratively", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restoration_application", "title": "Application for Administrative Restoration of a Local Company or Non-Hong Kong Company, with.", "source": "generated", "required": true }, { "key": "member_authorisations", "title": "Members' written authorisations, certified by the applicant or a Hong Kong solicitor", "source": "generated", "required": false }, { "key": "land_search_record", "title": "Land Registry search record", "source": "uploaded", "required": false }, { "key": "place_of_business_evidence", "title": "Evidence of the Hong Kong place of business", "source": "uploaded", "required": false }, { "key": "catch_up_filings_pack", "title": "Outstanding NAR1 returns with accounts; NR1, ND2A, ND2B as needed", "source": "generated", "required": true }, { "key": "cr_decision", "title": "Registrar's decision and Gazette restoration notice", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "restoration_application", "signer_role": "applicant", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "member_authorisations", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "catch_up_filings_pack", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Application for Administrative Restoration of a Local Company", "channel": "paper", "government_fee": { "amount": 2700, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_struck_off_by_registrar", "type": null, "when": "Dissolved by deregistration or winding up; use the court route." }, { "code": "window_closed", "type": null, "when": "More than 20 years or 6 years since striking off." }, { "code": "condition_not_met", "type": null, "when": "Not operating when struck off, no Hong Kong place of business, or catch-up filings missing." } ] } }, "Params_hk_company_restoration_court_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Taken from the entity when omitted." }, "dissolution_basis": { "type": "string", "enum": [ "deregistered", "struck_off_by_registrar", "struck_off_by_court", "predecessor_struck_off", "predecessor_deregistered" ], "description": "How the company was dissolved. deregistered = s.751; struck_off_by_registrar = s.746 or s.747; struck_off_by_court = s.748; predecessor_* = ss.291, 291A or." }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The applicant: a former director, member or creditor, or another person with an interest including the Government (s.765); a person who feels aggrieved for." }, "applicant_capacity": { "type": "string", "enum": [ "former_director", "former_member", "former_creditor", "other_interested_person", "aggrieved_person_predecessor_ordinance" ], "description": "Standing relied on." }, "grounds": { "type": "array", "items": {}, "description": "Grounds for the Court." }, "unmet_deregistration_conditions": { "type": "array", "items": {}, "description": "For a deregistered company, which s.750 conditions were not met when it applied." }, "statement_of_facts": { "type": "string", "description": "Facts supporting the application, used to draft the supporting affidavit." }, "personal_injury_claim_purpose": { "type": "boolean", "description": "True if the purpose is to bring proceedings for damages for personal injury." }, "registrar_refused_administrative_restoration": { "type": "boolean", "description": "True if the Registrar refused an application under s.760." }, "registrar_refusal_date": { "type": "string", "format": "date", "description": "Date the Registrar notified the refusal under s.762." }, "bona_vacantia_property_known": { "type": "boolean", "description": "True if property or rights of the company vested in the Government as bona vacantia." }, "directions_sought": { "type": "string", "description": "Directions the applicant will ask for under s.768,: delivery of documents to update the Registrar's records, payment of the Registrar's or the Government's." } }, "required": [ "dissolution_basis", "dissolution_date", "applicant", "applicant_capacity", "grounds", "statement_of_facts" ], "description": "Prepares and presents, through Entiva's Hong Kong solicitor partner, an application to the Court of First Instance under Cap. 622 s.765 to restore a company dissolved by deregistration or striking off, including dissolutions under the." }, "Create_hk_company_restoration_court_apply": { "type": "object", "properties": { "type": { "const": "hk.company_restoration_court.apply" }, "params": { "$ref": "#/components/schemas/Params_hk_company_restoration_court_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the court to restore a deregistered or struck-off company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "company_search_report", "title": "Companies Registry search showing the dissolution", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "uploaded", "required": false }, { "key": "evidence_of_applicant_interest", "title": "Evidence of the applicant's standing", "source": "uploaded", "required": true }, { "key": "registrar_refusal_notice", "title": "Registrar's notice refusing administrative restoration", "source": "uploaded", "required": false }, { "key": "draft_court_application", "title": "Draft originating application under s.765", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Supporting affidavit", "source": "generated", "required": true }, { "key": "solicitor_engagement_letter", "title": "Solicitor engagement and authority letter", "source": "generated", "required": true }, { "key": "records_update_pack", "title": "Outstanding annual returns and filings needed to bring the records up to date", "source": "generated", "required": false }, { "key": "restoration_order", "title": "Sealed court order restoring the company", "source": "uploaded", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" }, { "role": "declarant", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "solicitor_engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "draft_court_application", "signer_role": "filing_agent", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court of the HKSAR", "form": "Application to the Court of First Instance under Cap. 622 s.765", "channel": "paper", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_dissolved", "type": null, "when": "The entity is not in a dissolved or struck-off state." }, { "code": "wrong_restoration_route", "type": null, "when": "The company was dissolved after a winding up, so s.765 does not apply and Cap. 32 s.290 is the route." }, { "code": "limitation_period_expired", "type": null, "when": "More than 20 years have passed and no s.766 or s.766 exception applies." }, { "code": "applicant_standing_not_shown", "type": null, "when": "The applicant's capacity under s.765 is not supported by the evidence." } ] } }, "Params_hk_company_restoration_court_order_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Taken from the entity when omitted." }, "court_action_number": { "type": "string", "description": "Court action number on the order." }, "court_order_date": { "type": "string", "format": "date", "description": "Date of the order." }, "records_update_directions": { "type": "string", "description": "Documents the Court directed to be delivered to bring the Registrar's records up to date (s.768), for example outstanding annual returns." }, "registrar_costs_ordered": { "$ref": "#/components/schemas/Money", "description": "Registrar's costs the Court ordered the applicant to pay (s.768)." }, "government_costs_ordered": { "$ref": "#/components/schemas/Money", "description": "Government's costs, expenses and liabilities for property vested under s.752, if ordered (s.768)." }, "outstanding_return_dates": { "type": "array", "items": {}, "description": "Return dates of annual returns Entiva should prepare for the records update." } }, "required": [ "court_action_number", "court_order_date" ], "description": "Delivers an office copy of the Court's restoration order to the Companies Registry. The company is restored on registration (Cap. 622 s.767) and the Registrar gazettes the restoration (s.767)." }, "Create_hk_company_restoration_court_order_register": { "type": "object", "properties": { "type": { "const": "hk.company_restoration_court_order.register" }, "params": { "$ref": "#/components/schemas/Params_hk_company_restoration_court_order_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register the court order restoring a company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restoration_order", "title": "Office copy of the Court's order", "source": "uploaded", "required": true }, { "key": "records_update_pack", "title": "Documents bringing the records up to date", "source": "generated", "required": false }, { "key": "gazette_notice_of_restoration", "title": "Gazette notice of restoration", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [], "filing": { "registry": "Companies Registry", "form": "Office copy of the Court's order", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "office_copy_required", "type": null, "when": "The uploaded order is not an office copy." }, { "code": "records_not_up_to_date", "type": null, "when": "The Registrar will not register until the documents the Court directed are delivered." }, { "code": "entity_not_dissolved", "type": null, "when": "The entity is not in a dissolved or struck-off state." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_court_winding_up_petition": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company", "lp" ], "description": "Taken from the entity when omitted." }, "petitioner_type": { "type": "string", "enum": [ "company", "creditor", "contributory", "trustee_in_bankruptcy_or_personal_representative", "official_receiver", "registrar_of_companies", "financial_secretary" ], "description": "Who presents." }, "petitioner": { "type": "string", "pattern": "^per_", "description": "The petitioner." }, "ground": { "type": "string", "enum": [ "company_special_resolution", "business_not_commenced_or_suspended_1_year", "no_members", "unable_to_pay_debts", "articles_dissolution_event", "just_and_equitable", "registrar_application", "unregistered_dissolved_or_ceased_business", "unregistered_unable_to_pay_debts", "unregistered_just_and_equitable" ], "description": "Ground under s.177 to in that order, s.177, or s.327 for a registered non-Hong Kong company or OFC." }, "inability_to_pay_basis": { "type": "string", "enum": [ "statutory_demand_unpaid_3_weeks", "execution_returned_unsatisfied", "proved_to_court", "member_action_unpaid_10_days" ], "description": "How inability to pay debts is shown (s.178): demand of at least HK$10,000 unpaid for 3 weeks, execution returned unsatisfied, or proof to the court.." }, "statutory_demand_date": { "type": "string", "format": "date", "description": "Date the statutory demand was served." }, "debt_amount": { "$ref": "#/components/schemas/Money", "description": "Amount of the debt relied on (at least HK$10,000 for a statutory demand, s.178)." }, "company_resolution_date": { "type": "string", "format": "date", "description": "Date of the board resolution authorising the petition, or of the special resolution for ground, when the company is petitioner." }, "seek_provisional_liquidator": { "type": "boolean", "description": "Whether to ask the court to appoint a provisional liquidator before the hearing." }, "proposed_provisional_liquidator": { "type": "string", "pattern": "^per_", "description": "Natural person proposed as provisional liquidator, with a disclosure statement." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Registered office, or if none the principal or last known principal place of business, where the sealed petition is delivered." } }, "required": [ "petitioner_type", "petitioner", "ground", "service_address" ], "description": "Prepares and presents, through Entiva's Hong Kong Entiva, a winding-up petition in the Court of First Instance under Cap. 32. Covers the Official Receiver's deposit, copies to the Official Receiver within 24 hours, the verifying." }, "Create_hk_court_winding_up_petition": { "type": "object", "properties": { "type": { "const": "hk.court_winding_up.petition" }, "params": { "$ref": "#/components/schemas/Params_hk_court_winding_up_petition" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Petition the court to wind up a company, partnership or fund company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "draft_petition", "title": "Petition", "source": "generated", "required": true }, { "key": "verifying_affidavit", "title": "Verifying affidavit", "source": "generated", "required": true }, { "key": "statutory_demand", "title": "Statutory demand and proof of service", "source": "uploaded", "required": false }, { "key": "evidence_of_debt", "title": "Evidence of the debt", "source": "uploaded", "required": false }, { "key": "company_authorisation", "title": "Board resolution or special resolution authorising the petition", "source": "generated", "required": false }, { "key": "official_receiver_deposit_receipt", "title": "Official Receiver's receipt for the HK$11,250 deposit", "source": "uploaded", "required": true }, { "key": "advertisement", "title": "Advertisement of petition", "source": "generated", "required": true }, { "key": "provisional_liquidator_consent", "title": "Proposed provisional liquidator's consent and disclosure statement", "source": "uploaded", "required": false }, { "key": "solicitor_engagement_letter", "title": "Solicitor engagement and authority letter", "source": "generated", "required": true }, { "key": "winding_up_order", "title": "Sealed winding-up order", "source": "uploaded", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" }, { "role": "declarant", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "solicitor_engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "company_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "draft_petition", "signer_role": "filing_agent", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "verifying_affidavit", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "High Court of the HKSAR", "form": "Petition in Form 2 or 3 with verifying affidavit in Form 7 or 8", "channel": "paper", "government_fee": { "amount": 12295, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "petitioner_not_eligible", "type": null, "when": "A contributory does not meet the 6-in-18-months holding test, or the petitioner type does not fit the ground." }, { "code": "debt_below_threshold", "type": null, "when": "The demanded debt is below the specified amount of HK$10,000 (s.178)." }, { "code": "official_receiver_deposit_missing", "type": null, "when": "The HK$11,250 deposit receipt is not on file (r.22A)." }, { "code": "affidavit_deadline_missed", "type": null, "when": "The verifying affidavit was not filed within 4 days of presentation." }, { "code": "advertisement_too_late", "type": null, "when": "Advertisement is less than 7 clear days before the hearing; the hearing appointment is cancelled and the petition removed." } ] } }, "Params_hk_court_winding_up_statement_of_affairs_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company", "lp" ], "description": "Taken from the entity when omitted." }, "relevant_date": { "type": "string", "format": "date", "description": "Date of the provisional liquidator's appointment or of the winding-up order, whichever applies." }, "recipient": { "type": "string", "enum": [ "official_receiver", "provisional_liquidator", "liquidator" ], "description": "Who receives the statement." }, "recipient_person": { "type": "string", "pattern": "^per_", "description": "The provisional liquidator or liquidator when not the Official Receiver." }, "statement_makers": { "type": "array", "items": {}, "description": "person_ref list: the directors at the relevant date and the company secretary, or those the liquidator requires (s.190): officers, formation participants." }, "non_concurring_persons": { "type": "array", "items": {}, "description": "Persons required to make a supplementary affidavit who do not concur; they may qualify it (s.190,)." }, "extension_requested_until": { "type": "string", "format": "date", "description": "Ask the liquidator or the court for more time for special reasons (s.190; r.40)." } }, "required": [ "relevant_date", "recipient", "statement_makers" ], "description": "After a winding-up order or the appointment of a provisional liquidator, the directors and company secretary make a statement of the company's affairs in Form 23, verified by affidavit, and submit it to the provisional liquidator or." }, "Create_hk_court_winding_up_statement_of_affairs_file": { "type": "object", "properties": { "type": { "const": "hk.court_winding_up_statement_of_affairs.file" }, "params": { "$ref": "#/components/schemas/Params_hk_court_winding_up_statement_of_affairs_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit the directors' statement of affairs after a winding-up order", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "statement_of_affairs_form_23", "title": "Statement of affairs, in duplicate", "source": "generated", "required": true }, { "key": "verifying_affidavit", "title": "Affidavit verifying one copy", "source": "generated", "required": true }, { "key": "supplementary_affidavit", "title": "Supplementary affidavit of a person who concurs or qualifies", "source": "generated", "required": false }, { "key": "books_and_records", "title": "Books and records used to prepare the statement", "source": "uploaded", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_affairs_form_23", "signer_role": "other", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "verifying_affidavit", "signer_role": "other", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "supplementary_affidavit", "signer_role": "other", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Provisional liquidator or liquidator", "form": "Statement of affairs in Form 23, verified", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 28 days from the relevant date and no extension on file." }, { "code": "statement_incomplete", "type": null, "when": "Creditors, securities or dates required by s.190 are missing." }, { "code": "not_in_compulsory_liquidation", "type": null, "when": "No winding-up order or provisional liquidator is recorded." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_creditors_voluntary_winding_up_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Taken from the entity when omitted." }, "board_meeting_date": { "type": "string", "format": "date", "description": "Date of the directors' meeting that convenes the members' and creditors' meetings." }, "members_meeting_date": { "type": "string", "format": "date", "description": "General meeting at which the special resolution is proposed." }, "special_resolution_passed_date": { "type": "string", "format": "date", "description": "Set once the resolution is passed." }, "creditors_meeting_date": { "type": "string", "format": "date", "description": "Not later than 14 days after the members' meeting (s.241)." }, "presiding_director": { "type": "string", "pattern": "^per_", "description": "Director appointed to preside at the creditors' meeting; the duty to attend and preside is personal (s.241,)." }, "creditors": { "type": "array", "items": {}, "description": "Creditor list for the full statement of affairs (s.241 to)." }, "assets_and_liabilities": { "type": "object", "description": "Summary of the company's position: total_assets, total_liabilities, contingent_liabilities." }, "proposed_liquidators": { "type": "array", "items": {}, "description": "Natural persons to nominate." }, "liquidator_status": { "type": "string", "enum": [ "sole", "joint", "joint_and_several" ], "description": "How multiple liquidators act." }, "committee_of_inspection_proposed": { "type": "boolean", "description": "Whether the creditors will be asked to appoint a committee of inspection of 3 to 7 persons." }, "reason_for_winding_up": { "type": "string", "description": "Short reason recorded in the minutes and shown to creditors." } }, "required": [ "board_meeting_date", "members_meeting_date", "creditors_meeting_date", "presiding_director", "creditors", "assets_and_liabilities", "proposed_liquidators", "liquidator_status" ], "description": "Runs a Cap. 32 creditors' voluntary winding up from the directors' decision to the nomination of the liquidator: members' special resolution to wind up with no certificate of solvency (ss.228, 233), creditors' meeting within 14 days with." }, "Create_hk_creditors_voluntary_winding_up_commence": { "type": "object", "properties": { "type": { "const": "hk.creditors_voluntary_winding_up.commence" }, "params": { "$ref": "#/components/schemas/Params_hk_creditors_voluntary_winding_up_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Commence a creditors' voluntary winding up", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution convening the meetings and appointing the presiding director", "source": "generated", "required": true }, { "key": "notice_of_general_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution to wind up voluntarily", "source": "generated", "required": true }, { "key": "notice_to_creditors", "title": "Notice of creditors' meeting", "source": "generated", "required": true }, { "key": "gazette_notice_creditors_meeting", "title": "Gazette notice of creditors' meeting, Chinese and English", "source": "generated", "required": true }, { "key": "statement_of_affairs", "title": "Full statement of the position of the company's affairs", "source": "generated", "required": true }, { "key": "liquidator_disclosure_statement", "title": "Proposed liquidator's disclosure statement", "source": "uploaded", "required": true }, { "key": "liquidator_consent", "title": "Proposed liquidator's consent to act", "source": "uploaded", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the members' and creditors' meetings", "source": "generated", "required": true }, { "key": "gazette_notice_resolution", "title": "Gazette notice of the resolution", "source": "generated", "required": true }, { "key": "ird_resolution_copy", "title": "Copy of the resolution for the IRD Business Registration Office", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_affairs", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "liquidator_disclosure_statement", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Copy of the special resolution", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "certificate_of_solvency_delivered", "type": null, "when": "An NW1 certificate of solvency was delivered; this is a members' voluntary winding up (s.233)." }, { "code": "creditors_meeting_too_late", "type": null, "when": "The creditors' meeting is more than 14 days after the members' meeting (s.241)." }, { "code": "creditors_notice_too_short", "type": null, "when": "Notices to creditors would go out less than 7 days before the meeting." }, { "code": "liquidator_disqualified", "type": null, "when": "A proposed liquidator is disqualified under s.262B." }, { "code": "disclosure_statement_missing", "type": null, "when": "A proposed liquidator has not made a disclosure statement." } ] } }, "Params_hk_creditors_voluntary_winding_up_complete": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Taken from the entity when omitted." }, "account_of_winding_up": { "type": "string", "pattern": "^doc_", "description": "Liquidator's account showing how the winding up was conducted and the property disposed of (s.248)." }, "notice_published_date": { "type": "string", "format": "date", "description": "Date the Gazette notice of both meetings was published; at least 1 month before the meetings (s.248)." }, "general_meeting_date": { "type": "string", "format": "date", "description": "General meeting of the company." }, "creditors_meeting_date": { "type": "string", "format": "date", "description": "Meeting of creditors; may be on the same day." }, "general_meeting_quorum_present": { "type": "boolean", "description": "False if no quorum was present; the liquidator then returns that the meeting was duly summoned and no quorum attended (proviso to s.248)." }, "creditors_meeting_quorum_present": { "type": "boolean", "description": "Same, for the creditors' meeting." }, "audit_position": { "type": "string", "enum": [ "audited", "audit_dispensed_by_committee_of_inspection", "audit_dispensed_by_creditors" ], "description": "Whether the liquidator's receipts-and-payments account was audited." }, "court_deferral_order_date": { "type": "string", "format": "date", "description": "If the Court deferred the dissolution on application (s.248 proviso)." }, "records_custodian": { "type": "string", "pattern": "^per_", "description": "Former director who keeps the company's books and papers for at least 6 years after dissolution, unless another person must." } }, "required": [ "account_of_winding_up", "notice_published_date", "general_meeting_date", "creditors_meeting_date", "general_meeting_quorum_present", "creditors_meeting_quorum_present", "audit_position", "records_custodian" ], "description": "Once the affairs are fully wound up, the liquidator lays the account before a general meeting of the company and a meeting of creditors, called by Gazette notice at least 1 month ahead. The liquidator sends the account and a return of the." }, "Create_hk_creditors_voluntary_winding_up_complete": { "type": "object", "properties": { "type": { "const": "hk.creditors_voluntary_winding_up.complete" }, "params": { "$ref": "#/components/schemas/Params_hk_creditors_voluntary_winding_up_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Complete a creditors' voluntary winding up: final meetings and dissolution", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "account_of_winding_up", "title": "Liquidator's account of the winding up", "source": "uploaded", "required": true }, { "key": "gazette_notice_final_meetings", "title": "Gazette notice of the final meetings", "source": "generated", "required": true }, { "key": "final_meeting_minutes", "title": "Minutes of the final meetings", "source": "generated", "required": true }, { "key": "return_of_meetings", "title": "Return of the holding of the meetings and their dates", "source": "generated", "required": true }, { "key": "audit_evidence", "title": "Audit report or dispensing resolution", "source": "uploaded", "required": false }, { "key": "records_retention_undertaking", "title": "Former director's undertaking to keep books and papers for 6 years", "source": "generated", "required": true }, { "key": "dissolution_confirmation", "title": "Confirmation that the company is dissolved", "source": "registry_issued", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "account_of_winding_up", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "account_of_winding_up", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "records_retention_undertaking", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Companies Registry", "form": "Copy of the account and return of the holding of the meetings and their dates", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "meeting_notice_too_short", "type": null, "when": "The Gazette notice is less than 1 month before the meetings." }, { "code": "return_deadline_missed", "type": null, "when": "The account and return are more than 1 week after the meetings; the liquidator is liable to a fine (s.248)." }, { "code": "affairs_not_fully_wound_up", "type": null, "when": "Assets, claims or open proceedings remain." }, { "code": "entity_not_in_liquidation", "type": null, "when": "The entity is not in a voluntary winding up." }, { "code": "not_a_creditors_voluntary_winding_up", "type": null, "when": "A certificate of solvency is in force; the members' voluntary winding up provisions apply." } ] } }, "Params_hk_directors_winding_up_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "directors_acting": { "type": "string", "enum": [ "sole_director", "all_directors", "majority_of_directors" ], "description": "Who passed the resolution: the sole director of a private company (s.228A); all the directors; or a majority where there are more than 2 directors (s.228A)." }, "board_resolution_date": { "type": "string", "format": "date", "description": "Date of the resolution under s.228A." }, "reasons_cannot_continue": { "type": "string", "description": "Why the company cannot by reason of its liabilities continue its business." }, "reasons_section_228a_needed": { "type": "string", "description": "Why the directors consider winding up necessary and why it is not reasonably practicable to commence it under another section (s.228A,)." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "The director who signs NW2 and certifies the matters in s.228A." }, "members_meeting_date": { "type": "string", "format": "date", "description": "Meeting of the company, not later than 28 days after NW2 is delivered (s.228A)." }, "creditors_meeting_date": { "type": "string", "format": "date", "description": "Meeting of creditors, not later than 28 days after delivery (s.228A)." }, "presiding_director": { "type": "string", "pattern": "^per_", "description": "Director who presides at the creditors' meeting and lays the full statement of affairs (s.241, as applied by s.228A)." }, "provisional_liquidator": { "type": "string", "pattern": "^per_", "description": "Natural person who is a solicitor or a CPA under Cap. 50, has consented in writing and has made a disclosure statement delivered to the directors before." }, "provisional_liquidator_status": { "type": "string", "enum": [ "sole", "joint", "joint_and_several" ], "description": "How several provisional liquidators act." } }, "required": [ "directors_acting", "board_resolution_date", "reasons_cannot_continue", "reasons_section_228a_needed", "signing_director", "members_meeting_date", "creditors_meeting_date", "presiding_director", "provisional_liquidator", "provisional_liquidator_status" ], "description": "Where a company cannot by reason of its liabilities continue its business and it is not reasonably practicable to start a winding up another way, the directors resolve, convene meetings, appoint a solicitor or CPA as provisional liquidator." }, "Create_hk_directors_winding_up_commence": { "type": "object", "properties": { "type": { "const": "hk.directors_winding_up.commence" }, "params": { "$ref": "#/components/schemas/Params_hk_directors_winding_up_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Commence a directors' winding up under the s.228A special procedure", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution under s.228A", "source": "generated", "required": true }, { "key": "nw2", "title": "Form NW2 Statement of Voluntary Winding Up under Special Procedure", "source": "generated", "required": true }, { "key": "provisional_liquidator_consent", "title": "Provisional liquidator's written consent", "source": "uploaded", "required": true }, { "key": "disclosure_statement", "title": "Provisional liquidator's disclosure statement", "source": "uploaded", "required": true }, { "key": "notice_of_members_meeting", "title": "Notice of the members' meeting", "source": "generated", "required": true }, { "key": "gazette_notice_commencement", "title": "Gazette notice of commencement and the provisional liquidator's appointment", "source": "generated", "required": true }, { "key": "gazette_notice_creditors_meeting", "title": "Gazette notice of the creditors' meeting, Chinese and English", "source": "generated", "required": true }, { "key": "statement_of_affairs", "title": "Full statement of the position of the company's affairs", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nw2", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "provisional_liquidator_consent", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "disclosure_statement", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NW2 Statement of Voluntary Winding Up under Special Procedure in Case of Inability to", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "provisional_liquidator_not_qualified", "type": null, "when": "The appointee is not a solicitor or a CPA, has not consented in writing, or is disqualified under s.262B; the appointment would be void (s.228A)." }, { "code": "disclosure_statement_missing", "type": null, "when": "No disclosure statement delivered to the directors before the appointment (s.262C)." }, { "code": "nw2_deadline_missed", "type": null, "when": "NW2 would be delivered more than 7 days after it was made and would have no effect (s.228A)." }, { "code": "meetings_too_late", "type": null, "when": "A meeting date is more than 28 days after the expected delivery date." }, { "code": "director_majority_not_met", "type": null, "when": "The directors acting are not all, or a majority, of the board." } ] } }, "Params_hk_dormancy_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "unlimited_company" ], "description": "Private companies only." }, "end_trigger": { "type": "string", "enum": [ "special_resolution", "accounting_transaction" ], "description": "special_resolution: before the first transaction. accounting_transaction: one has already happened; no resolution is delivered." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "Required for special_resolution." }, "resolution_date": { "type": "string", "format": "date", "description": "Required for special_resolution." }, "first_transaction_date": { "type": "string", "format": "date", "description": "Planned date, or actual date." }, "confirm_no_prior_transactions": { "type": "boolean", "description": "Required for special_resolution; a prior transaction triggers s.447 liability." } }, "required": [ "entity_type", "end_trigger" ], "description": "Ends dormancy (Cap. 622 s.5). Before trading, members pass and directors deliver a special resolution of intent to enter an accounting transaction." }, "Create_hk_dormancy_cease": { "type": "object", "properties": { "type": { "const": "hk.dormancy.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_dormancy_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End a Hong Kong company's dormant status", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "ceasing_dormancy_special_resolution", "title": "Special resolution of intent to enter an accounting transaction", "source": "generated", "required": false }, { "key": "transaction_evidence", "title": "Evidence of the first accounting transaction", "source": "uploaded", "required": false }, { "key": "registrar_submission", "title": "Delivery to the Companies Registry", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ceasing_dormancy_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registrar_submission", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Special resolution under Cap. 622 s.5", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_dormant", "type": null, "when": "The entity is not dormant." }, { "code": "transaction_date_missing", "type": null, "when": "accounting_transaction trigger without a date." }, { "code": "transaction_already_occurred", "type": null, "when": "A transaction predates the resolution; s.447 liability may apply." } ] } }, "Params_hk_dormancy_declare": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "unlimited_company" ], "description": "Private companies only (s.5, s.11); guarantee and public companies cannot be dormant." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "A written resolution needs every eligible member (s.556)." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution is passed." }, "effective_date": { "type": "string", "format": "date", "description": "Later start date stated in the resolution (s.5); omit to start on delivery." }, "confirm_not_excluded_company": { "type": "boolean", "description": "Not a bank, insurer, SFC licensee or associate, MPF trustee, or company with or recently having such status (s.5)." }, "confirm_no_accounting_transactions": { "type": "boolean", "description": "No accounting transaction while dormant; one ends dormancy and exposes directors and knowing members to liability (s.5, s.447)." } }, "required": [ "entity_type", "resolution_method", "resolution_date", "confirm_not_excluded_company", "confirm_no_accounting_transactions" ], "description": "Members pass a special resolution declaring a private company dormant and the directors deliver it to the Companies Registry. A dormant company is exempt from annual returns, AGMs and the accounts and audit rules in s.447, but must still." }, "Create_hk_dormancy_declare": { "type": "object", "properties": { "type": { "const": "hk.dormancy.declare" }, "params": { "$ref": "#/components/schemas/Params_hk_dormancy_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a Hong Kong private company dormant", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "dormancy_special_resolution", "title": "Special resolution declaring dormancy", "source": "generated", "required": true }, { "key": "meeting_notice_and_minutes", "title": "Meeting notice and signed minutes", "source": "generated", "required": false }, { "key": "registrar_submission", "title": "Delivery to the Companies Registry", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dormancy_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_notice_and_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registrar_submission", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Special resolution under Cap. 622 s.5", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "company_type_excluded", "type": null, "when": "A s.5 company." }, { "code": "not_a_private_company", "type": null, "when": "Guarantee or public company." }, { "code": "members_not_unanimous", "type": null, "when": "Written resolution lacks a member's agreement." } ] } }, "Params_hk_limited_partnership_wind_up": { "type": "object", "properties": { "dissolution_date": { "type": "string", "format": "date", "description": "Date the partnership is dissolved." }, "dissolution_basis": { "type": "string", "enum": [ "expiry_of_term", "agreement_of_partners", "event_under_partnership_agreement", "court_ordered_dissolution", "other" ], "description": "Why it dissolves." }, "winding_up_by": { "type": "string", "enum": [ "general_partners", "court_appointed" ], "description": "The general partners wind up unless the court orders otherwise (s.5)." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref list of every general partner." }, "limited_partners": { "type": "array", "items": {}, "description": "Each item: person, contribution, amount_returned." }, "liabilities_settled": { "type": "boolean", "description": "All debts and obligations of the firm are paid or provided for." }, "assets_distributed": { "type": "boolean", "description": "Assets distributed and contributions returned as agreed." }, "final_accounts": { "type": "string", "pattern": "^doc_", "description": "Final accounts of the winding up." }, "business_cessation_date": { "type": "string", "format": "date", "description": "Date the business ceased; starts the 1 month for the IRD notice." }, "business_registration_number": { "type": "string", "description": "First 8 digits of the registration number." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Address for correspondence after cessation." }, "contact_phone": { "type": "string", "description": "Contact telephone number." }, "notice_method": { "type": "string", "enum": [ "etax", "letter", "irc3113_form" ], "description": "How the IRD is notified." }, "file_form_2": { "type": "boolean", "description": "File Cap. 37 Form 2 recording the end of the partnership." } }, "required": [ "dissolution_date", "dissolution_basis", "winding_up_by", "general_partners", "limited_partners", "liabilities_settled", "assets_distributed", "final_accounts", "business_cessation_date", "business_registration_number", "correspondence_address", "contact_phone", "notice_method" ], "description": "Records the dissolution of a registered limited partnership and its winding up by the general partners: notice to limited partners, payment of debts, return of contributions and final accounts. Then notifies the Inland Revenue Department's." }, "Create_hk_limited_partnership_wind_up": { "type": "object", "properties": { "type": { "const": "hk.limited_partnership.wind_up" }, "params": { "$ref": "#/components/schemas/Params_hk_limited_partnership_wind_up" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve and wind up a Cap. 37 limited partnership and cancel its business registration", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "dissolution_agreement", "title": "Partners' dissolution agreement or resolution", "source": "generated", "required": true }, { "key": "notice_to_limited_partners", "title": "Notice of dissolution to the limited partners", "source": "generated", "required": true }, { "key": "final_accounts", "title": "Final accounts of the winding up", "source": "uploaded", "required": true }, { "key": "distribution_record", "title": "Record of payments to creditors and distributions to partners", "source": "generated", "required": true }, { "key": "br_cessation_notice", "title": "Notice of cessation to the Business Registration Office", "source": "generated", "required": true }, { "key": "form_2", "title": "Cap. 37 Form 2 Notice of change", "source": "generated", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "dissolution_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "br_cessation_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "br_cessation_notice", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_2", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department, Business Registration Office", "form": "Written notice or Form IRC3113", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liabilities_outstanding", "type": null, "when": "Debts remain unpaid; the general partners stay liable and a court winding up may be needed." }, { "code": "court_winding_up_required", "type": null, "when": "The partnership is insolvent or the partners disagree; use hk.court_winding_up.petition (Cap. 37 s.5)." }, { "code": "fees_outstanding", "type": null, "when": "Business registration fee or levy is unpaid up to the year of cessation." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month since cessation; the offence has been committed." } ] } }, "Params_hk_liquidation_final_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Entity type." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The acting liquidator." }, "final_account_document_id": { "type": "string", "pattern": "^doc_", "description": "How the winding up was conducted and property disposed of (s.239)." }, "notice_published_date": { "type": "string", "format": "date", "description": "Gazette notice, at least 1 month before the meeting (s.239)." }, "final_meeting_date": { "type": "string", "format": "date", "description": "The 1 week runs from it." }, "quorum_present": { "type": "boolean", "description": "If false, the return says the meeting was duly summoned but inquorate (s.239 proviso)." }, "sfc_notified_date": { "type": "string", "format": "date", "description": "OFC only: within 7 days of summoning the meeting (r.189)." }, "records_custody": { "type": "string", "enum": [ "entiva_custody", "liquidator_custody", "director_custody" ], "description": "Books and papers: former directors keep them 6 years; disposal by special resolution." } }, "required": [ "entity_type", "liquidator", "final_account_document_id", "notice_published_date", "final_meeting_date", "quorum_present", "records_custody" ], "description": "The liquidator makes a final account, calls a final meeting by Gazette notice at least 1 month ahead, and within 1 week after it sends the Registrar the account and a return. The company is dissolved 3 months after registration." }, "Create_hk_liquidation_final_return_file": { "type": "object", "properties": { "type": { "const": "hk.liquidation_final_return.file" }, "params": { "$ref": "#/components/schemas/Params_hk_liquidation_final_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a liquidator's final account and return of the final meeting", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "final_account", "title": "Liquidator's final account", "source": "uploaded", "required": true }, { "key": "final_meeting_notice", "title": "Gazette notice of the final meeting", "source": "generated", "required": true }, { "key": "final_meeting_minutes", "title": "Minutes of the final meeting", "source": "generated", "required": true }, { "key": "return_of_final_meeting", "title": "Return of the holding of the meeting and its date", "source": "generated", "required": true }, { "key": "dissolution_confirmation", "title": "Registry record of the return; dissolution 3 months later", "source": "registry_issued", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "return_of_final_meeting", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "return_of_final_meeting", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Liquidator's final account and return of final meeting", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notice_period_short", "type": null, "when": "Gazette notice under 1 month before the meeting." }, { "code": "return_overdue", "type": null, "when": "More than 1 week since the meeting." }, { "code": "affairs_not_wound_up", "type": null, "when": "Assets or creditors unresolved." } ] } }, "Params_hk_liquidator_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "winding_up_mode": { "type": "string", "enum": [ "creditors_voluntary", "members_voluntary", "directors_special_procedure_s228a", "court" ], "description": "Mode of winding up." }, "appointments": { "type": "array", "items": {}, "description": "Up to 2 per form." }, "commencement_date": { "type": "string", "format": "date", "description": "For a s.228A provisional liquidator, the date NW2 was delivered; the 15 days run from it." }, "court_action_number": { "type": "string", "description": "Required for a court appointment." }, "notice_published_date": { "type": "string", "format": "date", "description": "Date the notice of appointment was published in the Gazette; required for a liquidator within 15 days of appointment (s.253)." }, "security_given": { "type": "boolean", "description": "For a court appointment of someone other than the Official Receiver, whether security has been given to the Official Receiver's satisfaction (s.195)." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "The form is completed entirely in one language." } }, "required": [ "winding_up_mode", "appointments", "language" ], "description": "Delivers Form NW3 for a liquidator appointed in a voluntary winding up, a provisional liquidator appointed under the s.228A special procedure, or a liquidator or provisional liquidator appointed by the court. Cap. 32 ss.195, 228A, 253." }, "Create_hk_liquidator_appoint": { "type": "object", "properties": { "type": { "const": "hk.liquidator.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_liquidator_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar of a liquidator's or provisional liquidator's appointment", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "appointment_evidence", "title": "Resolution, minutes or court order appointing the liquidator", "source": "uploaded", "required": true }, { "key": "liquidator_consent_and_disclosure", "title": "Liquidator's consent and disclosure statement", "source": "uploaded", "required": true }, { "key": "gazette_notice_of_appointment", "title": "Gazette notice of appointment", "source": "generated", "required": false }, { "key": "nw3", "title": "Form NW3", "source": "generated", "required": true }, { "key": "pi_nw3", "title": "PI-NW3 protected-information sheet", "source": "generated", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nw3", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nw3", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NW3 Notice of Appointment of Liquidator or Provisional Liquidator", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liquidator_disqualified", "type": null, "when": "The appointee is a body corporate or disqualified under s.262B." }, { "code": "disclosure_statement_missing", "type": null, "when": "No disclosure statement under s.262C is on file." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed; failure is an offence (s.253)." }, { "code": "appointment_already_notified", "type": null, "when": "An NW3 for this appointment is already registered." }, { "code": "too_many_appointees", "type": null, "when": "More than two appointees; Entiva splits them across forms." } ] } }, "Params_hk_liquidator_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "winding_up_mode": { "type": "string", "enum": [ "creditors_voluntary", "members_voluntary", "directors_special_procedure_s228a", "court" ], "description": "Mode of winding up." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator or provisional liquidator ceasing to act." }, "capacity": { "type": "string", "enum": [ "liquidator", "provisional_liquidator" ], "description": "Capacity as registered." }, "effective_date": { "type": "string", "format": "date", "description": "Date of ceasing to act." }, "reason": { "type": "string", "enum": [ "resigned", "removed_by_creditors", "removed_by_company", "removed_by_court", "died", "released_by_court", "other" ], "description": "Why the liquidator ceased." }, "removal_resolution_date": { "type": "string", "format": "date", "description": "Date of the removal resolution." }, "notice_published_date": { "type": "string", "format": "date", "description": "Date the Gazette notice of the cessation was published (ss.253, 228A)." }, "registered_partial_id": { "type": "string", "description": "Partial ID or passport number registered at NW3, or 'Nil'." }, "replacement_liquidator": { "type": "string", "pattern": "^per_", "description": "If set, Entiva opens a linked hk.liquidator.notify_appointment action for the replacement." } }, "required": [ "winding_up_mode", "liquidator", "capacity", "effective_date", "reason", "notice_published_date", "registered_partial_id" ], "description": "Delivers Form NW5 within 15 days after a liquidator or provisional liquidator ceases to act, and publishes a notice of that fact in the Gazette. Cap. 32 ss.228A, 253." }, "Create_hk_liquidator_cease": { "type": "object", "properties": { "type": { "const": "hk.liquidator.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_liquidator_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify that a liquidator or provisional liquidator has ceased to act", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "cessation_evidence", "title": "Resignation letter, removal resolution, death certificate or court order", "source": "uploaded", "required": true }, { "key": "gazette_notice_of_cessation", "title": "Gazette notice of cessation", "source": "generated", "required": true }, { "key": "nw5", "title": "Form NW5", "source": "generated", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nw5", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nw5", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NW5 Notice of Cessation to Act as Liquidator or Provisional Liquidator", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed since the cessation; failure is an offence (s.253)." }, { "code": "no_registered_appointment", "type": null, "when": "No registered NW3 for this liquidator." }, { "code": "vacancy_unfilled", "type": null, "when": "Warning: the vacancy needs filling." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_liquidator_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Entity type." }, "change_type": { "type": "string", "enum": [ "particulars_changed", "ceased_to_act" ], "description": "particulars_changed files NW4; ceased_to_act files NW5." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change or cessation; the 15 days run from it." }, "changes": { "type": "object", "description": "particulars_changed: new name, address, email, ID partial number." }, "reason": { "type": "string", "enum": [ "resigned", "removed_by_company", "replaced", "death", "other" ], "description": "ceased_to_act only." }, "replacement_liquidator": { "type": "string", "pattern": "^per_", "description": "If replaced; Entiva then expects hk.liquidator.appoint." } }, "required": [ "entity_type", "change_type", "liquidator", "effective_date" ], "description": "Within 15 days of a change in registered particulars the liquidator delivers NW4, s.253. A liquidator who ceases to act gazettes a notice and delivers NW5, s.253." }, "Create_hk_liquidator_change": { "type": "object", "properties": { "type": { "const": "hk.liquidator.change" }, "params": { "$ref": "#/components/schemas/Params_hk_liquidator_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a change in a liquidator's particulars or a liquidator ceasing to act", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidator_change_form", "title": "Form NW4 or NW5", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of the change, resignation letter or removal resolution", "source": "uploaded", "required": false }, { "key": "gazette_notice_cessation", "title": "Gazette notice of cessation (s.253)", "source": "generated", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "liquidator_change_form", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "liquidator_change_form", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "change_evidence", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NW4 Notice of Change in Particulars / NW5 Notice of Cessation to Act as Liquidator", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_registered_appointment", "type": null, "when": "No NW3 appointment on record." }, { "code": "deadline_missed", "type": null, "when": "More than 15 days." }, { "code": "removal_blocked", "type": null, "when": "Court ordered the liquidator not be removed (s.235A)." } ] } }, "Params_hk_lpf_deregister": { "type": "object", "properties": { "general_partner": { "type": "string", "pattern": "^per_", "description": "The applying general partner (s.68)." }, "conditions": { "type": "object", "description": "All true: all_partners_agree, no_outstanding_liabilities, gp_not_party_to_legal_proceedings_over_fund_affairs, no_hk_immovable_property (s.68)." }, "ird_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Existing IRD notice; omit and Entiva applies." }, "continues_as_partnership": { "type": "boolean", "description": "Fund carries on as an ordinary partnership afterwards (s.69)." } }, "required": [ "general_partner", "conditions", "continues_as_partnership" ], "description": "The general partner applies on Form LPF7 with the IRD's Notice of No Objection. The Registrar gazettes the proposal and, absent objection within 3 months, the deregistration." }, "Create_hk_lpf_deregister": { "type": "object", "properties": { "type": { "const": "hk.lpf.deregister" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a Hong Kong limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_agreement", "title": "Written agreement of all partners", "source": "generated", "required": true }, { "key": "conditions_confirmation", "title": "General partner's confirmation of the s.68 conditions", "source": "generated", "required": true }, { "key": "ird_notice_of_no_objection", "title": "IRD Notice of No Objection", "source": "registry_issued", "required": true }, { "key": "lpf7_form", "title": "Form LPF7 Application for Deregistration of Limited Partnership Fund", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_agreement", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "conditions_confirmation", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lpf7_form", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "lpf7_form", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Department", "form": "IR1263, then LPF7", "channel": "both", "government_fee": { "amount": 690, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "conditions_not_met", "type": null, "when": "Partners not unanimous, liabilities, proceedings or Hong Kong property." }, { "code": "ird_notice_pending", "type": null, "when": "IRD notice not yet issued." }, { "code": "objection_received", "type": null, "when": "Objection within the 3 months; no deregistration." } ] } }, "Params_hk_lpf_dissolution_notify": { "type": "object", "properties": { "dissolution_cause": { "type": "string", "enum": [ "limited_partnership_agreement", "gp_or_ar_not_replaced" ], "description": "s.70 agreement, or s.70 general partner or representative not replaced in 30 days." }, "dissolution_date": { "type": "string", "format": "date", "description": "The 15 days run from it." }, "dissolved_by_partners_resolution": { "type": "boolean", "description": "If true, a copy of the resolution is filed (s.70)." }, "notifiers": { "type": "array", "items": {}, "description": "General partner and representative, or every limited partner if neither exists." }, "records_retention_confirmed": { "type": "boolean", "description": "Former general partner and manager keep s.29 records 6 years." } }, "required": [ "dissolution_cause", "dissolution_date", "dissolved_by_partners_resolution", "notifiers", "records_retention_confirmed" ], "description": "Form LPF8 notifies the Registrar that an LPF dissolved under its agreement, or because its general partner or authorised representative ceased and was not replaced in 30 days. The general partner and representative must each ensure filing." }, "Create_hk_lpf_dissolution_notify": { "type": "object", "properties": { "type": { "const": "hk.lpf_dissolution.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_lpf_dissolution_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the dissolution of a Hong Kong limited partnership fund", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "lpf" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "lpf8_form", "title": "Form LPF8 Notification of Dissolution of Limited Partnership Fund", "source": "generated", "required": true }, { "key": "partners_resolution", "title": "Partners' resolution dissolving the fund", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lpf8_form", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "lpf8_form", "signer_role": "general_partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "LPF8 Notification of Dissolution of Limited Partnership Fund", "channel": "both", "government_fee": { "amount": 26, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_missed", "type": null, "when": "More than 15 days since dissolution." }, { "code": "resolution_copy_missing", "type": null, "when": "Dissolved by resolution without a copy." }, { "code": "court_dissolution_not_supported", "type": null, "when": "Court-ordered dissolution: the applicant files the order within 15 days (s.71); outside this action." } ] } }, "Params_hk_members_voluntary_winding_up_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Entity type." }, "scope": { "type": "string", "enum": [ "whole_entity", "sub_fund" ], "description": "OFC only: whole_entity or one sub_fund." }, "sfc_subfund_approval_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for a sub-fund: SFC approval to terminate it (r.160)." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "A written resolution needs every eligible member (Cap. 622 s.556; OFC r.92)." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution passes." }, "certificate_issue_date": { "type": "string", "format": "date", "description": "Within the 5 weeks before resolution_date, or on it before the vote (s.233)." }, "repayment_period_months": { "type": "integer", "description": "At most 12 months from commencement (s.233)." }, "statement_date": { "type": "string", "format": "date", "description": "Latest practicable date for the assets and liabilities statement (s.233)." }, "confirm_full_inquiry": { "type": "boolean", "description": "Directors inquired fully and believe debts will be paid in full; signing without reasonable grounds is an offence (s.233)." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "A natural person (s.262B); the s.262B bars do not apply here (s.262B)." }, "liquidator_status": { "type": "string", "enum": [ "sole", "joint", "joint_and_several" ], "description": "Sole or joint appointment." } }, "required": [ "entity_type", "resolution_method", "resolution_date", "certificate_issue_date", "repayment_period_months", "statement_date", "confirm_full_inquiry", "liquidator", "liquidator_status" ], "description": "Directors certify solvency on Form NW1; members pass a special resolution to wind up and appoint a liquidator. The certificate, then the resolution, go to the Registrar and the resolution is gazetted." }, "Create_hk_members_voluntary_winding_up_commence": { "type": "object", "properties": { "type": { "const": "hk.members_voluntary_winding_up.commence" }, "params": { "$ref": "#/components/schemas/Params_hk_members_voluntary_winding_up_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Start a members' voluntary winding up of a solvent Hong Kong company or OFC", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution authorising the certificate", "source": "generated", "required": true }, { "key": "solvency_certificate", "title": "Form NW1 Certificate of Solvency", "source": "generated", "required": true }, { "key": "winding_up_special_resolution", "title": "Special resolution to wind up and appoint the liquidator (s.228, s.235)", "source": "generated", "required": true }, { "key": "liquidator_consent", "title": "Liquidator's consent to act", "source": "generated", "required": true }, { "key": "gazette_notice_resolution", "title": "Gazette notice of the resolution and copy for the IRD", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_certificate", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "winding_up_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liquidator_consent", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Companies Registry", "form": "NW1 Certificate of Solvency", "channel": "both", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "certificate_window_missed", "type": null, "when": "Certificate not issued within the 5 weeks before the resolution." }, { "code": "liquidator_disqualified", "type": null, "when": "Body corporate, bankrupt, disqualified or incapacitated person (s.262B)." }, { "code": "sfc_approval_missing", "type": null, "when": "OFC sub-fund without SFC approval." }, { "code": "insolvency_indicated", "type": null, "when": "Liabilities exceed assets; use the creditors' route." } ] } }, "Params_hk_mortgagee_possession_entry_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "mortgagee": { "type": "string", "pattern": "^per_", "description": "The mortgagee or chargee." }, "mortgagee_type": { "type": "string", "enum": [ "natural_person", "body_corporate" ], "description": "A natural person gives name and ID; a body corporate gives its name and the address of its registered or principal office (s.349)." }, "charge_description": { "type": "string", "description": "Description of the charge under which possession was taken, as registered." }, "charge_creation_date": { "type": "string", "format": "date", "description": "Date of creation of the charge." }, "date_entered_into_possession": { "type": "string", "format": "date", "description": "Starts the 7 days (s.349)." }, "property_landed": { "type": "array", "items": {}, "description": "Addresses of landed property." }, "property_other": { "type": "string", "description": "Other property taken into possession." }, "signatory_capacity": { "type": "string", "enum": [ "mortgagee_personally", "director", "company_secretary", "authorized_representative" ], "description": "Who signs NM3." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "The form is completed entirely in one language." } }, "required": [ "mortgagee", "mortgagee_type", "charge_description", "charge_creation_date", "date_entered_into_possession", "signatory_capacity", "language" ], "description": "A mortgagee or chargee that enters into possession of a company's property, or the charged property of a registered non-Hong Kong company, delivers Form NM3 within 7 days. Cap. 622 s.349 (OFC Rules r.174)." }, "Create_hk_mortgagee_possession_entry_notify": { "type": "object", "properties": { "type": { "const": "hk.mortgagee_possession_entry.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_mortgagee_possession_entry_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a mortgagee entering into possession of property", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "charge_instrument_or_evidence", "title": "Charge instrument or evidence of the registered charge", "source": "uploaded", "required": true }, { "key": "mortgagee_authority", "title": "Mortgagee's board resolution or letter of authority for the signatory", "source": "uploaded", "required": true }, { "key": "nm3", "title": "Form NM3", "source": "generated", "required": true }, { "key": "pi_nm3", "title": "PI-NM3 protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "chargee", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nm3", "signer_role": "chargee", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nm3", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NM3 Notice of Mortgagee Entering into Possession of Property", "channel": "both", "government_fee": { "amount": 40, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 7 days since entering into possession; the offence in s.349 has been committed." }, { "code": "charge_not_registered", "type": null, "when": "The charge is not on the register of charges." }, { "code": "mortgagee_authority_missing", "type": null, "when": "No evidence the signatory may act for the mortgagee." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_mortgagee_possession_exit_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "mortgagee": { "type": "string", "pattern": "^per_", "description": "The mortgagee or chargee named in the earlier NM3." }, "date_out_of_possession": { "type": "string", "format": "date", "description": "Starts the 7 days (s.350)." }, "signatory_capacity": { "type": "string", "enum": [ "mortgagee_personally", "director", "company_secretary", "authorized_representative" ], "description": "Who signs NM4." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Must match the NM3." } }, "required": [ "mortgagee", "date_out_of_possession", "signatory_capacity", "language" ], "description": "A mortgagee that goes out of possession of a company's property, or the charged property of a registered non-Hong Kong company, delivers Form NM4 within 7 days. Cap. 622 s.350 (OFC Rules r.175)." }, "Create_hk_mortgagee_possession_exit_notify": { "type": "object", "properties": { "type": { "const": "hk.mortgagee_possession_exit.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_mortgagee_possession_exit_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a mortgagee going out of possession of property", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence_of_release_of_possession", "title": "Evidence the mortgagee left possession", "source": "uploaded", "required": false }, { "key": "mortgagee_authority", "title": "Mortgagee's authority for the signatory", "source": "uploaded", "required": true }, { "key": "nm4", "title": "Form NM4", "source": "generated", "required": true } ], "people": [ { "role": "chargee", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nm4", "signer_role": "chargee", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nm4", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NM4 Notice of Mortgagee Going out of Possession of Property", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 7 days since going out of possession." }, { "code": "no_registered_nm3", "type": null, "when": "No registered NM3 for this mortgagee." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_non_hk_company_liquidation_notify": { "type": "object", "properties": { "notice_kind": { "type": "string", "enum": [ "liquidation_commenced", "liquidator_appointed", "liquidator_changed", "liquidator_ceased", "dissolved" ], "description": "NN11 for the first four, NN14 for dissolved." }, "event_date": { "type": "string", "format": "date", "description": "Commencement, appointment, change, cessation or dissolution date; the 15 days run from the later of commencement and service of notice on the company (s.793)." }, "liquidation_country": { "type": "string", "description": "ISO 3166 country of the proceedings; commencement." }, "liquidation_mode": { "type": "string", "enum": [ "compulsory", "members_voluntary", "creditors_voluntary", "other" ], "description": "Commencement." }, "liquidators": { "type": "array", "items": {}, "description": "person_id, capacity, status, appointment_date or cessation_date." }, "instrument_language": { "type": "string", "enum": [ "en", "zh", "other" ], "description": "Dissolved: other languages need a certified translation." }, "signatory": { "type": "string", "pattern": "^per_", "description": "NN11: director, secretary, manager, representative or liquidator." } }, "required": [ "notice_kind", "event_date", "signatory" ], "description": "NN11 notifies liquidation proceedings, a liquidator's appointment and later changes; NN14, filed by the authorised representative with a certified copy of the instrument, notifies dissolution. Each is due within 15 days." }, "Create_hk_non_hk_company_liquidation_notify": { "type": "object", "properties": { "type": { "const": "hk.non_hk_company_liquidation.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_non_hk_company_liquidation_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify liquidation or dissolution of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidation_notice_form", "title": "Form NN11 or NN14", "source": "generated", "required": true }, { "key": "liquidation_order_or_resolution", "title": "Order or resolution commencing the liquidation", "source": "uploaded", "required": false }, { "key": "dissolution_instrument_certified", "title": "Certified copy of the instrument effecting dissolution", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "liquidation_notice_form", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "liquidation_notice_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "dissolution_instrument_certified", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NN11 Notice of Commencement of Liquidation and Appointment/Cessation and Change in Particu", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_missed", "type": null, "when": "More than 15 days; offence." }, { "code": "instrument_uncertified", "type": null, "when": "NN14 instrument not certified by a s.775 person." }, { "code": "liquidator_details_missing", "type": null, "when": "Liquidator name, address or ID incomplete." } ] } }, "Params_hk_nonhk_company_dissolution_notify": { "type": "object", "properties": { "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution; the instrument must show the effective date." }, "instrument_name": { "type": "string", "description": "Name of the instrument effecting the dissolution, for example a certificate of dissolution, deregistration notice or court order." }, "certified_copy": { "type": "string", "pattern": "^doc_", "description": "Certified copy of the instrument, with a certified translation if not in English or Chinese (s.795)." }, "certified_by": { "type": "string", "enum": [ "authorized_representative", "company_officer", "notary", "lawyer", "professional_accountant", "court_officer", "consular_officer", "professional_company_secretary", "government_custodian" ], "description": "Who certified the copy: an officer of the company or its Hong Kong authorized representative, or a government custodian, notary, lawyer, professional." }, "authority_confirmed": { "type": "boolean", "description": "The signer confirms authority to act for the company." }, "signatory_role": { "type": "string", "enum": [ "former_director", "company_secretary", "manager", "authorized_representative", "liquidator" ], "description": "NN14 may be signed by a former director, company secretary, manager, authorized representative or liquidator." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "The form is completed entirely in one language." } }, "required": [ "dissolution_date", "instrument_name", "certified_copy", "certified_by", "authority_confirmed", "signatory_role", "language" ], "description": "When a registered non-Hong Kong company is dissolved, its authorized representative delivers Form NN14 with a certified copy of the instrument effecting the dissolution within 15 days. The Registrar then enters a statement of dissolution." }, "Create_hk_nonhk_company_dissolution_notify": { "type": "object", "properties": { "type": { "const": "hk.nonhk_company_dissolution.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_nonhk_company_dissolution_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the dissolution of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dissolution_instrument_certified_copy", "title": "Certified copy of the instrument effecting the dissolution", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified translation into English or Chinese", "source": "uploaded", "required": false }, { "key": "nn14", "title": "Form NN14", "source": "generated", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nn14", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn14", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dissolution_instrument_certified_copy", "signer_role": "other", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN14 Notice of Dissolution of Registered Non-Hong Kong Company", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_registered_non_hk_company", "type": null, "when": "The entity is not a registered non-Hong Kong company." }, { "code": "certified_copy_missing", "type": null, "when": "No certified copy of the instrument." }, { "code": "effective_date_not_shown", "type": null, "when": "The instrument does not show the effective date of dissolution." }, { "code": "translation_missing", "type": null, "when": "The instrument is not in English or Chinese and no certified translation is attached." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days after dissolution; the authorized representative commits an offence (s.795)." } ] } }, "Params_hk_nonhk_company_liquidation_change": { "type": "object", "properties": { "change_types": { "type": "array", "items": {}, "description": "Allowed values: mode_of_liquidation, liquidator_name, liquidator_address, liquidator_email, liquidator_id, liquidator_status." }, "mode": { "type": "string", "enum": [ "compulsory", "members_voluntary", "creditors_voluntary", "other" ], "description": "New mode, when mode_of_liquidation changes." }, "mode_effective_date": { "type": "string", "format": "date", "description": "Effective date of the change in mode." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator whose particulars changed." }, "registered_partial_id": { "type": "string", "description": "Partial ID or passport number registered for the liquidator, or 'Nil'." }, "liquidator_changes": { "type": "object", "description": "Only items that changed, each with an effective_date." }, "signatory_role": { "type": "string", "enum": [ "director", "company_secretary", "manager", "authorized_representative", "liquidator", "provisional_liquidator" ], "description": "Who signs." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Same language as the earlier NN11." } }, "required": [ "change_types", "signatory_role", "language" ], "description": "Within 15 days after a change in the particulars of the liquidation or in a registered liquidator's name, address, email, ID or status, the company delivers Form NN11 showing only what changed and its effective date. Cap. 622 s.793,." }, "Create_hk_nonhk_company_liquidation_change": { "type": "object", "properties": { "type": { "const": "hk.nonhk_company_liquidation.change" }, "params": { "$ref": "#/components/schemas/Params_hk_nonhk_company_liquidation_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify a change in the liquidation proceedings or in a liquidator's particulars", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "change_evidence", "title": "Order, resolution or other evidence of the change", "source": "uploaded", "required": true }, { "key": "nn11", "title": "Form NN11", "source": "generated", "required": true }, { "key": "pi_nn11", "title": "PI-NN11 protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nn11", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn11", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN11", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_registered_non_hk_company", "type": null, "when": "The entity is not a registered non-Hong Kong company, or its registration has ended." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed; the company, its responsible persons and any agent who permitted it commit an offence (s.793)." }, { "code": "no_commencement_notice", "type": null, "when": "No NN11 for the commencement is on the register." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_nonhk_company_liquidation_commencement_notify": { "type": "object", "properties": { "proceedings_commencement_date": { "type": "string", "format": "date", "description": "Date the liquidation proceedings commenced (s.793)." }, "notice_served_on_company_date": { "type": "string", "format": "date", "description": "Date the notice of commencement was served on the company under the law of the place where the proceedings began (s.793)." }, "proceedings_country": { "type": "string", "description": "ISO 3166 code of the country where the proceedings were commenced (s.793)." }, "liquidation_mode": { "type": "string", "enum": [ "compulsory", "members_voluntary", "creditors_voluntary", "other" ], "description": "Voluntary here means a liquidation abroad: a registered non-Hong Kong company cannot be wound up voluntarily under Cap. 32 (s.327)." }, "other_mode_description": { "type": "string", "description": "Required when liquidation_mode is other." }, "liquidators": { "type": "array", "items": {}, "description": "Liquidators or provisional liquidators already appointed (s.793)." }, "signatory_role": { "type": "string", "enum": [ "director", "company_secretary", "manager", "authorized_representative", "liquidator", "provisional_liquidator" ], "description": "Who signs." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "The form is completed entirely in one language." } }, "required": [ "proceedings_commencement_date", "notice_served_on_company_date", "proceedings_country", "liquidation_mode", "signatory_role", "language" ], "description": "Within 15 days after the later of the commencement of liquidation proceedings anywhere and service of the notice of them on the company, the company delivers Form NN11 with the date, country and mode of the proceedings and any liquidator." }, "Create_hk_nonhk_company_liquidation_commencement_notify": { "type": "object", "properties": { "type": { "const": "hk.nonhk_company_liquidation_commencement.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_nonhk_company_liquidation_commencement_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the commencement of liquidation of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "proceedings_evidence", "title": "Order, resolution or notice commencing the liquidation", "source": "uploaded", "required": true }, { "key": "liquidator_appointment_evidence", "title": "Evidence of the liquidator's appointment", "source": "uploaded", "required": false }, { "key": "nn11", "title": "Form NN11", "source": "generated", "required": true }, { "key": "pi_nn11", "title": "PI-NN11 protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nn11", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn11", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN11 Notice of Commencement of Liquidation and Appointment/Cessation and Change in Pa", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_registered_non_hk_company", "type": null, "when": "The entity is not a registered non-Hong Kong company, or its registration has ended." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed; the company, its responsible persons and any agent who permitted it commit an offence (s.793)." }, { "code": "proceedings_evidence_missing", "type": null, "when": "No evidence of the proceedings is on file." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_nonhk_company_liquidation_liquidator_appointment_notify": { "type": "object", "properties": { "liquidators": { "type": "array", "items": {}, "description": "Each item: person, kind, capacity, status, appointment_date." }, "signatory_role": { "type": "string", "enum": [ "director", "company_secretary", "manager", "authorized_representative", "liquidator", "provisional_liquidator" ], "description": "Who signs." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Same language as the earlier NN11." } }, "required": [ "liquidators", "signatory_role", "language" ], "description": "After NN11 has been delivered, a liquidator or provisional liquidator appointed later is notified on Form NN11 within 15 days after the appointment. Cap. 622 s.793,." }, "Create_hk_nonhk_company_liquidation_liquidator_appointment_notify": { "type": "object", "properties": { "type": { "const": "hk.nonhk_company_liquidation_liquidator_appointment.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_nonhk_company_liquidation_liquidator_appointment_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the appointment of a liquidator or provisional liquidator of a registered non-Hong Kong company", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidator_appointment_evidence", "title": "Resolution, order or other evidence of the appointment", "source": "uploaded", "required": true }, { "key": "nn11", "title": "Form NN11", "source": "generated", "required": true }, { "key": "pi_nn11", "title": "PI-NN11 protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nn11", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn11", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN11", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_registered_non_hk_company", "type": null, "when": "The entity is not a registered non-Hong Kong company, or its registration has ended." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed; the company, its responsible persons and any agent who permitted it commit an offence (s.793)." }, { "code": "no_commencement_notice", "type": null, "when": "No NN11 for the commencement is on the register; use hk.nonhk_company_liquidation.notify_commencement." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_nonhk_company_liquidation_liquidator_cessation_notify": { "type": "object", "properties": { "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator or provisional liquidator ceasing to act." }, "kind": { "type": "string", "enum": [ "natural_person", "other" ], "description": "Natural person or other." }, "capacity": { "type": "string", "enum": [ "liquidator", "provisional_liquidator" ], "description": "Capacity as registered." }, "registered_partial_id": { "type": "string", "description": "For a natural person: partial ID or passport number registered, or 'Nil'." }, "effective_date": { "type": "string", "format": "date", "description": "Date of ceasing to hold office." }, "signatory_role": { "type": "string", "enum": [ "director", "company_secretary", "manager", "authorized_representative", "liquidator", "provisional_liquidator" ], "description": "Who signs." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Same language as the earlier NN11." } }, "required": [ "liquidator", "kind", "capacity", "effective_date", "signatory_role", "language" ], "description": "Within 15 days after a registered liquidator or provisional liquidator ceases to hold office, the company delivers Form NN11 with the date of cessation. Cap. 622 s.793,." }, "Create_hk_nonhk_company_liquidation_liquidator_cessation_notify": { "type": "object", "properties": { "type": { "const": "hk.nonhk_company_liquidation_liquidator_cessation.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_nonhk_company_liquidation_liquidator_cessation_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify that a liquidator or provisional liquidator of a registered non-Hong Kong company has ceased to act", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "cessation_evidence", "title": "Resignation, removal resolution, court order or death certificate", "source": "uploaded", "required": true }, { "key": "nn11", "title": "Form NN11", "source": "generated", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nn11", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn11", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NN11", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_registered_non_hk_company", "type": null, "when": "The entity is not a registered non-Hong Kong company, or its registration has ended." }, { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed; the company, its responsible persons and any agent who permitted it commit an offence (s.793)." }, { "code": "no_registered_appointment", "type": null, "when": "No registered NN11 appointment for this person." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_place_of_business_cease": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date the last Hong Kong place of business ceased; the 7 days run from it." }, "signatory_role": { "type": "string", "enum": [ "director", "company_secretary", "manager", "authorised_representative" ], "description": "NN13 is signed by one of these." }, "signatory": { "type": "string", "pattern": "^per_", "description": "The signer." } }, "required": [ "effective_date", "signatory_role", "signatory" ], "description": "A registered non-Hong Kong company that stops having a place of business in Hong Kong must tell the Registrar on Form NN13 within 7 days. The Registrar enters a statement on the register and the company stops being a registered non-Hong." }, "Create_hk_place_of_business_cease": { "type": "object", "properties": { "type": { "const": "hk.place_of_business.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_place_of_business_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify cessation of a Hong Kong place of business", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "company_decision", "title": "Company's decision to close its Hong Kong business", "source": "uploaded", "required": true }, { "key": "nn13_form", "title": "Form NN13", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "company_decision", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nn13_form", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nn13_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "NN13 Notice of Cessation of Place of Business in Hong Kong of Registered Non-Hong Kong Com", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_missed", "type": null, "when": "More than 7 days since cessation." }, { "code": "company_not_registered", "type": null, "when": "Not a registered non-Hong Kong company." }, { "code": "signatory_not_eligible", "type": null, "when": "Not a director, secretary, manager or authorised representative." } ] } }, "Params_hk_receiver_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "mode_of_appointment": { "type": "string", "enum": [ "court_order", "instrument" ], "description": "How the receiver or manager was appointed." }, "court_action_number": { "type": "string", "description": "Court action number; required for a court order." }, "court_order_date": { "type": "string", "format": "date", "description": "Date of the order." }, "instrument_description": { "type": "string", "description": "For an instrument appointment: the same description as on the charge registered with Form M1 or NM1." }, "instrument_creation_date": { "type": "string", "format": "date", "description": "Date the charging instrument was created." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the order or of the appointment under the instrument." }, "receivers": { "type": "array", "items": {}, "description": "Each item: person, capacity, status." }, "appointor": { "type": "object", "description": "Who appointed or obtained the order: type, person and name." }, "property_landed": { "type": "array", "items": {}, "description": "Addresses of landed property over which the appointment is made." }, "property_other": { "type": "string", "description": "Other property, described as appropriate." }, "floating_charge_whole_or_substantially_whole": { "type": "boolean", "description": "True if the receiver is appointed for the whole or substantially the whole of the property on behalf of holders of debentures secured by a floating charge." }, "signatory_capacity": { "type": "string", "enum": [ "appointor_personally", "director", "company_secretary", "authorized_representative" ], "description": "Who signs NM5." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "The form is completed entirely in one language; later NM6 and NM7 use the same one." } }, "required": [ "mode_of_appointment", "effective_date", "receivers", "appointor", "floating_charge_whole_or_substantially_whole", "signatory_capacity", "language" ], "description": "The person who obtains a court order appointing a receiver or manager, or who appoints one under an instrument, delivers Form NM5 to the Registrar within 7 days. Cap. 622 s.348." }, "Create_hk_receiver_appoint": { "type": "object", "properties": { "type": { "const": "hk.receiver.appoint" }, "params": { "$ref": "#/components/schemas/Params_hk_receiver_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register the appointment of a receiver or manager", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointment_instrument_or_order", "title": "Instrument of appointment or court order", "source": "uploaded", "required": true }, { "key": "charge_registration_evidence", "title": "Evidence the charge is registered", "source": "uploaded", "required": false }, { "key": "appointor_authority", "title": "Appointor's board resolution or letter of authority for the signatory", "source": "uploaded", "required": true }, { "key": "receiver_consent", "title": "Receiver's acceptance of appointment", "source": "uploaded", "required": false }, { "key": "nm5", "title": "Form NM5", "source": "generated", "required": true }, { "key": "pi_nm5", "title": "PI-NM5 protected-information sheet", "source": "generated", "required": true } ], "people": [ { "role": "receiver", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nm5", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nm5", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NM5 Notice of Appointment of Receiver or Manager", "channel": "both", "government_fee": { "amount": 40, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "receiver_not_qualified", "type": null, "when": "The receiver is a body corporate or an undischarged bankrupt." }, { "code": "deadline_passed", "type": null, "when": "More than 7 days since the order or appointment; the offence in s.348 has been committed." }, { "code": "appointor_authority_missing", "type": null, "when": "No evidence the signatory may act for the appointor." }, { "code": "charge_not_registered", "type": null, "when": "The charge description does not match a registered charge." }, { "code": "missing_court_details", "type": null, "when": "mode_of_appointment is court_order but the action number or order date is missing." } ] } }, "Params_hk_receiver_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "receiver": { "type": "string", "pattern": "^per_", "description": "The receiver or manager who ceased to act." }, "effective_date": { "type": "string", "format": "date", "description": "Date the person ceased to act." }, "reason": { "type": "string", "enum": [ "discharged_on_realisation", "replaced", "resigned", "removed_by_court", "removed_by_appointor", "died", "other" ], "description": "Why the appointment ended." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Must match the language of the NM5." } }, "required": [ "receiver", "effective_date", "reason", "language" ], "description": "A receiver or manager appointed by a court order or an instrument delivers Form NM6 within 7 days after ceasing to act. The receiver signs personally." }, "Create_hk_receiver_cease": { "type": "object", "properties": { "type": { "const": "hk.receiver.cease" }, "params": { "$ref": "#/components/schemas/Params_hk_receiver_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register that a receiver or manager has ceased to act", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cessation_evidence", "title": "Discharge, replacement deed, court order or death certificate", "source": "uploaded", "required": true }, { "key": "nm6", "title": "Form NM6", "source": "generated", "required": true } ], "people": [ { "role": "receiver", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nm6", "signer_role": "receiver", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NM6 Notice of Cessation of Appointment of Receiver or Manager", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 7 days have passed since ceasing to act." }, { "code": "no_registered_appointment", "type": null, "when": "No registered NM5 for this person." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_receiver_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "subject": { "type": "string", "enum": [ "receiver_or_manager", "mortgagee_in_possession" ], "description": "Whose particulars changed." }, "person": { "type": "string", "pattern": "^per_", "description": "The receiver, manager, mortgagee or chargee." }, "registered_partial_id": { "type": "string", "description": "Partial ID or passport number registered for a natural person, or 'Nil'." }, "changes": { "type": "object", "description": "Only items that changed, each with an effective_date: name_zh, name_en, address, email, hkid_or_passport, status, body-corporate name and registered or." }, "signatory_capacity": { "type": "string", "enum": [ "person_personally", "director", "company_secretary", "authorized_representative" ], "description": "Who signs NM7." }, "language": { "type": "string", "enum": [ "en", "zh" ], "description": "Must match the NM5 or NM3." } }, "required": [ "subject", "person", "changes", "signatory_capacity", "language" ], "description": "Where an NM5 or NM3 is on the register, the receiver, manager, mortgagee or chargee delivers Form NM7 within 15 days after any change in their particulars. Cap. 622 s.350 (OFC Rules r.175)." }, "Create_hk_receiver_change": { "type": "object", "properties": { "type": { "const": "hk.receiver.change" }, "params": { "$ref": "#/components/schemas/Params_hk_receiver_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a change in the particulars of a receiver, manager or mortgagee in possession", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence_of_change", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "authority_of_signatory", "title": "Authority of a director, secretary or authorized representative to sign", "source": "uploaded", "required": false }, { "key": "nm7", "title": "Form NM7", "source": "generated", "required": true }, { "key": "pi_nm7", "title": "PI-NM7 protected-information sheet", "source": "generated", "required": false } ], "people": [ { "role": "receiver", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nm7", "signer_role": "chargee", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nm7", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NM7 Notice of Change in Particulars of Receiver, Manager or Mortgagee in Possession o", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 15 days have passed since the change." }, { "code": "no_registered_notice", "type": null, "when": "No registered NM5 or NM3 for this person." }, { "code": "already_ceased", "type": null, "when": "NM6 or NM4 has already been delivered; NM7 is not needed (s.350)." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_receiver_abstract_of_accounts_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "regime": { "type": "string", "enum": [ "floating_charge_12_month_s300A", "instrument_6_month_s301" ], "description": "Which section applies." }, "abstract_type": { "type": "string", "enum": [ "first", "subsequent", "final" ], "description": "First abstract covers the first 12 months; subsequent ones each following period; the final one runs to the date of ceasing to act." }, "period_start": { "type": "string", "format": "date", "description": "Start of the period covered." }, "period_end": { "type": "string", "format": "date", "description": "End of the period covered." }, "receivers": { "type": "array", "items": {}, "description": "person_ref list of all receivers or managers." }, "receipts_total": { "$ref": "#/components/schemas/Money", "description": "Total receipts in the period." }, "payments_total": { "$ref": "#/components/schemas/Money", "description": "Total payments in the period." }, "aggregate_receipts_since_appointment": { "$ref": "#/components/schemas/Money", "description": "Aggregate of all periods; required except for the first abstract." }, "aggregate_payments_since_appointment": { "$ref": "#/components/schemas/Money", "description": "Aggregate of all periods; required except for the first abstract." } }, "required": [ "regime", "abstract_type", "period_start", "period_end", "receivers", "receipts_total", "payments_total" ], "description": "A receiver or manager delivers Form NRC3 to the Registrar: for a floating-charge receiver of the whole or substantially the whole of the property, within 2 months after each 12-month period and after ceasing to act (s.300A); for other." }, "Create_hk_receiver_abstract_of_accounts_file": { "type": "object", "properties": { "type": { "const": "hk.receiver_abstract_of_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_hk_receiver_abstract_of_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deliver a receiver's or manager's abstract of receipts and payments", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "receipts_and_payments_schedule", "title": "Itemised receipts and payments", "source": "uploaded", "required": true }, { "key": "nrc3", "title": "Form NRC3", "source": "generated", "required": true } ], "people": [ { "role": "receiver", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nrc3", "signer_role": "receiver", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NRC3 Receiver or Manager's Abstract of Receipts and Payments", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "wrong_regime", "type": null, "when": "The regime does not match how the receiver was appointed." }, { "code": "period_mismatch", "type": null, "when": "The period is not 12 months from the last abstract, and the abstract is not final." }, { "code": "deadline_passed", "type": null, "when": "The abstract is late; failure is an offence." }, { "code": "missing_receiver_signature", "type": null, "when": "A joint receiver has not signed." } ] } }, "Params_hk_receiver_statement_of_affairs_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "receiver": { "type": "string", "pattern": "^per_", "description": "The receiver sending NRC1 and the statement to the Registrar." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the receiver's appointment." }, "appointed_under": { "type": "string", "enum": [ "court_order", "instrument" ], "description": "Court order or instrument." }, "nrc1_sent_date": { "type": "string", "format": "date", "description": "Date NRC1 was sent to the company; it must go forthwith (s.300A)." }, "statement_makers": { "type": "array", "items": {}, "description": "person_ref list: the directors and the company secretary at the date of appointment, or others the receiver requires (s.300B)." }, "statement_received_date": { "type": "string", "format": "date", "description": "Date the receiver received the statement." }, "receiver_comments": { "type": "string", "description": "Comments on the statement for the Registrar and the company; if none, a notice to that effect goes to the company." }, "summary_of_statement": { "type": "string", "description": "Summary of the statement and comments, which goes to the Registrar (s.300A)." } }, "required": [ "receiver", "effective_date", "appointed_under", "nrc1_sent_date", "statement_makers", "summary_of_statement" ], "description": "Where a receiver of the whole or substantially the whole of the property is appointed for floating-charge debenture holders, the receiver sends the company a notice forthwith, the directors and secretary make a statement of affairs within." }, "Create_hk_receiver_statement_of_affairs_file": { "type": "object", "properties": { "type": { "const": "hk.receiver_statement_of_affairs.file" }, "params": { "$ref": "#/components/schemas/Params_hk_receiver_statement_of_affairs_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deliver the statement of affairs after a floating-charge receiver is appointed", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nrc1", "title": "Form NRC1 Notice to company of appointment of receiver or manager", "source": "generated", "required": true }, { "key": "nrc2", "title": "Form NRC2 Statement of affairs", "source": "generated", "required": true }, { "key": "statement_summary", "title": "Receiver's summary and comments", "source": "generated", "required": true }, { "key": "books_and_records", "title": "Books and records for the statement", "source": "uploaded", "required": true } ], "people": [ { "role": "receiver", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "nrc2", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_summary", "signer_role": "receiver", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NRC2 Statement of Affairs, with the receiver's comments and summary", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "s300a_not_applicable", "type": null, "when": "The receiver is not for the whole or substantially the whole of the property on behalf of floating-charge debenture holders." }, { "code": "statement_deadline_missed", "type": null, "when": "The 14-day period passed without an extension." }, { "code": "registrar_delivery_deadline_missed", "type": null, "when": "More than 2 months since the receiver received the statement." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_hk_registrar_representation_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Taken from the entity when omitted." }, "dissolution_basis": { "type": "string", "enum": [ "deregistration_or_striking_off_part_15", "winding_up_s226A_227_239_248", "predecessor_ordinance" ], "description": "How the company was dissolved. s.757 covers dissolution under Cap. 622 Part 15, Cap. 32 ss.226A, 227, 239 or 248, or the predecessor Ordinance ss.291, 291A." }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution." }, "representing": { "type": "string", "enum": [ "company", "liquidator", "provisional_liquidator" ], "description": "Whom the Registrar is asked to represent (s.757)." }, "dealing_description": { "type": "string", "description": "The dealing, transaction or matter to be completed." }, "obligation_basis": { "type": "string", "description": "Why the company, if still existing, would be legally or equitably bound to complete it (s.757)." }, "administrative_act_description": { "type": "string", "description": "The purely administrative, non-discretionary act that should have been done by or for the company (s.757)." }, "instrument_count": { "type": "integer", "description": "Number of instruments or documents the Registrar is asked to execute or sign; each costs HK$1,240." }, "counterparty": { "type": "string", "pattern": "^per_", "description": "The other party to the dealing, if any." }, "land_registry_reference": { "type": "string", "description": "Land Registry memorial or document number, for a property dealing." }, "applicant_interest": { "type": "string", "description": "The applicant's interest in the matter." } }, "required": [ "dissolution_basis", "dissolution_date", "representing", "dealing_description", "obligation_basis", "administrative_act_description", "instrument_count", "applicant_interest" ], "description": "Where a dissolved company would still be bound to complete a dealing and only a purely administrative, non-discretionary act is needed, an interested party applies in writing for the Registrar to do the act, or to sign the instrument, as." }, "Create_hk_registrar_representation_request": { "type": "object", "properties": { "type": { "const": "hk.registrar_representation.request" }, "params": { "$ref": "#/components/schemas/Params_hk_registrar_representation_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Ask the Registrar to act for a dissolved company to complete a transaction", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_letter", "title": "Written application to the Registrar", "source": "generated", "required": true }, { "key": "draft_instruments", "title": "Draft instrument for the Registrar to execute", "source": "uploaded", "required": true }, { "key": "evidence_of_obligation", "title": "Evidence of the obligation", "source": "uploaded", "required": true }, { "key": "company_search_report", "title": "Companies Registry search showing the dissolution", "source": "registry_issued", "required": true }, { "key": "statutory_declaration", "title": "Statutory declaration proving the facts", "source": "uploaded", "required": false }, { "key": "executed_instruments", "title": "Instruments executed by the Registrar with the memorandum under s.757", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "application_letter", "signer_role": "applicant", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "statutory_declaration", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Companies Registry", "form": "Written application requesting the Registrar to represent a dissolved company or its liqui", "channel": "paper", "government_fee": { "amount": 2980, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_dissolved", "type": null, "when": "The company is not dissolved." }, { "code": "obligation_not_proved", "type": null, "when": "The material does not show the company would be bound to complete the dealing." }, { "code": "act_is_discretionary", "type": null, "when": "The act needs judgment, so s.757 cannot be used; consider restoration." }, { "code": "dissolution_basis_not_covered", "type": null, "when": "The dissolution route is not listed in s.757." }, { "code": "instrument_count_invalid", "type": null, "when": "instrument_count must be at least 1 and match the drafts uploaded." } ] } }, "Params_hk_restored_company_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "description": "Taken from the entity when omitted." }, "restoration_date": { "type": "string", "format": "date", "description": "Date the company was restored." }, "name_en": { "type": "string", "description": "Intended English name." }, "name_zh": { "type": "string", "description": "Intended Chinese name, if any." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the members passed the special resolution." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How the resolution is passed." }, "signatory_role": { "type": "string", "enum": [ "director", "company_secretary" ], "description": "Who signs NNC2." } }, "required": [ "restoration_date", "name_en", "special_resolution_date", "resolution_method", "signatory_role" ], "description": "If, on the restoration date, Cap. 622 s.100 would have prohibited the former name, the company must within 28 days pass a special resolution changing its name and deliver Form NNC2 (s.770). The change takes effect when the certificate of." }, "Create_hk_restored_company_name_change": { "type": "object", "properties": { "type": { "const": "hk.restored_company_name.change" }, "params": { "$ref": "#/components/schemas/Params_hk_restored_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a restored company's name where the former name is now prohibited", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution changing the name", "source": "generated", "required": true }, { "key": "name_availability_check", "title": "Name availability check against s.100", "source": "generated", "required": true }, { "key": "nnc2", "title": "Form NNC2 Notice of Change of Company Name", "source": "generated", "required": true }, { "key": "certificate_of_change_of_name", "title": "Certificate of change of name", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nnc2", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nnc2", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NNC2 Notice of Change of Company Name", "channel": "both", "government_fee": { "amount": 295, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 28 days have passed since the restoration; the offence in s.770 has been committed." }, { "code": "name_prohibited", "type": null, "when": "The new name is prohibited by s.100; the Registrar will not enter it (s.770)." }, { "code": "no_officers_in_office", "type": null, "when": "Nobody is in office to sign NNC2; appoint a director first." }, { "code": "name_not_required", "type": null, "when": "The former name is still available; no change is needed." } ] } }, "Params_hk_society_dissolution_notify": { "type": "object", "properties": { "registration_status": { "type": "string", "enum": [ "registered", "exempted" ], "description": "The notice covers a registered society or an exempted society (s.14)." }, "certificate_number": { "type": "string", "description": "Number of the Certificate of Registration or Certificate of Exemption." }, "dissolution_effective_date": { "type": "string", "format": "date", "description": "Date the dissolution takes effect." }, "dissolution_basis": { "type": "string", "enum": [ "resolution_of_members", "expiry_or_event_under_constitution", "other" ], "description": "How the society dissolved itself." }, "dissolution_resolution_date": { "type": "string", "format": "date", "description": "Date of the members' resolution." }, "votes_in_favour_percent": { "type": "number", "description": "Share of votes in favour, for the record." }, "former_office_bearers": { "type": "array", "items": {}, "description": "person_ref list of the persons who were office-bearers immediately before the dissolution." }, "signing_office_bearers": { "type": "array", "items": {}, "description": "At least one of the former office-bearers who signs the notification (s.14)." }, "branches": { "type": "array", "items": {}, "description": "Registered or exempted branches to be de-registered with the society (s.14)." }, "asset_disposal_summary": { "type": "string", "description": "How the society's assets were applied, as its constitution requires." } }, "required": [ "registration_status", "certificate_number", "dissolution_effective_date", "dissolution_basis", "former_office_bearers", "signing_office_bearers" ], "description": "The former office-bearers notify the Societies Officer in writing, signed by one or more of them, not later than 1 month after the dissolution takes effect. The Societies Officer then de-registers the society and its branches and removes." }, "Create_hk_society_dissolution_notify": { "type": "object", "properties": { "type": { "const": "hk.society_dissolution.notify" }, "params": { "$ref": "#/components/schemas/Params_hk_society_dissolution_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Societies Officer that a registered or exempted society has dissolved", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dissolution_resolution", "title": "Members' resolution or minutes dissolving the society", "source": "uploaded", "required": true }, { "key": "notification_letter", "title": "Written notification of dissolution", "source": "generated", "required": true }, { "key": "original_certificate", "title": "Original Certificate of Registration or Certificate of Exemption", "source": "uploaded", "required": true }, { "key": "branch_list", "title": "List of branches", "source": "uploaded", "required": false }, { "key": "asset_disposal_record", "title": "Record of the disposal of assets", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "dissolution_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notification_letter", "signer_role": "officer", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Societies Office, Hong Kong Police Force", "form": "Written notification of dissolution signed", "channel": "paper", "government_fee": { "amount": null, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_registered_or_exempt", "type": null, "when": "The entity is not on the Societies Officer's list." }, { "code": "no_signing_office_bearer", "type": null, "when": "No former office-bearer is named as signatory." }, { "code": "deadline_passed", "type": null, "when": "More than 1 month since the dissolution took effect." }, { "code": "dissolution_resolution_missing", "type": null, "when": "No evidence the society dissolved itself." } ] } }, "Params_hk_strike_off_notice_respond": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "description": "Entity type." }, "trigger": { "type": "string", "enum": [ "not_in_operation", "liquidation_returns_overdue" ], "description": "not_in_operation or liquidation_returns_overdue." }, "notice_stage": { "type": "string", "enum": [ "inquiry_letter", "follow_up_letter", "gazette_notice" ], "description": "Inquiry letter, follow-up registered letter or Gazette notice." }, "notice_date": { "type": "string", "format": "date", "description": "Date of the notice; the 3 months run from a Gazette notice." }, "notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Upload of the notice." }, "position": { "type": "string", "enum": [ "in_operation", "not_in_operation" ], "description": "in_operation asks to stay on the register; not_in_operation: Entiva advises hk.company.deregister." }, "business_statement": { "type": "string", "description": "Business carried on; required for in_operation." } }, "required": [ "entity_type", "trigger", "notice_stage", "notice_date", "notice_document_id", "position" ], "description": "Only the Registrar can strike off a company believed not to be operating; a company cannot apply. This action answers the Registrar's inquiry, follow-up letter or Gazette notice and shows cause." }, "Create_hk_strike_off_notice_respond": { "type": "object", "properties": { "type": { "const": "hk.strike_off_notice.respond" }, "params": { "$ref": "#/components/schemas/Params_hk_strike_off_notice_respond" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Respond to a Registrar strike-off inquiry or notice", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registrar_notice", "title": "Registrar's letter or Gazette notice", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the reply", "source": "generated", "required": true }, { "key": "reply_letter", "title": "Reply letter to the Registrar", "source": "generated", "required": true }, { "key": "evidence_of_operation", "title": "Accounts, bank statements, invoices, BR certificate", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reply_letter", "signer_role": "authorised_representative", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Reply letter with evidence", "channel": "paper", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notice_window_closed", "type": null, "when": "Over 3 months since the Gazette notice; use hk.company.restore." }, { "code": "company_already_struck_off", "type": null, "when": "The Registry shows the company dissolved or unregistered." }, { "code": "evidence_missing", "type": null, "when": "in_operation without evidence." } ] } }, "Params_hk_winding_up_release_certify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "description": "Taken from the entity when omitted." }, "liquidators": { "type": "array", "items": {}, "description": "person_ref list of all liquidators in office." }, "court_action_number": { "type": "string", "description": "Winding-up action number." }, "release_order_date": { "type": "string", "format": "date", "description": "Date of the court order releasing the liquidator under s.205." }, "affairs_completely_wound_up": { "type": "boolean", "description": "Must be true (s.226A)." }, "deferral_order_date": { "type": "string", "format": "date", "description": "If the court defers the dissolution on application (s.226A proviso); an office copy of the order goes to the Registrar within 7 days (s.226A)." } }, "required": [ "liquidators", "court_action_number", "release_order_date", "affairs_completely_wound_up" ], "description": "In a winding up by the court, once the affairs are completely wound up and the court has released the liquidator under s.205, the liquidator delivers Form NW6. The company is dissolved 2 years after registration unless the court defers it." }, "Create_hk_winding_up_release_certify": { "type": "object", "properties": { "type": { "const": "hk.winding_up_release.certify" }, "params": { "$ref": "#/components/schemas/Params_hk_winding_up_release_certify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Certify release of a court-appointed liquidator and start dissolution", "x-entiva": { "jurisdiction": "hk", "stage": "closure", "applies_to": [ "private_ltd_shares", "public_ltd_shares", "guarantee_company", "unlimited_company", "open_ended_fund_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "release_order", "title": "Court order releasing the liquidator under s.205", "source": "uploaded", "required": true }, { "key": "nw6", "title": "Form NW6 Certificate of Release of Liquidator", "source": "generated", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nw6", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "nw6", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies Registry", "form": "Form NW6 Certificate of Release of Liquidator", "channel": "both", "government_fee": { "amount": 0, "currency": "HKD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_court_winding_up", "type": null, "when": "The winding up is voluntary; use hk.creditors_voluntary_winding_up.complete or the members' voluntary route." }, { "code": "release_order_missing", "type": null, "when": "No s.205 release order on file." }, { "code": "liquidator_missing_signature", "type": null, "when": "A joint liquidator has not signed." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_sg_business_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership" ], "description": "sole_proprietorship has one owner and is not separate from the owner. general_partnership has two or more partners with unlimited liability." }, "name_reservation_id": { "type": "string", "description": "act_ id of a completed sg.name.reserve action for the same entity type, made by Entiva's CSP and not older than 120 days.", "examples": [ "act_9Ma2ZhQd" ] }, "name": { "type": "string", "description": "Business name.", "examples": [ "Kopi & Co" ] }, "primary_ssic": { "type": "string", "description": "Required with proposed_name: primary business activity as an SSIC code.", "examples": [ "56102" ] }, "business_email": { "type": "string", "description": "The business's email address." }, "commencement_date": { "type": "string", "format": "date", "description": "Proposed date the business starts." }, "registration_period_years": { "type": "integer", "description": "1 or 3.", "examples": [ "1" ] }, "business_address": { "$ref": "#/components/schemas/Address", "description": "The business address.", "examples": [ "{\"line1\": \"12 Tiong Bahru Road\", \"line2\": \"#01-05\", \"city\": \"Singapore\", \"postal_code\": \"168728\", \"country\": \"SG\"}" ] }, "owners": { "type": "array", "items": {}, "description": "One owner for a sole proprietorship; 2 to 20 partners for a general partnership." }, "professional_partnership": { "type": "boolean", "description": "General partnership only: whether it is a professional partnership." }, "authorised_representative": { "type": "object", "description": "Required when no owner or partner lives in Singapore." }, "medisave_liabilities_confirmed": { "type": "boolean", "description": "Owners and partners confirm they have cleared MediSave liabilities or have a CPF instalment arrangement." }, "special_uen": { "type": "string", "description": "A special UEN from ACRA's list, choosable only when registering.", "examples": [ "201938474D" ] }, "represented_by_sg_professional": { "type": "boolean", "description": "True if a Singapore lawyer or public accountant represents the customer." } }, "required": [ "entity_type", "business_email", "commencement_date", "registration_period_years", "business_address", "owners" ], "description": "Register a sole proprietorship or a general partnership through Bizfile for one or three years. Foreign owners need a locally resident authorised representative." }, "Create_sg_business_register": { "type": "object", "properties": { "type": { "const": "sg.business.register" }, "params": { "$ref": "#/components/schemas/Params_sg_business_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Singapore sole proprietorship or general partnership", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "position_holder_consent", "title": "Owner, partner and representative consent to be registered", "source": "generated", "required": true }, { "key": "pass_issuer_consent", "title": "Pass-issuer consent for FIN holders", "source": "uploaded", "required": false }, { "key": "authorised_representative_appointment", "title": "Authorised representative appointment letter", "source": "generated", "required": false }, { "key": "beneficiary_details", "title": "Nominee or trustee beneficiary details", "source": "uploaded", "required": false }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": true }, { "key": "agent_authority_evidence", "title": "Evidence of the agent's authority", "source": "generated", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "registration_application", "title": "Registration application record", "source": "generated", "required": true }, { "key": "notice_of_registration", "title": "ACRA notice of successful registration", "source": "registry_issued", "required": true }, { "key": "business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "position_holder_consent", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "authorised_representative_appointment", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "customer_acceptance_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Register new business entity'", "channel": "online", "government_fee": { "amount": 100, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_required", "type": null, "when": "422 invalid_request_error." }, { "code": "name_reservation_invalid", "type": null, "when": "422 requirement_error. name_reservation_id is expired, for another entity type, withdrawn, or not reserved by Entiva's CSP." }, { "code": "owner_count_invalid", "type": null, "when": "422 requirement_error." }, { "code": "authorised_representative_required", "type": null, "when": "422 requirement_error." }, { "code": "three_year_not_eligible", "type": null, "when": "422 requirement_error. registration_period_years is 3 but the CPF Board's conditions are not met." }, { "code": "live_video_call_required", "type": null, "when": "422 requirement_error." }, { "code": "edd_evidence_required", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." } ] } }, "Params_sg_business_name_register": { "type": "object", "properties": { "business_name": { "type": "string", "description": "Proposed name without a legal suffix such as Pte Ltd.", "examples": [ "Lumen Freight Labs" ] }, "business_structure": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership" ], "description": "Structure under the Business Names Registration Act.", "examples": [ "sole_proprietorship" ] }, "owner_position": { "type": "string", "enum": [ "owner", "partner" ], "description": "The entity's position holder role.", "examples": [ "owner" ] }, "co_partners": { "type": "array", "items": {}, "description": "Other partners as person_ref or entity_ref.", "examples": [ "[\"ent_1QzPart2\"]" ] }, "primary_ssic_code": { "type": "string", "description": "Primary SSIC activity code.", "examples": [ "62011" ] }, "secondary_ssic_codes": { "type": "array", "items": {}, "description": "Further SSIC codes.", "examples": [ "[\"62021\"]" ] }, "commencement_date": { "type": "string", "format": "date", "description": "Proposed start of the business.", "examples": [ "2026-11-01" ] }, "business_email": { "type": "string", "description": "Business email.", "examples": [ "hello@lumenlabs.example" ] }, "business_address": { "$ref": "#/components/schemas/Address", "description": "Business address.", "examples": [ "{\"line1\":\"1 Raffles Place\",\"unit\":\"#20-01\",\"postal_code\":\"048616\",\"country\":\"SG\"}" ] }, "registration_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "1 year is the default. 3 years is only offered if CPF Board conditions are met, which ACRA aims at individual owners.", "examples": [ "1_year" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Required when all owners or partners are not locally resident: one ordinarily resident representative.", "examples": [ "per_1QzAr5nG" ] }, "is_nominee_or_trustee": { "type": "boolean", "description": "True if the entity holds the position as nominee or trustee; beneficiary details are then required.", "examples": [ "false" ] }, "name_reservation_number": { "type": "string", "description": "Existing Bizfile name eService number, if Entiva's CSP already reserved the name.", "examples": [ "NR202610170012" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director, manager or authorised representative who signs for the owner entity.", "examples": [ "per_1QzDir3kH" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "business_name", "business_structure", "owner_position", "primary_ssic_code", "commencement_date", "business_email", "business_address", "registration_period", "authorised_signatory", "name", "nature_of_business", "countries_of_operation", "directors", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a trading name under which a Singapore company, LLP or foreign company branch carries on business. Entiva's CSP reserves the name on Bizfile, then registers the business with the corporation as owner or partner." }, "Create_sg_business_name_register": { "type": "object", "properties": { "type": { "const": "sg.business_name.register" }, "params": { "$ref": "#/components/schemas/Params_sg_business_name_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a business name owned by a company or LLP", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "Owner's resolution to register the business and trading name", "source": "generated", "required": true }, { "key": "name_consent_or_justification", "title": "Consent letter or justification for the name", "source": "uploaded", "required": false }, { "key": "home_office_approval", "title": "HDB or URA home-office approval", "source": "uploaded", "required": false }, { "key": "beneficiary_details", "title": "Beneficiary details for nominee or trustee holdings", "source": "uploaded", "required": false }, { "key": "name_reservation_confirmation", "title": "Bizfile name application confirmation", "source": "registry_issued", "required": false }, { "key": "business_profile", "title": "ACRA Business Profile of the registered business", "source": "registry_issued", "required": false }, { "key": "bizfile_name_application", "title": "Bizfile name application", "source": "generated", "required": true }, { "key": "bizfile_business_registration", "title": "Bizfile business registration", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_name_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "bizfile_business_registration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile: Apply for new business entity name, then Register new business entity", "channel": "online", "government_fee": { "amount": 115, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_unavailable", "type": null, "when": "ACRA rejects the name as identical, similar or not allowed." }, { "code": "name_reservation_expired", "type": null, "when": "More than 120 days have passed since the name was reserved." }, { "code": "authorised_representative_required", "type": null, "when": "All owners or partners are non-resident and no representative is given." }, { "code": "three_year_registration_unavailable", "type": null, "when": "CPF Board conditions for 3-year registration are not met." }, { "code": "business_address_invalid", "type": null, "when": "The address is a P.O." }, { "code": "name_reserver_mismatch", "type": null, "when": "The name was reserved by someone other than the registering CSP." }, { "code": "entity_type_not_supported", "type": null, "when": "The owner entity type is not in applies_to." } ] } }, "Params_sg_business_name_renew": { "type": "object", "properties": { "business_uen": { "type": "string", "description": "UEN of the registered business to renew.", "examples": [ "53456789K" ] }, "renewal_period": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "3 years needs no outstanding MediSave payable, or 24 consecutive months on a CPF instalment plan; ACRA states these for owners.", "examples": [ "1_year" ] }, "continue_business": { "type": "boolean", "description": "Must be true.", "examples": [ "true" ] }, "medisave_arrangement_confirmed": { "type": "boolean", "description": "For individual owners or partners: confirms the CPF Board MediSave arrangement.", "examples": [ "true" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Authorised signatory of the owner entity.", "examples": [ "per_1QzDir3kH" ] } }, "required": [ "business_uen", "renewal_period", "continue_business", "authorised_signatory" ], "description": "Renews the Bizfile registration of a business owned by a company, LLP or foreign branch for 1 or 3 years. Entiva's CSP renews up to 60 days before expiry so the business never trades on an expired registration." }, "Create_sg_business_name_renew": { "type": "object", "properties": { "type": { "const": "sg.business_name.renew" }, "params": { "$ref": "#/components/schemas/Params_sg_business_name_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a registered business name", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "renewal_instruction", "title": "Renewal instruction", "source": "generated", "required": true }, { "key": "renewal_receipt", "title": "Bizfile renewal receipt", "source": "registry_issued", "required": false }, { "key": "business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": false }, { "key": "bizfile_renewal", "title": "Bizfile renewal", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "renewal_instruction", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bizfile_renewal", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile: Manage, Sole proprietorship/partnership, Renew business registration", "channel": "online", "government_fee": { "amount": 30, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "renewal_window_not_open", "type": null, "when": "More than 60 days remain before expiry." }, { "code": "registration_cancelled", "type": null, "when": "ACRA has cancelled the registration; restoration is needed first." }, { "code": "medisave_outstanding", "type": null, "when": "Outstanding MediSave payable with no CPF Board arrangement." }, { "code": "three_year_renewal_ineligible", "type": null, "when": "The 3-year conditions are not met." }, { "code": "business_not_found", "type": null, "when": "business_uen is not registered under this entity." }, { "code": "business_ceasing", "type": null, "when": "continue_business is false; use the closure flow." } ] } }, "Params_sg_business_trust_register": { "type": "object", "properties": { "trust_name": { "type": "string", "description": "Name of the business trust.", "examples": [ "Harbour Logistics Business Trust" ] }, "trustee_manager_entity_id": { "type": "string", "pattern": "^ent_", "description": "The proposed trustee-manager: a Singapore company that is not an exempt private company, formed first with sg.company.incorporate.", "examples": [ "ent_1QzTm3vH8cZp" ] }, "trust_business_description": { "type": "string", "description": "Business the trust will carry on.", "examples": [ "Owning and leasing logistics warehouses in Singapore" ] }, "offer_basis": { "type": "string", "enum": [ "public_offer_with_registered_prospectus", "exempt_min_transaction_s200k", "exempt_small_offer_s5m_12m", "exempt_private_placement_50_persons_12m", "exempt_accredited_or_institutional_investors" ], "description": "How units will be offered.", "examples": [ "public_offer_with_registered_prospectus" ] }, "unit_classes": { "type": "array", "items": {}, "description": "Description of the unit classes to be offered.", "examples": [ "[\"Ordinary units\"]" ] }, "trust_deed": { "type": "string", "pattern": "^doc_", "description": "Executed trust deed.", "examples": [ "doc_1QzTd1" ] }, "trustee_manager_directors": { "type": "array", "items": {}, "description": "person_refs of all directors.", "examples": [ "[\"per_1QzBt1\",\"per_1QzBt2\",\"per_1QzBt3\"]" ] }, "trustee_manager_ceo": { "type": "string", "pattern": "^per_", "description": "Chief executive.", "examples": [ "per_1QzBt4" ] }, "trustee_manager_secretary": { "type": "string", "pattern": "^per_", "description": "Secretary meeting the qualification or experience criteria in s7.", "examples": [ "per_1QzBt5" ] }, "audit_committee_members": { "type": "array", "items": {}, "description": "person_refs.", "examples": [ "[\"per_1QzBt2\",\"per_1QzBt3\"]" ] }, "substantial_shareholders": { "type": "array", "items": {}, "description": "person_refs or entity_refs of substantial shareholders of the trustee-manager.", "examples": [ "[\"ent_1QzSh1\"]" ] }, "sole_business_confirmed": { "type": "boolean", "description": "Confirms the trustee-manager carries on no business other than managing and operating the trust (s6).", "examples": [ "true" ] }, "singapore_counsel": { "type": "object", "description": "{firm, contact_name, email} of the Singapore counsel who files with the trustee-manager.", "examples": [ "{\"firm\":\"Lim & Co LLP\",\"contact_name\":\"A. Lim\",\"email\":\"a.lim@limco.example\"}" ] }, "prospectus_registration_reference": { "type": "string", "description": "MAS reference for the registered prospectus and product highlights sheet, if the offer is public.", "examples": [ "PRO-2026-0042" ] }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Contact for MAS.", "examples": [ "per_1QzBt1" ] } }, "required": [ "trust_name", "trustee_manager_entity_id", "trust_business_description", "offer_basis", "trust_deed", "trustee_manager_directors", "trustee_manager_secretary", "audit_committee_members", "substantial_shareholders", "sole_business_confirmed", "singapore_counsel", "contact_person" ], "description": "Prepares the application by the proposed trustee-manager to MAS to register a business trust under the Business Trusts Act 2004, required before units are offered to the public. Entiva checks the trustee-manager against the statute." }, "Create_sg_business_trust_register": { "type": "object", "properties": { "type": { "const": "sg.business_trust.register" }, "params": { "$ref": "#/components/schemas/Params_sg_business_trust_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a business trust with MAS", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "registered_business_trust" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trust_deed", "title": "Trust deed", "source": "uploaded", "required": true }, { "key": "opera_form_2_data", "title": "OPERA Form 2 data sheet", "source": "generated", "required": true }, { "key": "trustee_manager_constitution", "title": "Trustee-manager constitution", "source": "uploaded", "required": true }, { "key": "trustee_manager_business_profile", "title": "ACRA Business Profile of the trustee-manager", "source": "registry_issued", "required": true }, { "key": "board_resolution", "title": "Trustee-manager board resolution to apply", "source": "generated", "required": true }, { "key": "officer_declarations", "title": "Director, CEO, secretary and shareholder declarations", "source": "generated", "required": true }, { "key": "audit_committee_terms", "title": "Audit committee terms of reference", "source": "uploaded", "required": true }, { "key": "secretary_qualification_evidence", "title": "Secretary qualification or experience evidence", "source": "uploaded", "required": true }, { "key": "counsel_engagement_letter", "title": "Singapore counsel engagement letter", "source": "uploaded", "required": true }, { "key": "prospectus_and_phs", "title": "Registered prospectus and product highlights sheet", "source": "uploaded", "required": false }, { "key": "mas_registration_notice", "title": "MAS registration confirmation", "source": "registry_issued", "required": false }, { "key": "opera_form_2_submission", "title": "Opera form 2 submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "trust_deed", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "officer_declarations", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "opera_form_2_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Monetary Authority of Singapore", "form": "Form 2: registration of business trust", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "registration_not_required", "type": null, "when": "offer_basis is an exempt basis, so MAS registration is not needed." }, { "code": "trustee_manager_not_eligible", "type": null, "when": "The trustee-manager is not a company, or is an exempt private company." }, { "code": "trustee_manager_other_business", "type": null, "when": "sole_business_confirmed is false." }, { "code": "trust_deed_not_executed", "type": null, "when": "No wet-ink executed deed is on file." }, { "code": "board_requirements_not_met", "type": null, "when": "Board or audit committee does not meet MAS requirements." }, { "code": "secretary_not_qualified", "type": null, "when": "The secretary lacks s7 qualification or experience evidence." }, { "code": "officer_disqualifying_matter", "type": null, "when": "A declaration discloses a conviction, insolvency or similar ground MAS can refuse on." }, { "code": "counsel_not_engaged", "type": null, "when": "No Singapore counsel engagement is recorded." } ] } }, "Params_sg_charity_register": { "type": "object", "properties": { "charity_name": { "type": "string", "description": "Name to register.", "examples": [ "Harbour Reading Fund" ] }, "establishment_date": { "type": "string", "format": "date", "description": "Date the organisation was established.", "examples": [ "2026-09-15" ] }, "charitable_purposes": { "type": "array", "items": {}, "description": "One or more of relief_of_poverty, advancement_of_education, advancement_of_religion, other_community_benefit.", "examples": [ "[\"advancement_of_education\"]" ] }, "other_community_benefit_detail": { "type": "string", "description": "Required for other_community_benefit.", "examples": [ "Literacy support for children" ] }, "purposes_exclusively_charitable": { "type": "boolean", "description": "Confirms the governing instrument states exclusively charitable purposes.", "examples": [ "true" ] }, "beneficiary_description": { "type": "string", "description": "Who benefits.", "examples": [ "Primary school children in Singapore" ] }, "governing_board": { "type": "array", "items": {}, "description": "person_refs of board members.", "examples": [ "[\"per_1QzB1\",\"per_1QzB2\",\"per_1QzB3\"]" ] }, "governing_instrument": { "type": "string", "pattern": "^doc_", "description": "Signed constitution or governing instrument.", "examples": [ "doc_1QzGi1" ] }, "activities_plan": { "type": "string", "pattern": "^doc_", "description": "Completed 2-year activities and fund disbursement plan.", "examples": [ "doc_1QzAp2" ] }, "financial_statements": { "type": "array", "items": {}, "description": "document_refs of signed financial statements for the last 3 financial years, if applicable.", "examples": [ "[]" ] }, "grantmaker_scheme": { "type": "boolean", "description": "True for a self-funded grantmaker that cannot meet all conditions and applies under the Grantmakers Scheme.", "examples": [ "false" ] }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Contact for the Commissioner.", "examples": [ "per_1QzB1" ] }, "submitting_officer": { "type": "string", "pattern": "^per_", "description": "Authorised officer who logs in to the Charity Portal and submits.", "examples": [ "per_1QzB1" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "charity_name", "establishment_date", "charitable_purposes", "purposes_exclusively_charitable", "beneficiary_description", "governing_board", "governing_instrument", "activities_plan", "contact_person", "submitting_officer", "name", "nature_of_business", "countries_of_operation", "directors", "members", "beneficial_owners" ], "description": "Applies to the Commissioner of Charities to register an existing company limited by guarantee or registered society as a charity. Entiva checks the governing board and purposes against the published criteria, prepares the Excel." }, "Create_sg_charity_register": { "type": "object", "properties": { "type": { "const": "sg.charity.register" }, "params": { "$ref": "#/components/schemas/Params_sg_charity_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a company limited by guarantee or society as a charity", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "public_ltd_guarantee", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "charity_application_form", "title": "Application Form for Registration as a Charity", "source": "generated", "required": true }, { "key": "governing_instrument", "title": "Signed governing instrument", "source": "uploaded", "required": true }, { "key": "activities_plan", "title": "2-year activities and fund disbursement plan", "source": "uploaded", "required": true }, { "key": "signed_financial_statements", "title": "Signed financial statements, last 3 financial years", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution approving the application", "source": "generated", "required": true }, { "key": "board_member_declarations", "title": "Governing board eligibility declarations", "source": "generated", "required": true }, { "key": "entity_registration_evidence", "title": "ACRA Business Profile or ROS registration evidence", "source": "registry_issued", "required": false }, { "key": "charity_registration_notice", "title": "Commissioner of Charities registration notice", "source": "registry_issued", "required": false }, { "key": "charity_portal_submission", "title": "Charity portal submission", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_member_declarations", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "governing_instrument", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "signed_financial_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charity_portal_submission", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Commissioner of Charities", "form": "Application for Registration as a Charity", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "board_composition_invalid", "type": null, "when": "Fewer than 3 members, or fewer than 2 Singapore citizens or PRs." }, { "code": "board_member_ineligible", "type": null, "when": "A member's declaration shows a disqualifying conviction, bankruptcy, directorship disqualification or removal." }, { "code": "purposes_not_exclusively_charitable", "type": null, "when": "The governing instrument's purposes are not exclusively charitable or fund-raising is the only purpose." }, { "code": "entity_not_registered", "type": null, "when": "The organisation is not yet registered with ACRA or ROS." }, { "code": "registration_window_passed", "type": null, "when": "More than 3 months since establishment; the application may still be made but is flagged." }, { "code": "governing_instrument_unsigned", "type": null, "when": "The governing instrument copy has no signature." }, { "code": "activities_plan_missing", "type": null, "when": "The 2-year plan is missing or incomplete." } ] } }, "Params_sg_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "description": "The company type." }, "unlimited_company_class": { "type": "string", "enum": [ "private", "exempt_private", "public" ], "description": "Required when entity_type is unlimited_company: private, exempt private or public." }, "name_reservation_id": { "type": "string", "description": "act_ id of a completed sg.name.reserve action for the same entity type, made by Entiva's CSP and not older than 120 days.", "examples": [ "act_5Hc2YpVd" ] }, "name": { "type": "string", "description": "Name without a legal suffix.", "examples": [ "Northwind Labs" ] }, "primary_ssic": { "type": "string", "description": "Required with proposed_name: primary business activity as an SSIC code.", "examples": [ "62011" ] }, "services": { "type": "array", "items": {}, "description": "Entiva services to attach: registered_office, company_secretary, nominee_resident_director." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Required unless services includes registered_office.", "examples": [ "{\"line1\": \"10 Anson Road\", \"line2\": \"#12-01\", \"city\": \"Singapore\", \"postal_code\": \"079903\", \"country\": \"SG\"}" ] }, "company_email": { "type": "string", "description": "The company's email address for Bizfile." }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day of the financial year end as MM-DD.", "examples": [ "12-31" ] }, "directors": { "type": "array", "items": {}, "description": "Proposed directors." }, "secretary": { "type": "object", "description": "Object {person: per_ id}." }, "shareholders": { "type": "array", "items": {}, "description": "First members." }, "share_capital": { "type": "object", "description": "Required except for public_ltd_guarantee." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required for public_ltd_guarantee: the amount each member guarantees, with its currency.", "examples": [ "{\"amount\": 100000, \"currency\": \"SGD\"}" ] }, "constitution_type": { "type": "string", "enum": [ "model", "custom" ], "description": "model uses the Model Constitution under the Companies Regulations 2015. custom needs constitution_document." }, "model_constitution_mode": { "type": "string", "enum": [ "in_force_from_time_to_time", "in_force_at_a_point_in_time" ], "description": "Required when constitution_type is model. in_force_from_time_to_time follows later changes to the Model Constitution automatically. in_force_at_a_point_in_time." }, "constitution_document": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_type is custom." }, "rorc": { "type": "object", "description": "RORC declaration." }, "nominee_registers": { "type": "object", "description": "Declaration for the Registers of Nominee Directors and Nominee Shareholders." }, "special_uen": { "type": "string", "description": "A special UEN from ACRA's list, choosable only when registering.", "examples": [ "201938474D" ] }, "represented_by_sg_professional": { "type": "boolean", "description": "True if a Singapore lawyer or public accountant represents the customer." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "entity_type", "company_email", "financial_year_end", "directors", "shareholders", "constitution_type", "rorc", "nominee_registers", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Incorporate a private, exempt private, public, guarantee or unlimited company through Bizfile. Entiva's CSP files, each director signs Form 45 personally, and controller and nominee information is lodged with ACRA on the incorporation." }, "Create_sg_company_incorporate": { "type": "object", "properties": { "type": { "const": "sg.company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_sg_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Singapore company", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "constitution", "title": "Constitution", "source": "generated", "required": true }, { "key": "subscriber_share_declaration", "title": "Subscribers' declaration of shares taken", "source": "generated", "required": true }, { "key": "form_45", "title": "Form 45: consent to act as director and statement of non-disqualification", "source": "generated", "required": true }, { "key": "form_45b", "title": "Form 45B: consent to act as secretary", "source": "generated", "required": false }, { "key": "pass_issuer_consent", "title": "Pass-issuer consent for FIN holders", "source": "uploaded", "required": false }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": true }, { "key": "agent_authority_evidence", "title": "Evidence of the agent's authority", "source": "generated", "required": false }, { "key": "ownership_and_control_chart", "title": "Ownership and control chart down to each natural person", "source": "uploaded", "required": false }, { "key": "nominee_disclosure", "title": "Nominee disclosure to the company", "source": "generated", "required": false }, { "key": "controller_confirmation", "title": "Controller's dated confirmation of particulars", "source": "generated", "required": false }, { "key": "exemption_evidence", "title": "Evidence of an exemption claimed", "source": "uploaded", "required": false }, { "key": "share_certificates", "title": "Share certificates", "source": "generated", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "incorporation_application", "title": "Incorporation application record", "source": "generated", "required": true }, { "key": "notice_of_incorporation", "title": "ACRA notice of successful incorporation", "source": "registry_issued", "required": true }, { "key": "business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "nominee_director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "form_45", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_45b", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "subscriber_share_declaration", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "share_certificates", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "controller_confirmation", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nominee_disclosure", "signer_role": "nominee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "customer_acceptance_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "incorporation_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Register new business entity'", "channel": "online", "government_fee": { "amount": 300, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_required", "type": null, "when": "422 invalid_request_error." }, { "code": "name_reservation_invalid", "type": null, "when": "422 requirement_error. name_reservation_id is expired, for another entity type, withdrawn, or not reserved by Entiva's CSP." }, { "code": "entity_type_not_supported", "type": null, "when": "422 jurisdiction_error." }, { "code": "resident_director_required", "type": null, "when": "422 requirement_error." }, { "code": "secretary_conflict", "type": null, "when": "422 requirement_error." }, { "code": "member_limit_exceeded", "type": null, "when": "422 requirement_error." }, { "code": "share_capital_invalid", "type": null, "when": "422 invalid_request_error." }, { "code": "controller_unconfirmed", "type": null, "when": "409 requirement_error." }, { "code": "live_video_call_required", "type": null, "when": "422 requirement_error." }, { "code": "edd_evidence_required", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." }, { "code": "human_presence_required", "type": null, "when": "403 permission_error." }, { "code": "mandate_required", "type": null, "when": "403 permission_error." }, { "code": "registry_rejected", "type": null, "when": "502 registry_error." } ] } }, "Params_sg_cooperative_society_register": { "type": "object", "properties": { "society_name": { "type": "string", "description": "Proposed name of the society.", "examples": [ "Harbour Neighbours Co-operative" ] }, "cooperative_type": { "type": "string", "enum": [ "credit", "non_credit" ], "description": "credit uses Form 1 and needs a pre-existing common bond; non_credit uses Form 2.", "examples": [ "non_credit" ] }, "common_bond": { "type": "string", "description": "Required for credit: the community, industry or employer that links members.", "examples": [ "Residents of Bukit Merah" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Proposed registered office.", "examples": [ "{\"line1\":\"3 Telok Blangah Street\",\"postal_code\":\"098999\",\"country\":\"SG\"}" ] }, "postal_address": { "$ref": "#/components/schemas/Address", "description": "Postal address if different.", "examples": [ "{\"line1\":\"PO Box 1\",\"postal_code\":\"098999\",\"country\":\"SG\"}" ] }, "objectives": { "type": "string", "description": "Objectives; must promote members' economic or social interests and/or the public, in line with co-operative principles.", "examples": [ "Bulk purchasing of groceries for member households" ] }, "services": { "type": "string", "description": "Services to be provided.", "examples": [ "Group buying and delivery" ] }, "target_membership_profile": { "type": "string", "description": "Target members.", "examples": [ "Households in Bukit Merah" ] }, "estimated_members": { "type": "object", "description": "{year_1, year_2, year_3} expected individual members.", "examples": [ "{\"year_1\":60,\"year_2\":120,\"year_3\":200}" ] }, "pro_tem_committee": { "type": "array", "items": {}, "description": "person_refs, at least 3.", "examples": [ "[\"per_1QzCo1\",\"per_1QzCo2\",\"per_1QzCo3\"]" ] }, "proposed_committee_of_management": { "type": "array", "items": {}, "description": "person_refs with qualifications and experience.", "examples": [ "[\"per_1QzCo1\",\"per_1QzCo2\",\"per_1QzCo3\"]" ] }, "founding_members": { "type": "array", "items": {}, "description": "person_refs of at least 5 qualified individuals, each at least 16 and a Singapore citizen or resident.", "examples": [ "[\"per_1QzFm1\",\"per_1QzFm2\",\"per_1QzFm3\",\"per_1QzFm4\",\"per_1QzFm5\"]" ] }, "founding_institutions": { "type": "array", "items": {}, "description": "entity_refs of at least 2 institutional members, each with at least 2 authorised signatories.", "examples": [ "[]" ] }, "school_cooperative": { "type": "boolean", "description": "True for a school co-op.", "examples": [ "false" ] }, "viability_statement": { "type": "string", "pattern": "^doc_", "description": "Viability statement with business plan.", "examples": [ "doc_1QzVs1" ] }, "financial_projections": { "type": "string", "pattern": "^doc_", "description": "3-year balance sheet, income and expenditure, and cash flow projections.", "examples": [ "doc_1QzFp2" ] }, "proposed_bylaws": { "type": "string", "pattern": "^doc_", "description": "By-laws meeting the Schedule to the Co-operative Societies Act.", "examples": [ "doc_1QzBl3" ] }, "registrar_comments": { "type": "string", "pattern": "^doc_", "description": "Registrar's comments on the draft by-laws.", "examples": [ "doc_1QzRc4" ] }, "preliminary_meeting": { "type": "object", "description": "{date, attendees, approvals}: at least 5 qualified persons present, by-laws adopted.", "examples": [ "{\"date\":\"2026-11-20\",\"attendees\":8,\"approvals\":8}" ] }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Contact for the Registry.", "examples": [ "per_1QzCo1" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "society_name", "cooperative_type", "registered_office", "objectives", "services", "target_membership_profile", "estimated_members", "pro_tem_committee", "proposed_committee_of_management", "founding_members", "viability_statement", "financial_projections", "proposed_bylaws", "contact_person", "name", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Prepares the Registry of Co-operative Societies application with the viability statement, business plan, three-year projections, by-laws commented on by the Registrar, and the signed minutes of the preliminary meeting. The pro-tem." }, "Create_sg_cooperative_society_register": { "type": "object", "properties": { "type": { "const": "sg.cooperative_society.register" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a co-operative society", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "registration_form", "title": "Form 1 or Form 2 with Annexes A and B", "source": "generated", "required": true }, { "key": "viability_statement", "title": "Viability statement and business plan", "source": "uploaded", "required": true }, { "key": "financial_projections", "title": "Three-year financial projections", "source": "uploaded", "required": true }, { "key": "proposed_bylaws", "title": "Proposed by-laws", "source": "uploaded", "required": true }, { "key": "registrar_comments", "title": "Registrar's comments on draft by-laws", "source": "uploaded", "required": true }, { "key": "preliminary_meeting_minutes", "title": "Minutes of the preliminary meeting signed by all present", "source": "generated", "required": true }, { "key": "registration_notice", "title": "Notice of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "member", "verification_level": "identity" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "registration_form", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "preliminary_meeting_minutes", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Form 1", "channel": "both", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "founding_members_below_minimum", "type": null, "when": "Fewer than 5 qualified individuals, or fewer than 2 institutions each with 2 authorised persons." }, { "code": "member_not_eligible", "type": null, "when": "A member is under the minimum age or is not a Singapore citizen or resident." }, { "code": "pro_tem_committee_too_small", "type": null, "when": "Fewer than 3 committee members." }, { "code": "registrar_comments_missing", "type": null, "when": "The final application is attempted before the Registrar has commented on the draft by-laws." }, { "code": "common_bond_missing", "type": null, "when": "A credit co-op has no common bond." }, { "code": "preliminary_meeting_invalid", "type": null, "when": "Fewer than 5 qualified persons attended or the minutes are not fully signed." }, { "code": "projections_incomplete", "type": null, "when": "Any of the three 3-year statements is missing." } ] } }, "Params_sg_corppass_form": { "type": "object", "properties": { "corppass_admins": { "type": "array", "items": {}, "description": "People who will administer the entity's Corppass." }, "authorise_entiva_for": { "type": "array", "items": {}, "description": "E-services the Admin authorises Entiva for." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "corppass_admins", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Guide the entity's Corppass Admin through applying for Corppass once ACRA has issued the UEN, and record the access they give Entiva for IRAS and other government e-services. There is no separate tax ID application, because ACRA issues." }, "Create_sg_corppass_form": { "type": "object", "properties": { "type": { "const": "sg.corppass.form" }, "params": { "$ref": "#/components/schemas/Params_sg_corppass_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up Corppass for a new Singapore entity", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "uen_notice", "title": "ACRA notice of registration showing the UEN", "source": "registry_issued", "required": true }, { "key": "corppass_admin_designation", "title": "Corppass Admin designation", "source": "generated", "required": true }, { "key": "corppass_application_confirmation", "title": "Corppass application confirmation", "source": "uploaded", "required": true }, { "key": "authorisation_confirmation", "title": "Confirmation of access granted to Entiva", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "corppass_application_confirmation", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "authorisation_confirmation", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "corppass_admin_designation", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "GovTech Corppass", "form": "Corppass admin application for a UEN-registered entity, applied for online. There is no se", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "uen_not_issued", "type": null, "when": "409 requirement_error." }, { "code": "admin_not_officer", "type": null, "when": "422 requirement_error." }, { "code": "admin_has_no_singpass", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." }, { "code": "human_presence_required", "type": null, "when": "403 permission_error." } ] } }, "Params_sg_foreign_company_register": { "type": "object", "properties": { "name_reservation_id": { "type": "string", "description": "act_ id of a completed sg.name.reserve action with entity_type foreign_company_branch, made by Entiva's CSP and not older than 120 days.", "examples": [ "act_3Qy7VdLk" ] }, "name": { "type": "string", "description": "Name to register in Singapore.", "examples": [ "Orion Cargo" ] }, "primary_ssic": { "type": "string", "description": "Required with proposed_name: primary business activity as an SSIC code.", "examples": [ "52291" ] }, "branch_email": { "type": "string", "description": "Business email address for the Singapore branch." }, "home_country": { "type": "string", "description": "ISO 3166 country where the company is incorporated or registered." }, "foreign_registration_number": { "type": "string", "description": "The company's registration number in its home jurisdiction." }, "home_incorporation_date": { "type": "string", "format": "date", "description": "Date of incorporation in the home jurisdiction." }, "legal_form": { "type": "string", "description": "Legal form in the home jurisdiction." }, "has_share_capital": { "type": "boolean", "description": "Whether the foreign company has share capital." }, "home_registered_office_address": { "$ref": "#/components/schemas/Address", "description": "Registered office address in the home jurisdiction.", "examples": [ "{\"line1\": \"251 Little Falls Drive\", \"city\": \"Wilmington\", \"region\": \"DE\", \"postal_code\": \"19808\", \"country\": \"US\"}" ] }, "business_description": { "type": "string", "description": "Description of the company's business, for the notice that states its home registration number, business and legal form." }, "services": { "type": "array", "items": {}, "description": "Entiva services to attach: registered_office." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Required unless services includes registered_office.", "examples": [ "{\"line1\": \"6 Battery Road\", \"line2\": \"#10-01\", \"city\": \"Singapore\", \"postal_code\": \"049909\", \"country\": \"SG\"}" ] }, "directors": { "type": "array", "items": {}, "description": "The foreign company's directors, filed as position holders." }, "authorised_representatives": { "type": "array", "items": {}, "description": "At least one natural person ordinarily resident in Singapore." }, "certificate_of_incorporation": { "type": "string", "pattern": "^doc_", "description": "Certificate of incorporation or registration, certified as a true copy by an official of the home registry who holds the original." }, "certificate_certified_on": { "type": "string", "format": "date", "description": "Date the certificate of incorporation was certified." }, "constitution_document": { "type": "string", "pattern": "^doc_", "description": "The foreign company's charter, constitution, or memorandum and articles." }, "constitution_certified_by": { "type": "string", "enum": [ "home_registry_official", "notary_public", "officer_affidavit_or_statutory_declaration", "lodging_rqi" ], "description": "Who certified the constitution as a true copy." }, "constitution_certified_on": { "type": "string", "format": "date", "description": "Date the constitution was certified." }, "rorc": { "type": "object", "description": "RORC declaration." }, "nominee_registers": { "type": "object", "description": "Register of Nominee Directors declaration." }, "represented_by_sg_professional": { "type": "boolean", "description": "True if a Singapore lawyer or public accountant represents the customer." } }, "required": [ "branch_email", "home_country", "foreign_registration_number", "home_incorporation_date", "legal_form", "has_share_capital", "home_registered_office_address", "business_description", "directors", "authorised_representatives", "certificate_of_incorporation", "certificate_certified_on", "constitution_document", "constitution_certified_by", "constitution_certified_on", "rorc", "nominee_registers" ], "description": "Register a foreign company that will set up a place of business in Singapore. Only a registered CSP can file, so Entiva's CSP always does." }, "Create_sg_foreign_company_register": { "type": "object", "properties": { "type": { "const": "sg.foreign_company.register" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a foreign company as a Singapore branch", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "certificate_of_incorporation", "title": "Certified certificate of incorporation", "source": "uploaded", "required": true }, { "key": "constitution_certified", "title": "Certified constitution", "source": "uploaded", "required": true }, { "key": "officer_affidavit", "title": "Director's, manager's or secretary's affidavit or statutory declaration certifying the constitution", "source": "uploaded", "required": false }, { "key": "home_financial_statements", "title": "Latest home-country financial statements", "source": "uploaded", "required": false }, { "key": "certified_translations", "title": "Certified English translations", "source": "uploaded", "required": false }, { "key": "incumbency_certificate", "title": "Register of directors or incumbency certificate", "source": "uploaded", "required": true }, { "key": "ownership_and_control_chart", "title": "Ownership and control chart down to each natural person", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Foreign company board resolution", "source": "generated", "required": true }, { "key": "authorised_representative_appointment", "title": "Memorandum of appointment of the authorised representative", "source": "generated", "required": true }, { "key": "authorised_representative_consent", "title": "Authorised representative's consent to act", "source": "generated", "required": true }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": true }, { "key": "agent_authority_evidence", "title": "Evidence of the agent's authority", "source": "generated", "required": false }, { "key": "controller_confirmation", "title": "Controller's dated confirmation of particulars", "source": "generated", "required": false }, { "key": "nominee_disclosure", "title": "Nominee disclosure to the company", "source": "generated", "required": false }, { "key": "exemption_evidence", "title": "Evidence of an exemption claimed", "source": "uploaded", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "registration_application", "title": "Registration application record", "source": "generated", "required": true }, { "key": "power_of_attorney", "title": "Power of attorney appointing the authorised representative", "source": "generated", "required": false }, { "key": "notice_of_registration", "title": "ACRA notice of successful registration", "source": "registry_issued", "required": true }, { "key": "business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "authorised_representative_appointment", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "power_of_attorney", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "authorised_representative_consent", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "officer_affidavit", "signer_role": "officer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "certificate_of_incorporation", "signer_role": "officer", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "constitution_certified", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_translations", "signer_role": "translator", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "controller_confirmation", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nominee_disclosure", "signer_role": "nominee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "customer_acceptance_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile foreign company registration, with the certified certificate of incorporation, cer", "channel": "online", "government_fee": { "amount": 300, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_required", "type": null, "when": "422 invalid_request_error." }, { "code": "name_reservation_invalid", "type": null, "when": "422 requirement_error. name_reservation_id is expired, for another entity type, withdrawn, or not reserved by Entiva's CSP." }, { "code": "authorised_representative_required", "type": null, "when": "422 requirement_error." }, { "code": "documents_not_certified", "type": null, "when": "422 requirement_error." }, { "code": "certification_timing_unconfirmed", "type": null, "when": "409 requirement_error." }, { "code": "translation_missing", "type": null, "when": "422 requirement_error." }, { "code": "live_video_call_required", "type": null, "when": "422 requirement_error." }, { "code": "edd_evidence_required", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." }, { "code": "human_presence_required", "type": null, "when": "403 permission_error." } ] } }, "Params_sg_gst_register": { "type": "object", "properties": { "registration_basis": { "type": "string", "enum": [ "compulsory_retrospective", "compulsory_prospective", "voluntary" ], "description": "Why the entity registers.", "examples": [ "compulsory_prospective" ] }, "turnover_calendar_year": { "type": "integer", "description": "Required for compulsory_retrospective.", "examples": [ "2026" ] }, "taxable_turnover_for_year": { "$ref": "#/components/schemas/Money", "description": "Taxable turnover for turnover_calendar_year.", "examples": [ "{\"amount\":1180000,\"currency\":\"SGD\"}" ] }, "forecast_date": { "type": "string", "format": "date", "description": "Required for compulsory_prospective.", "examples": [ "2026-10-05" ] }, "forecast_taxable_turnover_next_12_months": { "$ref": "#/components/schemas/Money", "description": "Forecast taxable supplies for the next 12 months.", "examples": [ "{\"amount\":1400000,\"currency\":\"SGD\"}" ] }, "forecast_basis": { "type": "string", "enum": [ "signed_contracts", "accepted_quotations", "confirmed_purchase_orders", "none" ], "description": "Evidence behind the forecast.", "examples": [ "signed_contracts" ] }, "expected_standard_rated_supplies": { "$ref": "#/components/schemas/Money", "description": "Expected local standard-rated supplies over the next 12 months.", "examples": [ "{\"amount\":1100000,\"currency\":\"SGD\"}" ] }, "expected_zero_rated_supplies": { "$ref": "#/components/schemas/Money", "description": "Expected zero-rated supplies over the next 12 months.", "examples": [ "{\"amount\":300000,\"currency\":\"SGD\"}" ] }, "first_taxable_supply_date": { "type": "string", "format": "date", "description": "Date of the first taxable supply, if not yet trading.", "examples": [ "2026-11-02" ] }, "nature_of_business": { "type": "string", "description": "Up to 600 characters, no symbols or line breaks.", "examples": [ "Software licensing for freight forwarders" ] }, "business_website": { "type": "string", "description": "Website URL, or NA.", "examples": [ "NA" ] }, "business_premises": { "type": "string", "enum": [ "commercial", "home_office", "other" ], "description": "Where the business operates.", "examples": [ "commercial" ] }, "licences_and_permits": { "type": "array", "items": {}, "description": "Names of licences or permits the business holds.", "examples": [ "[]" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day, MM-DD.", "examples": [ "12-31" ] }, "gst_accounting_period": { "type": "string", "description": "Preferred GST accounting period as offered by the form.", "examples": [ "quarterly" ] }, "staff_strength": { "type": "integer", "description": "Headcount for the form questionnaire.", "examples": [ "14" ] }, "gst_return_preparer": { "type": "string", "pattern": "^per_", "description": "Person who will prepare GST returns.", "examples": [ "per_1QzPrep4kL" ] }, "preparer_qualification": { "type": "string", "enum": [ "accredited_tax_advisor_or_practitioner", "completed_gst_elearning", "prior_gst_experience" ], "description": "Basis on which the preparer is exempt from, or has completed, IRAS GST training.", "examples": [ "prior_gst_experience" ] }, "taken_over_as_going_concern": { "type": "boolean", "description": "True if the business was taken over as a going concern; then transferor is required.", "examples": [ "false" ] }, "transferor": { "type": "object", "description": "{name, uen, gst_registration_number, transfer_date} of the transferor.", "examples": [ "{\"name\":\"Old Co Pte. Ltd.\",\"uen\":\"201912345A\",\"transfer_date\":\"2026-09-01\"}" ] }, "supplies_before_registration": { "type": "object", "description": "{period_start, period_end, gst_charged} for supplies made before the effective date.", "examples": [ "{\"period_start\":\"2026-08-01\",\"period_end\":\"2026-09-30\",\"gst_charged\":{\"amount\":0,\"currency\":\"SGD\"}}" ] }, "late_registration_disclosure": { "type": "boolean", "description": "True to disclose voluntarily that the application is late.", "examples": [ "false" ] }, "voluntary_two_year_commitment_acknowledged": { "type": "boolean", "description": "Required true for voluntary: the entity must stay registered for at least 2 years.", "examples": [ "true" ] }, "peppol_id": { "type": "string", "description": "InvoiceNow Peppol ID, where IRAS's InvoiceNow requirement applies.", "examples": [ "NA" ] }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director or authorised officer who makes the GST declaration.", "examples": [ "per_1QzDecl7mX" ] }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Contact person if different from the declarant.", "examples": [ "per_1QzCont2vB" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "registration_basis", "nature_of_business", "business_website", "business_premises", "financial_year_end", "gst_return_preparer", "preparer_qualification", "declarant", "name", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers an existing Singapore entity for GST on IRAS myTax Portal on one of three bases: compulsory retrospective, compulsory prospective or voluntary. Entiva prepares the application, files it as the entity's authorised tax agent or." }, "Create_sg_gst_register": { "type": "object", "properties": { "type": { "const": "sg.gst.register" }, "params": { "$ref": "#/components/schemas/Params_sg_gst_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register for GST with IRAS", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution to register for GST", "source": "generated", "required": true }, { "key": "acra_business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": true }, { "key": "sales_invoices", "title": "Three most recent sales invoices", "source": "uploaded", "required": false }, { "key": "sales_listing", "title": "Two-month sales listing", "source": "uploaded", "required": false }, { "key": "purchase_invoices", "title": "Three most recent purchase invoices with two-month purchase listing", "source": "uploaded", "required": false }, { "key": "business_plan", "title": "Business plan", "source": "uploaded", "required": false }, { "key": "forecast_evidence", "title": "Forecast evidence", "source": "uploaded", "required": false }, { "key": "transfer_agreement", "title": "Transfer agreement", "source": "uploaded", "required": false }, { "key": "elearning_acknowledgement", "title": "IRAS GST e-learning acknowledgement page", "source": "uploaded", "required": false }, { "key": "supporting_other", "title": "Licences, overseas invoices or contracts, home-office approval, latest profit and loss", "source": "uploaded", "required": false }, { "key": "iras_application_acknowledgement", "title": "IRAS application acknowledgement", "source": "registry_issued", "required": false }, { "key": "gst_registration_letter", "title": "IRAS GST registration approval letter", "source": "registry_issued", "required": false }, { "key": "corppass_authorisation", "title": "Corppass authorisation", "source": "generated", "required": true }, { "key": "iras_gst_registration_form", "title": "Iras gst registration form", "source": "generated", "required": true } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "corppass_authorisation", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "iras_gst_registration_form", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "GST registration application on myTax Portal", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "gst_threshold_not_met", "type": null, "when": "A compulsory basis is chosen but the stated turnover or forecast is S$1m or less." }, { "code": "forecast_evidence_missing", "type": null, "when": "compulsory_prospective without signed contracts, quotations or purchase orders; IRAS would treat it as voluntary." }, { "code": "voluntary_conditions_not_met", "type": null, "when": "voluntary basis with no taxable supplies or no firm business plan." }, { "code": "corppass_authorisation_missing", "type": null, "when": "The Corppass Admin has not assigned Entiva the IRAS e-service role." }, { "code": "elearning_required", "type": null, "when": "Voluntary applicant whose preparer is neither accredited nor experienced has no e-learning acknowledgement." }, { "code": "registration_window_missed", "type": null, "when": "Filing is after the 1 to 30 January or 30-day window; late_registration_disclosure is advised." }, { "code": "already_gst_registered", "type": null, "when": "The entity already holds a GST registration number." }, { "code": "giro_application_pending", "type": null, "when": "Voluntary applicant has not submitted GIRO within 10 working days; IRAS treats the application as cancelled." } ] } }, "Params_sg_ipc_apply": { "type": "object", "properties": { "charity_type": { "type": "string", "enum": [ "registered_charity", "exempt_charity" ], "description": "IPC status is given to a registered or an exempt charity.", "examples": [ "registered_charity" ] }, "charity_registration_number": { "type": "string", "description": "Number issued by the Commissioner of Charities.", "examples": [ "CH00123" ] }, "community_benefit_statement": { "type": "string", "description": "How activities benefit the Singapore community as a whole.", "examples": [ "Free reading programmes open to all Singapore children" ] }, "sectional_interest_waiver": { "type": "boolean", "description": "True if the Minister has waived the rule against activities limited by race, belief or religion.", "examples": [ "false" ] }, "overseas_activities": { "type": "boolean", "description": "True if any activity benefits overseas communities.", "examples": [ "false" ] }, "governing_board": { "type": "array", "items": {}, "description": "person_refs of board members.", "examples": [ "[\"per_1QzB1\",\"per_1QzB2\",\"per_1QzB3\",\"per_1QzB4\"]" ] }, "board_independence_confirmed": { "type": "boolean", "description": "Confirms the board is independent.", "examples": [ "true" ] }, "gross_annual_receipts_last_year": { "$ref": "#/components/schemas/Money", "description": "Most recent financial year, to test the large charity threshold.", "examples": [ "{\"amount\":450000,\"currency\":\"SGD\"}" ] }, "gross_annual_receipts_year_before": { "$ref": "#/components/schemas/Money", "description": "Year before that.", "examples": [ "{\"amount\":380000,\"currency\":\"SGD\"}" ] }, "auditor_name": { "type": "string", "description": "IPC accounts must be audited by an auditor approved by the Commissioner or Sector Administrator, changed at least every 5 years.", "examples": [ "Tan & Partners PAC" ] }, "auditor_approval_confirmed": { "type": "boolean", "description": "Confirms the auditor is approved.", "examples": [ "true" ] }, "qualified_audit_report": { "type": "boolean", "description": "True if any recent audit report was qualified.", "examples": [ "false" ] }, "policies_and_plans": { "type": "array", "items": {}, "description": "document_refs for governance policies and planned activities.", "examples": [ "[\"doc_1QzPol1\"]" ] }, "latest_audited_financial_statements": { "type": "string", "pattern": "^doc_", "description": "Most recent audited accounts.", "examples": [ "doc_1QzFs3" ] }, "submitting_officer": { "type": "string", "pattern": "^per_", "description": "Authorised officer who submits on the Charity Portal.", "examples": [ "per_1QzB1" ] } }, "required": [ "charity_type", "charity_registration_number", "community_benefit_statement", "overseas_activities", "governing_board", "board_independence_confirmed", "auditor_name", "auditor_approval_confirmed", "qualified_audit_report", "policies_and_plans", "latest_audited_financial_statements", "submitting_officer" ], "description": "Prepares and supports an application for approval as an IPC for an existing registered or exempt charity. Entiva tests the charity against the published criteria and an authorised officer submits the Excel form on the Charity Portal." }, "Create_sg_ipc_apply": { "type": "object", "properties": { "type": { "const": "sg.ipc.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_ipc_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for Institution of a Public Character status", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "public_ltd_guarantee", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "ipc_application_form", "title": "Application Form for Approval as an IPC", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution approving the IPC application", "source": "generated", "required": true }, { "key": "board_independence_declarations", "title": "Board independence and citizenship declarations", "source": "generated", "required": true }, { "key": "policies_and_plans", "title": "Governance policies and activity plans", "source": "uploaded", "required": true }, { "key": "audited_financial_statements", "title": "Latest audited financial statements", "source": "uploaded", "required": true }, { "key": "audit_qualification_explanation", "title": "Explanation of any qualified audit report", "source": "uploaded", "required": false }, { "key": "ipc_decision_notice", "title": "IPC decision notice", "source": "registry_issued", "required": false }, { "key": "ipc_portal_submission", "title": "Ipc portal submission", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_independence_declarations", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ipc_portal_submission", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Commissioner of Charities", "form": "Application Form for Approval as an IPC", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_a_charity", "type": null, "when": "The entity is not a registered or exempt charity." }, { "code": "board_citizenship_below_half", "type": null, "when": "Fewer than half of the board are Singapore citizens." }, { "code": "board_not_independent", "type": null, "when": "The independence rule is not met." }, { "code": "large_charity_board_too_small", "type": null, "when": "Receipts reach the large-charity threshold but the board has fewer than 10 members." }, { "code": "auditor_not_approved", "type": null, "when": "The auditor lacks Commissioner or Sector Administrator approval." }, { "code": "overseas_activities_not_permitted", "type": null, "when": "overseas_activities is true." }, { "code": "sectional_interest_without_waiver", "type": null, "when": "Activities are limited to a race, belief or religion group without a Minister's waiver." } ] } }, "Params_sg_limited_partnership_register": { "type": "object", "properties": { "name_reservation_id": { "type": "string", "description": "act_ id of a completed sg.name.reserve action with entity_type limited_partnership, made by Entiva's CSP and not older than 120 days.", "examples": [ "act_7Ke3NqWb" ] }, "name": { "type": "string", "description": "Name without the LP suffix.", "examples": [ "Meridian Growth" ] }, "primary_ssic": { "type": "string", "description": "Required with proposed_name: primary business activity as an SSIC code.", "examples": [ "64301" ] }, "lp_email": { "type": "string", "description": "The LP's email address." }, "commencement_date": { "type": "string", "format": "date", "description": "Proposed date the LP starts." }, "registration_period_years": { "type": "integer", "description": "1 or 3.", "examples": [ "1" ] }, "business_address": { "$ref": "#/components/schemas/Address", "description": "The main operating address.", "examples": [ "{\"line1\": \"80 Robinson Road\", \"line2\": \"#08-01\", \"city\": \"Singapore\", \"postal_code\": \"068898\", \"country\": \"SG\"}" ] }, "general_partners": { "type": "array", "items": {}, "description": "At least one." }, "limited_partners": { "type": "array", "items": {}, "description": "At least one." }, "local_manager": { "type": "object", "description": "Required when every general partner is a foreigner." }, "fund_management": { "type": "object", "description": "For an LP under section 12 of the LP Regulations." }, "medisave_liabilities_confirmed": { "type": "boolean", "description": "Partners confirm they have cleared any outstanding MediSave liabilities." }, "special_uen": { "type": "string", "description": "A special UEN from ACRA's list, choosable only when registering.", "examples": [ "201938474D" ] }, "represented_by_sg_professional": { "type": "boolean", "description": "True if a Singapore lawyer or public accountant represents the customer." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "lp_email", "commencement_date", "registration_period_years", "business_address", "general_partners", "limited_partners", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Register a limited partnership through Bizfile for one year, or three where the CPF Board's conditions are met. It needs a general partner, a limited partner, and a local manager if every general partner is a foreigner." }, "Create_sg_limited_partnership_register": { "type": "object", "properties": { "type": { "const": "sg.limited_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_sg_limited_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Singapore limited partnership", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "position_holder_consent", "title": "Partner and manager consent to be registered", "source": "generated", "required": true }, { "key": "pass_issuer_consent", "title": "Pass-issuer consent for FIN holders", "source": "uploaded", "required": false }, { "key": "beneficiary_details", "title": "Nominee or trustee beneficiary details", "source": "uploaded", "required": false }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": true }, { "key": "agent_authority_evidence", "title": "Evidence of the agent's authority", "source": "generated", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "registration_application", "title": "Registration application record", "source": "generated", "required": true }, { "key": "notice_of_registration", "title": "ACRA notice of successful registration", "source": "registry_issued", "required": true }, { "key": "business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "position_holder_consent", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "customer_acceptance_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Register new business entity'", "channel": "online", "government_fee": { "amount": 100, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_required", "type": null, "when": "422 invalid_request_error." }, { "code": "name_reservation_invalid", "type": null, "when": "422 requirement_error. name_reservation_id is expired, for another entity type, withdrawn, or not reserved by Entiva's CSP." }, { "code": "general_partner_required", "type": null, "when": "422 requirement_error." }, { "code": "limited_partner_required", "type": null, "when": "422 requirement_error." }, { "code": "local_manager_required", "type": null, "when": "422 requirement_error." }, { "code": "three_year_not_eligible", "type": null, "when": "422 requirement_error. registration_period_years is 3 but the CPF Board's conditions are not met." }, { "code": "live_video_call_required", "type": null, "when": "422 requirement_error." }, { "code": "edd_evidence_required", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." } ] } }, "Params_sg_llp_register": { "type": "object", "properties": { "name_reservation_id": { "type": "string", "description": "act_ id of a completed sg.name.reserve action with entity_type llp, made by Entiva's CSP and not older than 120 days.", "examples": [ "act_4Jt6RfQe" ] }, "name": { "type": "string", "description": "Name without the LLP suffix.", "examples": [ "Harbour Advisory" ] }, "primary_ssic": { "type": "string", "description": "Required with proposed_name: primary business activity as an SSIC code.", "examples": [ "70201" ] }, "llp_email": { "type": "string", "description": "The LLP's email address." }, "services": { "type": "array", "items": {}, "description": "Entiva services to attach: registered_office." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Required unless services includes registered_office.", "examples": [ "{\"line1\": \"1 Raffles Place\", \"line2\": \"#20-01\", \"city\": \"Singapore\", \"postal_code\": \"048616\", \"country\": \"SG\"}" ] }, "partners": { "type": "array", "items": {}, "description": "At least two." }, "managers": { "type": "array", "items": {}, "description": "At least one manager, and at least one must be ordinarily resident in Singapore, 18 or over, and not an undischarged bankrupt." }, "medisave_liabilities_confirmed": { "type": "boolean", "description": "Partners confirm they have cleared any outstanding MediSave liabilities with the CPF Board." }, "rorc": { "type": "object", "description": "RORC declaration." }, "special_uen": { "type": "string", "description": "A special UEN from ACRA's list, choosable only when registering.", "examples": [ "201938474D" ] }, "represented_by_sg_professional": { "type": "boolean", "description": "True if a Singapore lawyer or public accountant represents the customer." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "llp_email", "partners", "managers", "rorc", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Register an LLP through Bizfile with at least two partners and at least one locally resident manager. Entiva's CSP files, so partners need no Singpass endorsement." }, "Create_sg_llp_register": { "type": "object", "properties": { "type": { "const": "sg.llp.register" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Singapore limited liability partnership", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "position_holder_consent", "title": "Partner and manager consent to be appointed", "source": "generated", "required": true }, { "key": "pass_issuer_consent", "title": "Pass-issuer consent for FIN holders", "source": "uploaded", "required": false }, { "key": "ownership_and_control_chart", "title": "Ownership and control chart down to each natural person", "source": "uploaded", "required": false }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": true }, { "key": "agent_authority_evidence", "title": "Evidence of the agent's authority", "source": "generated", "required": false }, { "key": "controller_confirmation", "title": "Controller's dated confirmation of particulars", "source": "generated", "required": false }, { "key": "exemption_evidence", "title": "Evidence of an exemption claimed", "source": "uploaded", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "registration_application", "title": "Registration application record", "source": "generated", "required": true }, { "key": "notice_of_registration", "title": "ACRA notice of successful registration", "source": "registry_issued", "required": true }, { "key": "business_profile", "title": "ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "position_holder_consent", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "controller_confirmation", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "customer_acceptance_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Register new business entity'", "channel": "online", "government_fee": { "amount": 100, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_required", "type": null, "when": "422 invalid_request_error." }, { "code": "name_reservation_invalid", "type": null, "when": "422 requirement_error. name_reservation_id is expired, for another entity type, withdrawn, or not reserved by Entiva's CSP." }, { "code": "partners_minimum", "type": null, "when": "422 requirement_error." }, { "code": "local_manager_required", "type": null, "when": "422 requirement_error." }, { "code": "medisave_not_cleared", "type": null, "when": "422 requirement_error." }, { "code": "live_video_call_required", "type": null, "when": "422 requirement_error." }, { "code": "edd_evidence_required", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." } ] } }, "Params_sg_name_reserve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "description": "The entity type the name is for." }, "name": { "type": "string", "description": "Preferred name without a legal suffix such as Pte Ltd or LLP.", "examples": [ "Northwind Labs" ] }, "primary_ssic": { "type": "string", "description": "Primary business activity as an SSIC code from ACRA's code list.", "examples": [ "62011" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "The verified person instructing Entiva: the account owner, a director, or the operator of an AI agent." }, "contact_email": { "type": "string", "description": "A valid email address for the ACRA transaction." }, "proposed_officers": { "type": "array", "items": {}, "description": "Required when entity_type is vcc." }, "letter_of_consent": { "type": "string", "pattern": "^doc_", "description": "Letter of consent from the holder of an identical name." }, "supporting_documents": { "type": "array", "items": {}, "description": "Documents that justify a name that needs justification." }, "review_of": { "type": "string", "description": "act_ id of an earlier name application for the same name that ended rejected." } }, "required": [ "entity_type", "name", "applicant", "contact_email" ], "description": "Reserve a name with ACRA for a company, LLP, limited partnership, sole proprietorship, general partnership, foreign company branch or VCC. Entiva's CSP files the Bizfile name application so the same CSP can register the entity later." }, "Create_sg_name_reserve": { "type": "object", "properties": { "type": { "const": "sg.name.reserve" }, "params": { "$ref": "#/components/schemas/Params_sg_name_reserve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a new Singapore entity name", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "name_application", "title": "Name application", "source": "generated", "required": true }, { "key": "letter_of_consent", "title": "Letter of consent from the holder of an identical name", "source": "uploaded", "required": false }, { "key": "supporting_documents", "title": "Supporting documents for a name that needs justification", "source": "uploaded", "required": false }, { "key": "in_principle_approval", "title": "In-principle approval from another authority", "source": "uploaded", "required": false }, { "key": "name_approval_notice", "title": "ACRA name approval with transaction number", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "name_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply for new business entity name'. For a VCC, the name application on the VCC P", "channel": "online", "government_fee": { "amount": 15, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "422 registry_error." }, { "code": "vcc_officers_required", "type": null, "when": "422 invalid_request_error. entity_type is vcc and proposed_officers is empty." }, { "code": "invalid_ssic", "type": null, "when": "422 invalid_request_error. primary_ssic is missing for a non-VCC entity, or is not on ACRA's code list." }, { "code": "entity_type_not_supported", "type": null, "when": "422 jurisdiction_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." }, { "code": "mandate_required", "type": null, "when": "403 permission_error." } ] } }, "Params_sg_registered_office_provide": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date Entiva's address becomes the registered office.", "examples": [ "2026-10-19" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director, manager or authorised representative who signs for the entity.", "examples": [ "per_1QzDir3kH" ] }, "records_custody": { "type": "string", "enum": [ "entiva_keeps_registers", "entity_keeps_registers" ], "description": "Where statutory registers are kept.", "examples": [ "entiva_keeps_registers" ] }, "mail_handling": { "type": "string", "enum": [ "scan_and_email", "hold_for_collection" ], "description": "What Entiva does with mail received at the address.", "examples": [ "scan_and_email" ] }, "inspection_contact_email": { "type": "string", "description": "Where Entiva forwards inspection requests.", "examples": [ "legal@lumenfreight.example" ] }, "previous_registered_office": { "$ref": "#/components/schemas/Address", "description": "Read from the ACRA Business Profile; supply only to correct it.", "examples": [ "{\"line1\":\"1 Raffles Place\",\"postal_code\":\"048616\",\"country\":\"SG\"}" ] }, "acknowledge_filing_window": { "type": "boolean", "description": "Set true if effective_date is already more than 14 days past; the filing will be late.", "examples": [ "false" ] } }, "required": [ "effective_date", "authorised_signatory" ], "description": "Starts Entiva's registered office service for an existing entity. Entiva's registered CSP supplies the address, files the change of registered office in Bizfile within 14 days, keeps the address compliant with the opening or." }, "Create_sg_registered_office_provide": { "type": "object", "properties": { "type": { "const": "sg.registered_office.provide" }, "params": { "$ref": "#/components/schemas/Params_sg_registered_office_provide" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Provide Entiva's registered office address", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the registered office change and the CSP engagement", "source": "generated", "required": true }, { "key": "address_service_terms", "title": "Entiva address service terms", "source": "generated", "required": true }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": false }, { "key": "acra_change_confirmation", "title": "Bizfile submission confirmation", "source": "registry_issued", "required": false }, { "key": "updated_business_profile", "title": "Updated ACRA Business Profile", "source": "registry_issued", "required": false }, { "key": "bizfile_change_of_address", "title": "Bizfile change of address", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "address_service_terms", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "customer_acceptance_form", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_change_of_address", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile entity information update: change of registered office address", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "cdd_incomplete", "type": null, "when": "" }, { "code": "csp_acceptance_declined", "type": null, "when": "Entiva's CSP declines the customer after risk assessment." }, { "code": "address_already_provided", "type": null, "when": "The registered office already is an Entiva address." }, { "code": "entity_type_not_supported", "type": null, "when": "Entity type is not in applies_to." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a related person pauses the action." }, { "code": "filing_window_exceeded", "type": null, "when": "effective_date is more than 14 days ago and acknowledge_filing_window is not true." } ] } }, "Params_sg_registered_office_release": { "type": "object", "properties": { "registered_office": { "$ref": "#/components/schemas/Address", "description": "Singapore address that takes over.", "examples": [ "{\"line1\":\"8 Marina Boulevard\",\"unit\":\"#05-02\",\"postal_code\":\"018981\",\"country\":\"SG\"}" ] }, "address_provider": { "type": "string", "enum": [ "own_premises_under_tenancy", "other_registered_csp" ], "description": "Who supplies the new address.", "examples": [ "own_premises_under_tenancy" ] }, "other_csp_uen": { "type": "string", "description": "Required when new_address_provider is other_registered_csp.", "examples": [ "201234567B" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the new address takes over.", "examples": [ "2026-12-01" ] }, "filing_responsibility": { "type": "string", "enum": [ "entiva_files", "entity_or_new_csp_files" ], "description": "Who files the Bizfile change.", "examples": [ "entiva_files" ] }, "registers_handover": { "type": "string", "enum": [ "handover_to_entity", "handover_to_new_csp" ], "description": "Where the RORC, nominee registers, minute book and Form 45s go.", "examples": [ "handover_to_entity" ] }, "handover_recipient": { "type": "string", "pattern": "^per_", "description": "Person who receives the registers and signs for them.", "examples": [ "per_1QzDir3kH" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director or manager who signs the resolution and termination notice.", "examples": [ "per_1QzDir3kH" ] }, "reason": { "type": "string", "description": "Free-text reason for the audit trail.", "examples": [ "Moved into leased office" ] } }, "required": [ "registered_office", "address_provider", "effective_date", "registers_handover", "handover_recipient", "authorised_signatory" ], "description": "Ends Entiva's registered office service for an entity. The entity must name a lawful new Singapore address, either its own premises under a tenancy or another registered CSP." }, "Create_sg_registered_office_release": { "type": "object", "properties": { "type": { "const": "sg.registered_office.release" }, "params": { "$ref": "#/components/schemas/Params_sg_registered_office_release" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End Entiva's registered office service and move to a new address", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the new registered office and ending the service", "source": "generated", "required": true }, { "key": "service_termination_notice", "title": "Termination notice for the address service", "source": "generated", "required": true }, { "key": "new_address_evidence", "title": "Tenancy agreement for a dedicated unit, or the new CSP's engagement letter", "source": "uploaded", "required": true }, { "key": "registers_handover_receipt", "title": "Statutory registers handover receipt", "source": "generated", "required": true }, { "key": "acra_change_confirmation", "title": "Bizfile submission confirmation", "source": "registry_issued", "required": false }, { "key": "bizfile_change_of_address", "title": "Bizfile change of address", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "recipient", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "service_termination_notice", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registers_handover_receipt", "signer_role": "recipient", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_change_of_address", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile entity information update: change of registered office address", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "new_address_not_in_singapore", "type": null, "when": "The new address is outside Singapore or is a P.O." }, { "code": "new_address_provider_not_registered_csp", "type": null, "when": "other_registered_csp is not on ACRA's CSP register and no tenancy is evidenced." }, { "code": "entity_not_using_entiva_address", "type": null, "when": "The entity's registered office is not an Entiva address." }, { "code": "registers_handover_pending", "type": null, "when": "Handover receipt is unsigned, so Entiva cannot end custody." }, { "code": "other_csp_uen_missing", "type": null, "when": "new_address_provider is other_registered_csp without other_csp_uen." } ] } }, "Params_sg_registers_form": { "type": "object", "properties": { "trigger": { "type": "string", "enum": [ "formation", "exemption_ceased", "onboarding_existing_entity" ], "description": "Why the registers are being set up. formation: chained automatically from a formation; the information goes in the registration filing on the incorporation." }, "registers": { "type": "array", "items": {}, "description": "Registers to set up." }, "exemption_ceased_on": { "type": "string", "format": "date", "description": "Required when trigger is exemption_ceased: the date the entity stopped being exempt." }, "rorc": { "type": "object", "description": "Required when registers includes rorc." }, "nominee_registers": { "type": "object", "description": "Required when registers includes rond or rons." }, "storage_location": { "type": "string", "enum": [ "registered_office", "csp_office" ], "description": "Where the private registers are kept: the registered office, or the registered CSP's office." }, "existing_registers": { "type": "array", "items": {}, "description": "For onboarding_existing_entity: array of document_ref for the registers, minute book and Forms 45 held by the previous provider." }, "lodge_with_central_registers": { "type": "boolean", "description": "Whether to lodge with ACRA's central registers now." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "trigger", "registers", "name", "nature_of_business", "countries_of_operation", "directors", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Open the private Register of Registrable Controllers, Register of Nominee Directors and Register of Nominee Shareholders, plus the minute book and charges register, and lodge controller and nominee information with ACRA's non-public." }, "Create_sg_registers_form": { "type": "object", "properties": { "type": { "const": "sg.registers.form" }, "params": { "$ref": "#/components/schemas/Params_sg_registers_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up an entity's statutory registers and lodge them with ACRA's central registers", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "register_of_registrable_controllers", "title": "Register of Registrable Controllers", "source": "generated", "required": false }, { "key": "register_of_nominee_directors", "title": "Register of Nominee Directors", "source": "generated", "required": false }, { "key": "register_of_nominee_shareholders", "title": "Register of Nominee Shareholders", "source": "generated", "required": false }, { "key": "minute_book", "title": "Minute book", "source": "generated", "required": false }, { "key": "charges_register", "title": "Register of charges", "source": "generated", "required": false }, { "key": "controller_notices", "title": "Notices to controllers and persons likely to know", "source": "generated", "required": false }, { "key": "controller_confirmation", "title": "Controller's dated confirmation of particulars", "source": "generated", "required": false }, { "key": "nominee_disclosure", "title": "Nominee disclosure to the company", "source": "generated", "required": false }, { "key": "exemption_evidence", "title": "Evidence of an exemption claimed", "source": "uploaded", "required": false }, { "key": "previous_registers", "title": "Registers received from the previous provider", "source": "uploaded", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "central_register_lodgement", "title": "Central register lodgement record", "source": "generated", "required": false }, { "key": "central_register_receipt", "title": "ACRA central register lodgement receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "nominee", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "controller_confirmation", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nominee_disclosure", "signer_role": "nominee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_registrable_controllers", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "central_register_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Central RORC, Central ROND and Central RONS lodgement", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_not_applicable", "type": null, "when": "422 requirement_error." }, { "code": "exemption_date_missing", "type": null, "when": "422 invalid_request_error. trigger is exemption_ceased and exemption_ceased_on is missing." }, { "code": "setup_window_missed", "type": null, "when": "409 requirement_error." }, { "code": "controller_unconfirmed", "type": null, "when": "409 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." } ] } }, "Params_sg_representative_office_register": { "type": "object", "properties": { "parent_legal_name": { "type": "string", "description": "Legal name of the foreign parent.", "examples": [ "Nordlys Handel AS" ] }, "parent_country_of_incorporation": { "type": "string", "description": "ISO 3166 country code.", "examples": [ "NO" ] }, "parent_registration_number": { "type": "string", "description": "Registration number at the home registry.", "examples": [ "912345678" ] }, "parent_incorporation_date": { "type": "string", "format": "date", "description": "Date of incorporation.", "examples": [ "2008-04-02" ] }, "parent_years_established": { "type": "integer", "description": "Years in business.", "examples": [ "18" ] }, "parent_turnover_usd": { "$ref": "#/components/schemas/Money", "description": "Latest annual turnover in USD, per the audited accounts.", "examples": [ "{\"amount\":42000000,\"currency\":\"USD\"}" ] }, "parent_registered_address": { "$ref": "#/components/schemas/Address", "description": "Registered office of the parent.", "examples": [ "{\"line1\":\"Storgata 12\",\"city\":\"Oslo\",\"postal_code\":\"0155\",\"country\":\"NO\"}" ] }, "ro_purpose": { "type": "string", "description": "Purpose of the Representative Office, restated in the signed letter on the parent's letterhead.", "examples": [ "Market research and liaison for Southeast Asian customers" ] }, "ro_address": { "$ref": "#/components/schemas/Address", "description": "Proposed Singapore address.", "examples": [ "{\"line1\":\"1 Raffles Place\",\"unit\":\"#40-01\",\"postal_code\":\"048616\",\"country\":\"SG\"}" ] }, "chief_representative": { "type": "string", "pattern": "^per_", "description": "The Chief Representative stationed in Singapore.", "examples": [ "per_1QzCr1" ] }, "chief_representative_work_pass": { "type": "string", "description": "NRIC, or the work pass type held or applied for.", "examples": [ "Employment Pass" ] }, "proposed_start_date": { "type": "string", "format": "date", "description": "When RO activities are to start.", "examples": [ "2027-01-15" ] }, "intended_submission_date": { "type": "string", "format": "date", "description": "Used to quote the fee: before 1 Apr 2027 S$200; from 1 Apr 2027 S$200 plus S$400 on approval.", "examples": [ "2026-11-02" ] }, "filing_route": { "type": "string", "enum": [ "entiva_third_party_filer", "entity_corppass_user" ], "description": "entiva_third_party_filer is the default. entity_corppass_user needs a Corppass administrator with an NRIC or FIN.", "examples": [ "entiva_third_party_filer" ] }, "parent_authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Signs the purpose letter and the filing authorisation for the parent.", "examples": [ "per_1QzPs2" ] } }, "required": [ "parent_legal_name", "parent_country_of_incorporation", "parent_registration_number", "parent_incorporation_date", "parent_years_established", "parent_turnover_usd", "parent_registered_address", "ro_purpose", "ro_address", "chief_representative", "chief_representative_work_pass", "proposed_start_date", "filing_route", "parent_authorised_signatory" ], "description": "Applies to Enterprise Singapore on GoBusiness Licensing for a Representative Office licence for a foreign entity. Entiva checks the parent's documents, verifies the Chief Representative, and files as the authorised third-party filer, so." }, "Create_sg_representative_office_register": { "type": "object", "properties": { "type": { "const": "sg.representative_office.register" }, "params": { "$ref": "#/components/schemas/Params_sg_representative_office_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a Representative Office licence", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "parent_certificate_of_incorporation", "title": "Parent's certificate of incorporation", "source": "uploaded", "required": true }, { "key": "parent_audited_accounts", "title": "Parent's latest audited accounts", "source": "uploaded", "required": true }, { "key": "ro_purpose_letter", "title": "Letter on the parent's letterhead stating the RO's purpose", "source": "generated", "required": true }, { "key": "parent_filing_authorisation", "title": "Parent's authorisation of Entiva as third-party filer", "source": "generated", "required": true }, { "key": "chief_representative_identity", "title": "Chief Representative's passport and work pass or NRIC", "source": "uploaded", "required": true }, { "key": "english_translations", "title": "English translations", "source": "uploaded", "required": false }, { "key": "gobusiness_acknowledgement", "title": "GoBusiness application acknowledgement", "source": "registry_issued", "required": false }, { "key": "ro_licence", "title": "Representative Office licence", "source": "registry_issued", "required": false }, { "key": "gobusiness_application", "title": "Gobusiness application", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ro_purpose_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "parent_filing_authorisation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gobusiness_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Enterprise Singapore", "form": "GoBusiness Licensing: Representative Office", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "parent_eligibility_not_met", "type": null, "when": "The parent fails Enterprise Singapore's eligibility criteria on turnover or years established." }, { "code": "chief_representative_missing", "type": null, "when": "No Chief Representative or no NRIC or work pass evidence." }, { "code": "parent_documents_untranslated", "type": null, "when": "Documents are not in English and no professional translation is provided." }, { "code": "filing_authorisation_missing", "type": null, "when": "The parent has not signed the third-party filer authorisation." }, { "code": "corppass_admin_requires_nric_or_fin", "type": null, "when": "filing_route is entity_corppass_user but no administrator holds an NRIC or FIN." }, { "code": "ro_activities_not_permitted", "type": null, "when": "ro_purpose describes activity outside the RO scheme." } ] } }, "Params_sg_society_register": { "type": "object", "properties": { "society_name": { "type": "string", "description": "Proposed name.", "examples": [ "Harbour Chess Club" ] }, "registration_route": { "type": "string", "enum": [ "normal", "automatic" ], "description": "normal for societies in the Schedule to the Societies Act; automatic for others.", "examples": [ "automatic" ] }, "alternative_names": { "type": "array", "items": {}, "description": "Normal route only: two alternative names in order of preference, each {name, meaning, foreign_language_characters}.", "examples": [ "[{\"name\":\"Marina Chess Society\",\"meaning\":\"A chess society\"}]" ] }, "objects": { "type": "string", "description": "The society's objects.", "examples": [ "To promote chess among residents of Singapore" ] }, "non_profit_declaration": { "type": "boolean", "description": "Confirms the non-distribution rule.", "examples": [ "true" ] }, "confirm_not_exempt": { "type": "boolean", "description": "Confirms no exemption from registration applies.", "examples": [ "true" ] }, "founding_member_count": { "type": "integer", "description": "Number of persons in the association; 10 or more.", "examples": [ "14" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered address of the society.", "examples": [ "{\"line1\":\"20 Bukit Pasoh Road\",\"postal_code\":\"089834\",\"country\":\"SG\"}" ] }, "email": { "type": "string", "description": "Society email.", "examples": [ "hello@harbourchess.example" ] }, "telephone": { "type": "string", "description": "Society telephone.", "examples": [ "+6561234567" ] }, "constitution": { "type": "string", "pattern": "^doc_", "description": "Constitution in English, Microsoft Word format.", "examples": [ "doc_1QzCon5" ] }, "president": { "type": "string", "pattern": "^per_", "description": "Key office bearer.", "examples": [ "per_1QzSo1" ] }, "secretary": { "type": "string", "pattern": "^per_", "description": "Key office bearer.", "examples": [ "per_1QzSo2" ] }, "treasurer": { "type": "string", "pattern": "^per_", "description": "Key office bearer.", "examples": [ "per_1QzSo3" ] }, "committee_members": { "type": "array", "items": {}, "description": "Other committee person_refs.", "examples": [ "[\"per_1QzSo4\"]" ] }, "expected_membership_size": { "type": "integer", "description": "Normal route question.", "examples": [ "60" ] }, "additional_funding_sources": { "type": "string", "description": "Normal route: sources of funds beyond those in the constitution.", "examples": [ "Annual tournament entry fees" ] }, "previously_existed": { "type": "boolean", "description": "Normal route: whether the society existed before, and whether it was registered under another written law.", "examples": [ "false" ] }, "foreign_employees": { "type": "object", "description": "Normal route: {planned, details, duration}.", "examples": [ "{\"planned\":false}" ] }, "represents_ethnic_group": { "type": "boolean", "description": "Normal route: whether the society represents an ethnic group or restricts membership by ethnicity.", "examples": [ "false" ] }, "religion_category": { "type": "string", "enum": [ "none", "christian", "buddhist_taoist", "hindu", "other" ], "description": "For religious societies; ROS asks extra, faith-specific questions.", "examples": [ "none" ] }, "affiliation_documents": { "type": "array", "items": {}, "description": "document_refs for letters of affiliation, the affiliated body's constitution and support letters, in English.", "examples": [ "[]" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "society_name", "registration_route", "objects", "non_profit_declaration", "confirm_not_exempt", "founding_member_count", "registered_office", "email", "telephone", "constitution", "president", "secretary", "treasurer", "name", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Prepares an Application for Registration of Society on ROS eServices for a group of 10 or more persons. Entiva drafts the constitution from the ROS template and assembles the office-bearer and member data." }, "Create_sg_society_register": { "type": "object", "properties": { "type": { "const": "sg.society.register" }, "params": { "$ref": "#/components/schemas/Params_sg_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a society with the Registry of Societies", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "constitution", "title": "Society constitution", "source": "uploaded", "required": true }, { "key": "affiliation_and_support_letters", "title": "Letters of affiliation and support", "source": "uploaded", "required": false }, { "key": "religious_supplement", "title": "Religious society supplement", "source": "uploaded", "required": false }, { "key": "founding_resolution", "title": "Founding members' resolution adopting the constitution and authorising the office bearers", "source": "generated", "required": true }, { "key": "ros_application_summary", "title": "ROS application summary", "source": "generated", "required": true }, { "key": "ros_registration_notice", "title": "ROS registration outcome", "source": "registry_issued", "required": false }, { "key": "ros_application", "title": "Ros application", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "registry_idv" }, { "role": "officer", "verification_level": "identity" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "founding_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "Application for Registration of Society on ROS eServices", "channel": "online", "government_fee": { "amount": 400, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "singpass_required", "type": null, "when": "A key office bearer has no Singpass; ROS verification would fail." }, { "code": "society_exempt_from_registration", "type": null, "when": "confirm_not_exempt is false or an exemption applies." }, { "code": "member_count_below_minimum", "type": null, "when": "founding_member_count is below 10." }, { "code": "constitution_format_invalid", "type": null, "when": "The constitution is not English Word format." }, { "code": "alternative_names_missing", "type": null, "when": "registration_route is normal without two alternative names." }, { "code": "attachment_too_large", "type": null, "when": "A supporting file exceeds 5 MB." }, { "code": "office_bearer_roles_incomplete", "type": null, "when": "President, Secretary or Treasurer is missing or the same person holds two roles." } ] } }, "Params_sg_vcc_incorporate": { "type": "object", "properties": { "name_reservation_id": { "type": "string", "description": "act_ id of a completed sg.name.reserve action with entity_type vcc, made by Entiva's CSP and not older than 120 days.", "examples": [ "act_6Nd2YkWt" ] }, "name": { "type": "string", "description": "VCC name.", "examples": [ "Kestrel Opportunities" ] }, "vcc_structure": { "type": "string", "enum": [ "non_umbrella", "umbrella" ], "description": "non_umbrella is a single investment fund. umbrella has two or more sub-funds, each with its own assets and liabilities." }, "authorised_scheme": { "type": "boolean", "description": "True if the VCC runs an authorised scheme." }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day of the financial year end as MM-DD.", "examples": [ "12-31" ] }, "services": { "type": "array", "items": {}, "description": "Entiva services to attach: registered_office, company_secretary." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Required unless services includes registered_office.", "examples": [ "{\"line1\": \"1 Marina Boulevard\", \"line2\": \"#28-00\", \"city\": \"Singapore\", \"postal_code\": \"018989\", \"country\": \"SG\"}" ] }, "directors": { "type": "array", "items": {}, "description": "At least one." }, "secretary": { "type": "object", "description": "Object {person: per_ id}." }, "subscribers": { "type": "array", "items": {}, "description": "Subscribers to the VCC constitution, individuals or legal entities." }, "fund_manager": { "type": "object", "description": "The permissible fund manager." }, "eligible_fi": { "type": "object", "description": "The MAS-regulated financial institution the VCC engages to carry out its AML/CFT measures." }, "constitution_type": { "type": "string", "enum": [ "sal_model", "custom" ], "description": "sal_model uses one of the two model constitutions the Singapore Academy of Law provides. custom needs constitution_document." }, "constitution_document": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_type is custom." }, "initial_sub_funds": { "type": "array", "items": {}, "description": "Umbrella VCCs only." }, "represented_by_sg_professional": { "type": "boolean", "description": "True if a Singapore lawyer or public accountant represents the customer." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "vcc_structure", "financial_year_end", "directors", "subscribers", "fund_manager", "eligible_fi", "constitution_type", "nature_of_business", "countries_of_operation", "share_classes", "beneficial_owners" ], "description": "Register a VCC, a company for investment funds, on ACRA's VCC Portal. It needs a permissible fund manager who signs a declaration, qualified directors and a constitution." }, "Create_sg_vcc_incorporate": { "type": "object", "properties": { "type": { "const": "sg.vcc.incorporate" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Singapore variable capital company", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "vcc_constitution", "title": "VCC constitution", "source": "generated", "required": true }, { "key": "fund_manager_declaration", "title": "Fund manager's declaration of consent and qualifications", "source": "generated", "required": true }, { "key": "fund_manager_evidence", "title": "Fund manager's MAS licence, registration or exemption evidence", "source": "uploaded", "required": true }, { "key": "eligible_fi_engagement_letter", "title": "Engagement letter with the eligible financial institution", "source": "uploaded", "required": true }, { "key": "form_45", "title": "Form 45: consent to act as director and statement of non-disqualification", "source": "generated", "required": true }, { "key": "form_45b", "title": "Form 45B: consent to act as secretary", "source": "generated", "required": false }, { "key": "ownership_and_control_chart", "title": "Ownership and control chart down to each natural person", "source": "uploaded", "required": true }, { "key": "pass_issuer_consent", "title": "Pass-issuer consent for FIN holders", "source": "uploaded", "required": false }, { "key": "customer_acceptance_form", "title": "CSP customer acceptance form", "source": "generated", "required": true }, { "key": "agent_authority_evidence", "title": "Evidence of the agent's authority", "source": "generated", "required": false }, { "key": "controller_confirmation", "title": "Beneficial owner's dated confirmation of particulars", "source": "generated", "required": false }, { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "registration_application", "title": "VCC registration application record", "source": "generated", "required": true }, { "key": "notice_of_registration", "title": "ACRA notice of registration with the VCC's UEN", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "fund_manager_declaration", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "form_45", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_45b", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "vcc_constitution", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "eligible_fi_engagement_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "controller_confirmation", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "customer_acceptance_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC Portal registration", "channel": "online", "government_fee": { "amount": 8000, "currency": "SGD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_required", "type": null, "when": "422 invalid_request_error." }, { "code": "name_reservation_invalid", "type": null, "when": "422 requirement_error. name_reservation_id is expired, for another entity type, withdrawn, or not reserved by Entiva's CSP." }, { "code": "fund_manager_not_permissible", "type": null, "when": "422 requirement_error." }, { "code": "director_requirements_not_met", "type": null, "when": "422 requirement_error." }, { "code": "authorised_scheme_directors", "type": null, "when": "422 requirement_error." }, { "code": "eligible_fi_required", "type": null, "when": "422 requirement_error." }, { "code": "sub_funds_require_umbrella", "type": null, "when": "422 invalid_request_error. initial_sub_funds was given but vcc_structure is non_umbrella." }, { "code": "live_video_call_required", "type": null, "when": "422 requirement_error." }, { "code": "edd_evidence_required", "type": null, "when": "422 requirement_error." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." }, { "code": "human_presence_required", "type": null, "when": "403 permission_error." }, { "code": "mandate_required", "type": null, "when": "403 permission_error." } ] } }, "Params_sg_vcc_eligible_fi_engage": { "type": "object", "properties": { "engagement_type": { "type": "string", "enum": [ "initial", "replacement" ], "description": "initial or replacement.", "examples": [ "initial" ] }, "eligible_fi_name": { "type": "string", "description": "Name of the financial institution.", "examples": [ "Harbour Trust Company Pte. Ltd." ] }, "eligible_fi_uen": { "type": "string", "description": "UEN of the institution.", "examples": [ "200912345C" ] }, "eligible_fi_class": { "type": "string", "enum": [ "bank", "merchant_bank", "finance_company", "licensed_financial_adviser", "capital_markets_services_licence_holder", "faa_exempt_person_reg_27_1_d", "sfa_s99_1_h_exempt_person", "approved_trustee", "licensed_trust_company", "direct_life_insurer", "registered_insurance_broker" ], "description": "Class from Appendix 2 of MAS Notice VCC-N01.", "examples": [ "licensed_trust_company" ] }, "mas_licence_reference": { "type": "string", "description": "Licence, approval or registration reference checked on MAS's directory.", "examples": [ "TC-0123" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the engagement starts.", "examples": [ "2026-11-02" ] }, "engagement_scope_confirmed": { "type": "boolean", "description": "Confirms the engagement covers every paragraph of the Notice except paragraphs 3, 4 and 10.", "examples": [ "true" ] }, "data_access_confirmed": { "type": "boolean", "description": "Confirms the EFI will give the VCC any data, documents or information from its customer measures without delay on request (para 4.2).", "examples": [ "true" ] }, "not_precluded_by_mas_confirmed": { "type": "boolean", "description": "Confirms MAS has not specifically precluded VCCs from engaging this EFI (para 4.2).", "examples": [ "true" ] }, "outgoing_eligible_fi_name": { "type": "string", "description": "Required for replacement.", "examples": [ "Old Trust Co Pte. Ltd." ] }, "outgoing_fi_records_received": { "type": "boolean", "description": "For replacement: true once the outgoing EFI's customer records are with the VCC or the new EFI.", "examples": [ "true" ] }, "engagement_letter": { "type": "string", "pattern": "^doc_", "description": "Executed engagement letter.", "examples": [ "doc_1QzEng7" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "VCC director who signs for the VCC.", "examples": [ "per_1QzVd9kJ" ] }, "efi_signatory": { "type": "string", "pattern": "^per_", "description": "Authorised signatory of the EFI.", "examples": [ "per_1QzEf4mQ" ] } }, "required": [ "engagement_type", "eligible_fi_name", "eligible_fi_uen", "eligible_fi_class", "mas_licence_reference", "effective_date", "engagement_scope_confirmed", "data_access_confirmed", "not_precluded_by_mas_confirmed", "engagement_letter", "authorised_signatory", "efi_signatory" ], "description": "Records the VCC's engagement of an eligible financial institution to carry out the AML/CFT measures MAS Notice VCC-N01 requires. Entiva checks the EFI's class against Appendix 2 of the Notice, collects the engagement letter and the." }, "Create_sg_vcc_eligible_fi_engage": { "type": "object", "properties": { "type": { "const": "sg.vcc_eligible_fi.engage" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_eligible_fi_engage" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Engage or replace a VCC's eligible financial institution for AML/CFT", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "VCC board resolution engaging the eligible financial institution", "source": "generated", "required": true }, { "key": "engagement_letter", "title": "Engagement letter between the VCC and the EFI", "source": "uploaded", "required": true }, { "key": "efi_status_evidence", "title": "MAS directory extract for the EFI", "source": "generated", "required": true }, { "key": "outgoing_efi_records_receipt", "title": "Receipt for records from the outgoing EFI", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "engagement_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "engagement_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. Compliance record under MAS Notice VCC-N01 para 4.1", "form": "No form. Engagement letter and confirmations are kept on the entity's file", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "efi_class_not_eligible", "type": null, "when": "The institution is not in an Appendix 2 class or its MAS status cannot be confirmed." }, { "code": "efi_precluded_by_mas", "type": null, "when": "MAS has precluded VCCs from engaging this institution." }, { "code": "engagement_scope_incomplete", "type": null, "when": "The engagement does not cover the Notice's required measures." }, { "code": "data_access_not_confirmed", "type": null, "when": "The EFI has not agreed to supply records without delay." }, { "code": "outgoing_efi_required", "type": null, "when": "Replacement without outgoing_eligible_fi_name." }, { "code": "entity_not_vcc", "type": null, "when": "The entity is not a variable capital company." } ] } }, "Params_sg_vcc_fund_manager_appoint": { "type": "object", "properties": { "appointment_type": { "type": "string", "enum": [ "initial", "replacement" ], "description": "initial for a VCC set up without a manager on file; replacement when changing manager.", "examples": [ "replacement" ] }, "fund_manager_uen": { "type": "string", "description": "UEN of the fund manager, or its foreign registration number.", "examples": [ "201812345K" ] }, "fund_manager_name": { "type": "string", "description": "Registered name of the fund manager.", "examples": [ "Merlion Asset Management Pte. Ltd." ] }, "fund_manager_business_address": { "$ref": "#/components/schemas/Address", "description": "Business address of the fund manager.", "examples": [ "{\"line1\":\"10 Collyer Quay\",\"postal_code\":\"049315\",\"country\":\"SG\"}" ] }, "fund_manager_country_of_incorporation": { "type": "string", "description": "ISO 3166 country code.", "examples": [ "SG" ] }, "fund_manager_category": { "type": "string", "enum": [ "licensed_fund_management_company", "registered_fund_management_company", "exempt_financial_institution" ], "description": "Permissible categories: a capital markets services licence holder for fund management, a registered fund management company, or a financial institution exempt.", "examples": [ "licensed_fund_management_company" ] }, "mas_status_reference": { "type": "string", "description": "Licence or registration reference, checked against the MAS Financial Institutions Directory.", "examples": [ "CMS100123" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-11-02" ] }, "outgoing_fund_manager_uen": { "type": "string", "description": "Required for replacement.", "examples": [ "201511111Z" ] }, "fund_manager_signatory": { "type": "string", "pattern": "^per_", "description": "Authorised signatory of the manager who signs the consent and qualifications declaration.", "examples": [ "per_1QzFm2pX" ] }, "manager_linked_director": { "type": "string", "pattern": "^per_", "description": "VCC director who is a director of the fund manager or a Qualified Representative under the VCC Act, and is fit and proper under the VCC Regulations 2020.", "examples": [ "per_1QzVd9kJ" ] }, "management_agreement": { "type": "string", "pattern": "^doc_", "description": "Executed management agreement between the VCC and the manager.", "examples": [ "doc_1QzMgmt3" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "VCC director who signs the board resolution for the VCC.", "examples": [ "per_1QzVd9kJ" ] } }, "required": [ "appointment_type", "fund_manager_uen", "fund_manager_name", "fund_manager_business_address", "fund_manager_country_of_incorporation", "fund_manager_category", "mas_status_reference", "effective_date", "fund_manager_signatory", "manager_linked_director", "authorised_signatory" ], "description": "Records and files the appointment of the single permissible fund manager every Singapore VCC must have. Entiva checks the manager's MAS status, collects the manager's signed consent and qualifications declaration, confirms a VCC." }, "Create_sg_vcc_fund_manager_appoint": { "type": "object", "properties": { "type": { "const": "sg.vcc_fund_manager.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_fund_manager_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint or replace a VCC's permissible fund manager", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "VCC board resolution appointing the fund manager", "source": "generated", "required": true }, { "key": "fund_manager_declaration", "title": "Fund manager declaration of consent and qualifications", "source": "generated", "required": true }, { "key": "mas_status_evidence", "title": "MAS Financial Institutions Directory extract", "source": "generated", "required": true }, { "key": "management_agreement", "title": "Management agreement", "source": "uploaded", "required": false }, { "key": "fund_manager_corporate_documents", "title": "Fund manager corporate documents and ownership chart", "source": "uploaded", "required": false }, { "key": "register_of_managers", "title": "Updated register of managers", "source": "generated", "required": true }, { "key": "updated_vcc_profile", "title": "Updated ACRA VCC Business Profile", "source": "registry_issued", "required": false }, { "key": "vcc_portal_update", "title": "Vcc portal update", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fund_manager_declaration", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "vcc_portal_update", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC Portal update of VCC information and officers", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fund_manager_not_permissible", "type": null, "when": "The manager is not a licensed, registered or exempt fund manager under the SFA." }, { "code": "fund_manager_status_unverified", "type": null, "when": "The MAS Financial Institutions Directory does not confirm the stated status." }, { "code": "no_manager_linked_director", "type": null, "when": "No VCC director is a director of the manager or a Qualified Representative after the change." }, { "code": "outgoing_manager_required", "type": null, "when": "Replacement without outgoing_fund_manager_uen, or the VCC has no manager on file." }, { "code": "declaration_missing", "type": null, "when": "The manager's signed declaration is not received." }, { "code": "entity_not_vcc", "type": null, "when": "The entity is not a variable capital company." }, { "code": "filing_window_exceeded", "type": null, "when": "effective_date is more than 14 days ago; the filing will be late." } ] } }, "Params_sg_vcc_sub_fund_register": { "type": "object", "properties": { "sub_fund_name": { "type": "string", "description": "Proposed sub-fund name." }, "formation_date": { "type": "string", "format": "date", "description": "The date the sub-fund will be formed." }, "in_principle_approvals": { "type": "array", "items": {}, "description": "Array of document_ref for in-principle approvals from other authorities, where a name or activity needs them." }, "board_resolution": { "type": "string", "pattern": "^doc_", "description": "The VCC board's resolution approving the sub-fund." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "sub_fund_name", "formation_date", "name", "nature_of_business", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Register one sub-fund of an umbrella variable capital company through ACRA's VCC Portal. Each sub-fund has its own assets and liabilities, a name that follows ACRA's naming guidelines, and a formation date." }, "Create_sg_vcc_sub_fund_register": { "type": "object", "properties": { "type": { "const": "sg.vcc_sub_fund.register" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_sub_fund_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a sub-fund of an umbrella VCC", "x-entiva": { "jurisdiction": "sg", "stage": "formation", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "filing_authorisation", "title": "Customer's filing authorisation", "source": "generated", "required": true }, { "key": "sub_fund_application", "title": "Sub-fund registration record", "source": "generated", "required": true }, { "key": "board_resolution", "title": "VCC board resolution approving the sub-fund", "source": "generated", "required": true }, { "key": "in_principle_approval", "title": "In-principle approval from another authority", "source": "uploaded", "required": false }, { "key": "sub_fund_registration_notice", "title": "ACRA sub-fund registration notice with sub-fund number", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sub_fund_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC Portal 'Registration of Sub-Fund' transaction under EServices", "channel": "online", "government_fee": { "amount": 400, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_vcc", "type": null, "when": "422 jurisdiction_error." }, { "code": "vcc_not_umbrella", "type": null, "when": "422 requirement_error." }, { "code": "sub_fund_name_unavailable", "type": null, "when": "422 registry_error." }, { "code": "registration_window_missed", "type": null, "when": "422 requirement_error. formation_date is more than seven days in the past, beyond the window in ACRA's guide." }, { "code": "verification_required", "type": null, "when": "422 requirement_error." }, { "code": "screening_hold", "type": null, "when": "409 requirement_error." } ] } }, "Params_sg_accounting_standards_exemption_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the financial statements the exemption is for." }, "standard_to_depart_from": { "type": "string", "description": "The accounting standard or requirement the company wants exempted." }, "grounds": { "type": "string", "description": "Why the exemption is needed." }, "proposed_alternative_treatment": { "type": "string", "description": "How the affected items will be presented instead." }, "prepared_under_ifrs_only": { "type": "boolean", "description": "True if the statements are prepared only under IFRS." } }, "required": [ "entity_type", "financial_year_end", "standard_to_depart_from", "grounds", "proposed_alternative_treatment" ], "description": "Applies on Bizfile for an exemption from compliance with the accounting standards for a financial year. ACRA grants these in limited circumstances, and the application should be submitted at least 6 months before the filing deadline." }, "Create_sg_accounting_standards_exemption_apply": { "type": "object", "properties": { "type": { "const": "sg.accounting_standards_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_accounting_standards_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to ACRA for exemption from accounting standards (Companies Act s201)", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_application", "title": "Exemption application with grounds", "source": "generated", "required": true }, { "key": "board_resolution_authorising_application", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "exemption_submission", "title": "Bizfile application: Apply for exemption from financial statement requirements", "source": "generated", "required": true }, { "key": "acra_exemption_decision", "title": "ACRA decision on the exemption", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_authorising_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'Apply for exemption from financial statement requirements', lodgement ty", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "application_too_late", "type": null, "when": "[requirement_error] Fewer than 6 months remain before the filing deadline." }, { "code": "ifrs_only_unlikely_to_be_approved", "type": null, "when": "[requirement_error] Warning: ACRA generally does not approve exemptions for statements prepared only under IFRS." }, { "code": "grounds_insufficient", "type": null, "when": "[requirement_error] The grounds do not explain why the standard cannot be applied." }, { "code": "wrong_application_type", "type": null, "when": "[requirement_error] The request is about form and content, not accounting standards." } ] } }, "Params_sg_acra_document_legalise": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "description": "Entity type key." }, "documents": { "type": "array", "items": {}, "description": "Array of document_ref for the ACRA documents to legalise, normally delivered by sg.acra_information_product.order with electronic certification." }, "destination_country": { "type": "string", "description": "ISO 3166 alpha-2 code of the country where the document will be used." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Where Entiva sends the apostilled documents." } }, "required": [ "entity_type", "documents", "destination_country", "delivery_address" ], "description": "Has the Singapore Academy of Law legalise ACRA-issued documents for use abroad by affixing an apostille. No notary is needed for public documents, but computer-generated documents must first be certified by ACRA." }, "Create_sg_acra_document_legalise": { "type": "object", "properties": { "type": { "const": "sg.acra_document.legalise" }, "params": { "$ref": "#/components/schemas/Params_sg_acra_document_legalise" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apostille ACRA certificates and other Singapore public documents", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "acra_certified_document", "title": "ACRA-certified document to be legalised", "source": "registry_issued", "required": true }, { "key": "sal_request_receipt", "title": "SAL online request and payment receipt", "source": "registry_issued", "required": true }, { "key": "sal_apostille_certificate", "title": "Apostille Certificate affixed by SAL", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "acra_certified_document", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Singapore Academy of Law", "form": "SAL Legalisation online request and payment", "channel": "online", "government_fee": { "amount": 10.7, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "document_not_certified", "type": null, "when": "[requirement_error] The document is computer-generated and not yet certified by ACRA." }, { "code": "not_a_public_document", "type": null, "when": "[requirement_error] The document is a private corporate document." }, { "code": "original_required", "type": null, "when": "[requirement_error] SAL needs originals." }, { "code": "embassy_legalisation_may_apply", "type": null, "when": "[jurisdiction_error] Warning: the destination may not be a party to the Apostille Convention." }, { "code": "destination_country_invalid", "type": null, "when": "[invalid_request_error] destination_country is not an ISO 3166 alpha-2 code." } ] } }, "Params_sg_acra_information_product_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "description": "Entity type key." }, "product": { "type": "string", "enum": [ "business_profile", "corporate_compliance_and_financial_profile", "people_profile", "extract", "certificate", "register" ], "description": "Which ACRA product to buy." }, "uen": { "type": "string", "description": "UEN of the entity to buy about." }, "register_type": { "type": "string", "enum": [ "members", "directors", "chief_executive_officers", "secretaries", "auditors" ], "description": "Required when product is register." }, "extract_document": { "type": "string", "description": "Required when product is extract." }, "certificate_name": { "type": "string", "description": "Required when product is certificate." }, "person": { "type": "string", "pattern": "^per_", "description": "Required when product is people_profile." }, "electronic_certification": { "type": "boolean", "description": "ACRA electronic certification, available for products such as Extracts and Registers, at S$1 per page." }, "for_use_abroad": { "type": "boolean", "description": "True to chain an sg.acra_document.apostille action once the document is delivered." } }, "required": [ "entity_type", "product" ], "description": "Buys an ACRA information product for the entity or for another Singapore entity: Business Profile, Corporate Compliance and Financial Profile, People Profile, certificate, extract of a past filing, or register." }, "Create_sg_acra_information_product_request": { "type": "object", "properties": { "type": { "const": "sg.acra_information_product.request" }, "params": { "$ref": "#/components/schemas/Params_sg_acra_information_product_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order an ACRA information product", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "acra_information_product", "title": "ACRA information product", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "acra_information_product", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Buy information': Business Profile, Corporate Compliance and Financial Profile, P", "channel": "online", "government_fee": { "amount": 5.5, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "product_parameter_missing", "type": null, "when": "[invalid_request_error] A parameter the product needs is missing, for example register_type for a register or person_id for a People Profile." }, { "code": "uen_not_found", "type": null, "when": "[registry_error] ACRA has no entity with that UEN." }, { "code": "entity_ceased_limited_information", "type": null, "when": "[registry_error] Warning: ceased entities show limited information and no addresses." }, { "code": "person_not_linked_to_entity", "type": null, "when": "[requirement_error] The person has no role in the entity or the account, so a People Profile cannot be ordered." }, { "code": "download_window_expired", "type": null, "when": "[registry_error] The 30-day download window has passed." } ] } }, "Params_sg_agm_hold": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Financial year the AGM covers.", "examples": [ "2026-06-30" ] }, "meeting_date": { "type": "string", "format": "date", "description": "AGM date; must fall within the deadline.", "examples": [ "2026-12-10" ] }, "meeting_format": { "type": "string", "enum": [ "physical", "hybrid", "virtual" ], "description": "Physical, hybrid or fully virtual, as the constitution allows.", "examples": [ "hybrid" ] }, "venue_or_link": { "type": "string", "description": "Venue address or meeting link.", "examples": [ "https://meet.example.sg/agm-2026" ] }, "notice_days": { "type": "integer", "description": "Days of written notice; at least 14, or longer if the constitution says so.", "examples": [ "21" ] }, "short_notice_consent": { "type": "boolean", "description": "All members entitled to attend and vote agree to shorter notice of the AGM.", "examples": [ "false" ] }, "listed": { "type": "boolean", "description": "Listed company: 4-month deadline.", "examples": [ "false" ] }, "chair": { "type": "string", "pattern": "^per_", "description": "Director chairing the meeting; signs the minutes.", "examples": [ "per_1QdA7x" ] }, "resolutions": { "type": "array", "items": {}, "description": "Items to be passed, each {title, kind} with kind ordinary or special.", "examples": [ "[{\"title\":\"Adopt the audited financial statements\",\"kind\":\"ordinary\"}]" ] }, "financial_statements_action_id": { "type": "string", "description": "act_ id of the sg.financial_statements.file action whose statements are laid.", "examples": [ "act_1RfK2mFsAb" ] }, "extension_of_time_action_id": { "type": "string", "description": "act_ id of a granted AGM extension.", "examples": [ "act_1RaE5tEoPq" ] } }, "required": [ "financial_year_end", "meeting_date", "meeting_format", "notice_days", "chair" ], "description": "Convenes and records the AGM: board resolution to call it, notice, the audited financial statements pack, proxies, voting and minutes. Deadline is 6 months after FYE and 6 months for a VCC." }, "Create_sg_agm_hold": { "type": "object", "properties": { "type": { "const": "sg.agm.hold" }, "params": { "$ref": "#/components/schemas/Params_sg_agm_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Hold the annual general meeting", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_convening_agm", "title": "Board resolution convening the AGM", "source": "generated", "required": true }, { "key": "notice_of_agm", "title": "Notice of AGM", "source": "generated", "required": true }, { "key": "financial_statements_pack", "title": "Audited financial statements pack", "source": "uploaded", "required": true }, { "key": "proxy_form", "title": "Proxy form", "source": "generated", "required": false }, { "key": "minutes_of_agm", "title": "Minutes of the AGM", "source": "generated", "required": true }, { "key": "attendance_and_voting_record", "title": "Attendance and voting record", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "proxy", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_convening_agm", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_agm", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "proxy_form", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes_of_agm", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No ACRA form. The AGM date, or the exemption relied on, is declared in the annual return", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_deadline_passed", "type": null, "when": "requirement_error: meeting_date is after the s175 deadline and no extension is attached." }, { "code": "notice_period_too_short", "type": null, "when": "invalid_request_error: notice_days is under 14 without unanimous consent for an AGM." }, { "code": "audit_not_ready", "type": null, "when": "requirement_error: the audited statements will not be ready 14 days before the meeting." }, { "code": "agm_not_required_for_year", "type": null, "when": "invalid_request_error: a dispensing resolution is in force or another exemption applies; use sg.agm_financial_statements.send or declare the exemption." }, { "code": "member_register_incomplete", "type": null, "when": "requirement_error: the register of members lacks an address for a member entitled to notice." } ] } }, "Params_sg_agm_waive": { "type": "object", "properties": { "route": { "type": "string", "enum": [ "members_resolution", "dormant_relevant_company", "vcc_notice_and_documents" ], "description": "Which exemption applies.", "examples": [ "members_resolution" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "First financial year the dispensation applies to.", "examples": [ "2026-06-30" ] }, "general_meeting_date": { "type": "string", "format": "date", "description": "Members_resolution route: date of the general meeting at which all members vote.", "examples": [ "2026-11-20" ] }, "meeting_format": { "type": "string", "enum": [ "physical", "hybrid", "virtual" ], "description": "Members_resolution route: physical, hybrid or virtual.", "examples": [ "virtual" ] }, "attending_members": { "type": "array", "items": {}, "description": "Members_resolution route: person_ref list of every member entitled to vote, each attending or represented by proxy.", "examples": [ "[\"per_1QdA7x\",\"per_1QdC3z\"]" ] }, "proxy_instruments": { "type": "array", "items": {}, "description": "Members_resolution route: doc_ ids of proxy forms for members who cannot attend.", "examples": [ "[\"doc_1RgB2qPxZk\"]" ] }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Dormant route: total assets at any time in the year.", "examples": [ "{\"amount\":12000000,\"currency\":\"SGD\"}" ] }, "agm_due_date": { "type": "string", "format": "date", "description": "VCC route: the AGM due date.", "examples": [ "2026-12-31" ] }, "notice_sent_date": { "type": "string", "format": "date", "description": "VCC route: date members were notified; at least 60 days before agm_due_date.", "examples": [ "2026-10-20" ] }, "audited_statements_send_date": { "type": "string", "format": "date", "description": "VCC route, and companies with a dispensing resolution: date the audited statements are sent; within 5 months after FYE.", "examples": [ "2026-11-25" ] } }, "required": [ "route", "financial_year_end" ], "description": "Records the route by which a company or VCC need not hold an AGM. Private companies: a dispensing resolution passed at a general meeting by all members entitled to vote (s175A), or confirmation of the dormant-company exemption." }, "Create_sg_agm_waive": { "type": "object", "properties": { "type": { "const": "sg.agm.waive" }, "params": { "$ref": "#/components/schemas/Params_sg_agm_waive" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dispense with the annual general meeting", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_meeting_minutes", "title": "Minutes of the general meeting passing the dispensing resolution", "source": "generated", "required": false }, { "key": "proxy_instruments", "title": "Proxy instruments", "source": "uploaded", "required": false }, { "key": "register_of_members_extract", "title": "Register of members extract", "source": "generated", "required": false }, { "key": "dormancy_determination", "title": "Dormancy determination", "source": "generated", "required": false }, { "key": "vcc_no_agm_notice", "title": "VCC notice that no AGM will be held", "source": "generated", "required": false }, { "key": "audited_financial_statements_pack", "title": "Audited financial statements pack", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "proxy_instruments", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No ACRA form. The dispensation or exemption is declared in the annual return", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_all_members_voting", "type": null, "when": "requirement_error: a member entitled to vote is neither present nor represented, or votes against, so the s175A resolution cannot pass." }, { "code": "written_resolution_not_permitted", "type": null, "when": "invalid_request_error: the customer tried to pass the dispensing resolution by written resolution, which s184A excludes." }, { "code": "dormancy_test_failed", "type": null, "when": "requirement_error: total assets exceed S$500,000, the company is listed or a subsidiary of a listed company, or it had significant accounting transactions." }, { "code": "vcc_notice_too_late", "type": null, "when": "requirement_error: notice_sent_date is less than 60 days before agm_due_date." }, { "code": "documents_deadline_passed", "type": null, "when": "requirement_error: audited_statements_send_date is more than 5 months after FYE." }, { "code": "route_not_available", "type": null, "when": "jurisdiction_error: the chosen route does not fit the entity type." } ] } }, "Params_sg_agm_financial_statements_notify": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Financial year the statements cover.", "examples": [ "2026-03-31" ] }, "send_date": { "type": "string", "format": "date", "description": "Date the pack is sent; must be within 5 months after FYE.", "examples": [ "2026-08-20" ] }, "delivery_method": { "type": "string", "enum": [ "email", "post", "email_and_post" ], "description": "How the pack reaches each recipient.", "examples": [ "email" ] }, "parent_company": { "type": "boolean", "description": "True if the company is a parent: consolidated statements and the parent balance sheet are sent too.", "examples": [ "false" ] }, "additional_recipients": { "type": "array", "items": {}, "description": "person_ref list of other persons entitled to notice of general meetings, such as debenture holders.", "examples": [ "[]" ] }, "financial_statements_action_id": { "type": "string", "description": "act_ id of the sg.financial_statements.file action.", "examples": [ "act_1RfK2mFsAb" ] } }, "required": [ "financial_year_end", "send_date", "delivery_method" ], "description": "A private company need not hold an AGM for a year if it sends the audited financial statements and auditor's report to everyone entitled to notice of general meetings within 5 months after FYE. Entiva prepares the pack, records the." }, "Create_sg_agm_financial_statements_notify": { "type": "object", "properties": { "type": { "const": "sg.agm_financial_statements.notify" }, "params": { "$ref": "#/components/schemas/Params_sg_agm_financial_statements_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Send financial statements to members instead of holding an AGM", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "audited_financial_statements_pack", "title": "Audited financial statements and auditor's report", "source": "uploaded", "required": true }, { "key": "consolidated_financial_statements", "title": "Consolidated statements and parent balance sheet", "source": "uploaded", "required": false }, { "key": "board_resolution_circulating_accounts", "title": "Board resolution approving the accounts and their circulation", "source": "generated", "required": true }, { "key": "transmittal_notice", "title": "Covering notice to members", "source": "generated", "required": true }, { "key": "delivery_log", "title": "Delivery log", "source": "generated", "required": false }, { "key": "directors_statement", "title": "Directors statement", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_circulating_accounts", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_statement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "transmittal_notice", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No ACRA form. The exemption and the send date are declared in the annual return", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "send_deadline_passed", "type": null, "when": "requirement_error: send_date is more than 5 months after FYE, so the exemption is lost for the year." }, { "code": "company_not_private", "type": null, "when": "jurisdiction_error: public companies and companies limited by guarantee cannot use this route." }, { "code": "audit_not_complete", "type": null, "when": "requirement_error: the audited statements and auditor's report are not yet available." }, { "code": "recipient_address_missing", "type": null, "when": "requirement_error: a member or other recipient has no valid email or postal address on the register." }, { "code": "meeting_requested", "type": null, "when": "requirement_error: a member or the auditor required a general meeting; Entiva opens an sg.agm.hold action that must meet within 14 days of the notice." } ] } }, "Params_sg_annual_return_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end the return covers.", "examples": [ "2026-03-31" ] }, "company_status": { "type": "string", "enum": [ "active", "dormant" ], "description": "Active or dormant.", "examples": [ "active" ] }, "listed_on_sgx": { "type": "boolean", "description": "Whether the company was listed on a Singapore securities exchange during the period or at filing.", "examples": [ "false" ] }, "has_overseas_branch_register": { "type": "boolean", "description": "Company with share capital that keeps a branch register outside Singapore.", "examples": [ "false" ] }, "agm_status": { "type": "string", "enum": [ "held", "exempt_financial_statements_sent", "exempt_dormant", "dispensed_by_resolution" ], "description": "AGM position declared in the return.", "examples": [ "held" ] }, "agm_date": { "type": "string", "format": "date", "description": "Required when agm_status is held.", "examples": [ "2026-09-15" ] }, "financial_statements_sent_date": { "type": "string", "format": "date", "description": "Required when the company is AGM-exempt because it sent the financial statements to members.", "examples": [ "2026-08-20" ] }, "financial_statements_action_id": { "type": "string", "description": "act_ id of the sg.financial_statements.file action.", "examples": [ "act_1RfK2mFsAb" ] }, "solvency_status": { "type": "string", "enum": [ "solvent", "insolvent", "required_by_law_to_file_accounts" ], "description": "Exempt private companies only: declared online at filing.", "examples": [ "solvent" ] }, "audit_exemption_claimed": { "type": "boolean", "description": "Whether the small-company audit exemption is claimed.", "examples": [ "true" ] }, "auditor": { "type": "object", "description": "{name, acra_registration_number} for companies not exempt from audit.", "examples": [ "{\"name\":\"Lim & Co PAC\",\"acra_registration_number\":\"T08PF0123A\"}" ] }, "ceo_exists": { "type": "boolean", "description": "From 20 Oct 2026: whether any individual performs the role of CEO.", "examples": [ "false" ] }, "particulars_confirmed": { "type": "boolean", "description": "From 20 Oct 2026: customer confirms ACRA's current particulars for directors, CEOs, secretaries, auditors and relevant members are accurate.", "examples": [ "true" ] }, "directors_statement_signers": { "type": "array", "items": {}, "description": "person_ref list of directors who sign the directors' statement: at least two, or the single director of a sole-director company.", "examples": [ "[\"per_1QdA7x\",\"per_1QdB9y\"]" ] }, "directors_interests_disclosure": { "type": "string", "description": "Answer to Bizfile's directors' interests disclosure question; state 'acra_approval_obtained' where ACRA approval was given.", "examples": [ "none_to_disclose" ] }, "register_locations": { "type": "object", "description": "For rorc, rond and rons: registered_office, csp_registered_office or exempt:.", "examples": [ "{\"rorc\":\"csp_registered_office\",\"rond\":\"csp_registered_office\",\"rons\":\"csp_registered_office\"}" ] }, "acknowledge_late_penalty": { "type": "boolean", "description": "Required when the due date has passed.", "examples": [ "false" ] }, "extension_of_time_action_id": { "type": "string", "description": "act_ id of a granted sg.extension_of_time.apply action.", "examples": [ "act_1RaE5tEoPq" ] } }, "required": [ "financial_year_end", "company_status", "agm_status", "ceo_exists", "particulars_confirmed" ], "description": "Entiva, as an ACRA-registered CSP, files the Bizfile annual return for a Singapore company. It checks the pre-filled record, declares AGM status and the RORC/ROND/RONS locations or exemptions, attaches the financial statements and pays." }, "Create_sg_annual_return_file": { "type": "object", "properties": { "type": { "const": "sg.annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the company annual return", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_statement", "title": "Directors' statement", "source": "generated", "required": false }, { "key": "financial_statements_pdf", "title": "Financial statements", "source": "uploaded", "required": false }, { "key": "xbrl_package", "title": "XBRL package", "source": "generated", "required": false }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "agm_record", "title": "AGM minutes or written resolution", "source": "uploaded", "required": false }, { "key": "annual_return_acknowledgement", "title": "Bizfile acknowledgement and receipt", "source": "registry_issued", "required": false }, { "key": "business_profile", "title": "Free Business Profile", "source": "registry_issued", "required": false }, { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true }, { "key": "bizfile_annual_return", "title": "Bizfile annual return", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_statement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_annual_return", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File annual returns'", "channel": "online", "government_fee": { "amount": 60, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "financial_statements_required", "type": null, "when": "requirement_error: no XBRL package or PDF is attached and the company is not a solvent exempt private company or dormant relevant company." }, { "code": "directors_statement_unsigned", "type": null, "when": "requirement_error: fewer than two directors have signed the directors' statement." }, { "code": "agm_details_missing", "type": null, "when": "invalid_request_error: agm_status is held without agm_date, or an exemption route without financial_statements_sent_date." }, { "code": "officer_records_out_of_date", "type": null, "when": "requirement_error: ACRA's particulars differ from the customer's." }, { "code": "overdue_returns_exist", "type": null, "when": "requirement_error: earlier financial years are unfiled." }, { "code": "late_penalty_unacknowledged", "type": null, "when": "requirement_error: the due date has passed and acknowledge_late_penalty is not true." }, { "code": "register_status_missing", "type": null, "when": "requirement_error: no location or exemption category is set for the RORC, ROND or RONS where they apply." }, { "code": "bizfile_rejected", "type": null, "when": "registry_error: Bizfile refused the submission; the message carries ACRA's reason." } ] } }, "Params_sg_audit_engage": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year to be audited." }, "auditor_id": { "type": "string", "pattern": "^ent_", "description": "The auditor already on file for the entity." }, "audit_firm_name": { "type": "string", "description": "Name of the audit firm or public accountant, if not on file." }, "engagement_scope": { "type": "string", "enum": [ "single_entity_statutory_audit", "consolidated_group_audit" ], "description": "Single-entity statutory audit, or a consolidated group audit." }, "target_report_date": { "type": "string", "format": "date", "description": "Date the signed audit report is needed." } }, "required": [ "entity_type", "financial_year_end", "engagement_scope", "target_report_date" ], "description": "Engages an ACRA-registered public accountant to audit the year's financial statements: checks the auditor's registration, sets the timetable against the AGM or member-sending deadline, and collects the engagement letter, board approval and." }, "Create_sg_audit_engage": { "type": "object", "properties": { "type": { "const": "sg.audit.engage" }, "params": { "$ref": "#/components/schemas/Params_sg_audit_engage" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Commission the statutory audit", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "auditor_registration_check", "title": "ACRA register check of the auditor", "source": "generated", "required": true }, { "key": "board_resolution_engaging_auditor", "title": "Board resolution engaging the auditor for the year", "source": "generated", "required": true }, { "key": "audit_engagement_letter", "title": "Audit engagement letter", "source": "uploaded", "required": true }, { "key": "management_representation_letter", "title": "Management representation letter", "source": "generated", "required": true }, { "key": "audit_report", "title": "Signed auditor's report", "source": "uploaded", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" }, { "role": "partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_engaging_auditor", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "audit_engagement_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "management_representation_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "audit_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "No filing under this action. The signed audit report goes with the financial statements, w", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_not_identified", "type": null, "when": "[invalid_request_error] Neither auditor_id nor audit_firm_name is given." }, { "code": "auditor_not_registered", "type": null, "when": "[requirement_error] The firm is not on ACRA's register of public accountants and accounting entities." }, { "code": "audit_exemption_on_file", "type": null, "when": "[requirement_error] Warning: the company has a current audit exemption claim for this year." }, { "code": "target_report_date_too_late", "type": null, "when": "[requirement_error] The target date is after the AGM or member-sending deadline." }, { "code": "engagement_letter_unsigned", "type": null, "when": "[requirement_error] The engagement letter has not been signed by the company." } ] } }, "Params_sg_audit_exemption_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the exemption is for." }, "ground": { "type": "string", "enum": [ "small_company", "dormant" ], "description": "small_company: a private company meeting 2 of 3 tests. dormant: s205B, not limited to private companies." }, "private_company_throughout_year": { "type": "boolean", "description": "Required for small_company." }, "criteria_tests": { "type": "array", "items": {}, "description": "Required for small_company." }, "part_of_group": { "type": "boolean", "description": "Required for small_company." }, "group_criteria_tests": { "type": "array", "items": {}, "description": "Required when part_of_group is true." }, "had_accounting_transactions": { "type": "boolean", "description": "Required for dormant." } }, "required": [ "entity_type", "financial_year_end", "ground" ], "description": "Tests whether the company is exempt from audit for a financial year under the small company rules or as a dormant company, and records the directors' decision. Nothing is applied for at ACRA." }, "Create_sg_audit_exemption_apply": { "type": "object", "properties": { "type": { "const": "sg.audit_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_audit_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Claim the audit exemption", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "audit_exemption_workings", "title": "Audit exemption test workings", "source": "generated", "required": true }, { "key": "board_resolution_audit_exemption", "title": "Board resolution noting reliance on the audit exemption", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_audit_exemption", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "None located. ACRA describes a self-assessed 'small company concept' and does not say how ", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_small_company", "type": null, "when": "[requirement_error] Fewer than 2 of the 3 tests are met for the test years." }, { "code": "not_private_company", "type": null, "when": "[requirement_error] The small company ground was used for a public company or a company limited by guarantee." }, { "code": "small_group_test_failed", "type": null, "when": "[requirement_error] The company is in a group and the group fails 2 of 3 tests for the past two consecutive years." }, { "code": "vcc_not_eligible", "type": null, "when": "[requirement_error] VCCs cannot use the audit exemptions." }, { "code": "dormancy_not_established", "type": null, "when": "[requirement_error] had_accounting_transactions is true, so the dormant ground is rejected." } ] } }, "Params_sg_business_registration_renew": { "type": "object", "properties": { "expiry_date": { "type": "string", "format": "date", "description": "Current registration expiry date.", "examples": [ "2026-12-14" ] }, "renewal_term_years": { "type": "string", "enum": [ "1", "3" ], "description": "1 year or 3 years.", "examples": [ "1" ] }, "registration_status": { "type": "string", "enum": [ "active", "expired", "cancelled" ], "description": "Cancelled registrations must be restored before renewal.", "examples": [ "active" ] }, "medisave_position": { "type": "string", "enum": [ "paid_in_full", "cpf_instalment_arrangement", "not_applicable" ], "description": "All owners' or partners' MediSave position with the CPF Board.", "examples": [ "paid_in_full" ] }, "instalment_months_completed": { "type": "integer", "description": "Months of consecutive instalment contributions completed.", "examples": [ "26" ] }, "giro_first_deduction_done": { "type": "boolean", "description": "For an instalment or GIRO arrangement: the first successful deduction must have occurred before renewing.", "examples": [ "true" ] }, "confirming_owners": { "type": "array", "items": {}, "description": "person_ref list of the owners or partners confirming the renewal and their MediSave position.", "examples": [ "[\"per_1QdG6t\"]" ] } }, "required": [ "expiry_date", "renewal_term_years", "medisave_position", "confirming_owners" ], "description": "Renews the registration of a limited partnership, general partnership or sole proprietorship on Bizfile for 1 or 3 years. Renewal opens 60 days before expiry and the registration can be cancelled 60 days after expiry." }, "Create_sg_business_registration_renew": { "type": "object", "properties": { "type": { "const": "sg.business_registration.renew" }, "params": { "$ref": "#/components/schemas/Params_sg_business_registration_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a business registration", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "lp", "general_partnership", "sole_proprietorship" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "renewal_authorisation", "title": "Renewal authorisation and MediSave confirmation", "source": "generated", "required": true }, { "key": "renewal_receipt", "title": "Bizfile acknowledgement and receipt", "source": "registry_issued", "required": false }, { "key": "business_profile", "title": "Updated Business Profile", "source": "registry_issued", "required": false }, { "key": "bizfile_renewal", "title": "Bizfile renewal", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "renewal_authorisation", "signer_role": "shareholder", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_renewal", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Renew business registration'", "channel": "online", "government_fee": { "amount": 30, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "renewal_window_not_open", "type": null, "when": "requirement_error: more than 60 days remain before expiry." }, { "code": "medisave_outstanding", "type": null, "when": "requirement_error: an owner has unpaid MediSave and no CPF Board arrangement; ACRA cannot process the renewal." }, { "code": "registration_cancelled", "type": null, "when": "requirement_error: the registration was cancelled after 60 days past expiry; restore it first, or register a new business." }, { "code": "three_year_not_eligible", "type": null, "when": "requirement_error: the 3-year term needs no outstanding MediSave or 24 months of instalments." }, { "code": "giro_deduction_pending", "type": null, "when": "requirement_error: the first GIRO deduction has not yet succeeded." }, { "code": "trading_after_expiry", "type": null, "when": "requirement_error: the registration expired; running the business after expiry is an offence, so Entiva warns and renews only on the owner's confirmation." } ] } }, "Params_sg_charity_annual_submission_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_guarantee", "registered_society" ], "description": "Entity type of the charity.", "examples": [ "public_ltd_guarantee" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year being reported.", "examples": [ "2026-06-30" ] }, "charity_status": { "type": "string", "enum": [ "charity", "ipc" ], "description": "charity: registered charity without IPC status. ipc: Institution of a Public Character.", "examples": [ "charity" ] }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Gross income for the financial year.", "examples": [ "{\"amount\":640000,\"currency\":\"SGD\"}" ] }, "total_expenditure": { "$ref": "#/components/schemas/Money", "description": "Total expenditure for the financial year.", "examples": [ "{\"amount\":598000,\"currency\":\"SGD\"}" ] }, "highest_income_or_expenditure_last_3_fy": { "$ref": "#/components/schemas/Money", "description": "Highest gross income or total expenditure in any of the last 3 financial years.", "examples": [ "{\"amount\":640000,\"currency\":\"SGD\"}" ] }, "accounts_assurance": { "type": "string", "enum": [ "audit_by_public_accountant", "independent_examination_isca_qualified", "independent_examination_competent_person" ], "description": "How the financial statements are audited or examined.", "examples": [ "audit_by_public_accountant" ] }, "financial_statements_signatories": { "type": "array", "items": {}, "description": "person_ref list of at least 2 governing board members who sign the financial statements, at least one holding a relevant office.", "examples": [ "[\"per_8Fk2Qm\",\"per_1Zt9Wd\"]" ] }, "overseas_activity": { "type": "boolean", "description": "True if the charity has overseas expenditure, capital outlay or remittances as agent, which carry extra disclosure.", "examples": [ "false" ] }, "gec_version": { "type": "string", "enum": [ "gec_2018", "gec_2024" ], "description": "Defaults to gec_2024 for financial years beginning on or after 1 Jan 2024, otherwise gec_2018.", "examples": [ "gec_2024" ] } }, "required": [ "entity_type", "financial_year_end", "charity_status", "gross_income", "total_expenditure", "highest_income_or_expenditure_last_3_fy", "accounts_assurance", "financial_statements_signatories" ], "description": "Prepares and tracks the annual report, financial statements, Online Financial Summary and Governance Evaluation Checklist for a charity that is a company limited by guarantee or a registered society. An authorised officer submits on the." }, "Create_sg_charity_annual_submission_file": { "type": "object", "properties": { "type": { "const": "sg.charity_annual_submission.file" }, "params": { "$ref": "#/components/schemas/Params_sg_charity_annual_submission_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a charity's or IPC's annual submissions with the Commissioner of Charities", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "public_ltd_guarantee", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Annual report", "source": "uploaded", "required": true }, { "key": "financial_statements", "title": "Financial statements signed by at least 2 governing board members", "source": "uploaded", "required": true }, { "key": "assurance_report", "title": "Auditor's report or independent examiner's report", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Governing board approval of annual report, OFS and GEC", "source": "generated", "required": true }, { "key": "governance_evaluation_checklist", "title": "Governance Evaluation Checklist", "source": "generated", "required": false }, { "key": "online_financial_summary", "title": "Online Financial Summary", "source": "generated", "required": false }, { "key": "charity_portal_receipt", "title": "Charity Portal submission confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "registry_idv" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "financial_statements", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "assurance_report", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charity_portal_receipt", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Commissioner of Charities", "form": "Annual report with financial statements, Online Financial Summary and Governance Evaluatio", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_a_registered_charity", "type": null, "when": "requirement_error: the entity has no charity registration on file." }, { "code": "assurance_tier_not_met", "type": null, "when": "requirement_error: accounts_assurance is weaker than the tier for the entity, for example an IPC using independent examination." }, { "code": "signatories_insufficient", "type": null, "when": "requirement_error: fewer than 2 governing board members, or none holding a relevant office, signed the financial statements." }, { "code": "gec_or_ofs_missing", "type": null, "when": "requirement_error: the checklist or the Online Financial Summary is required for this charity and is not yet generated." } ] } }, "Params_sg_climate_assurance_engage": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_shares", "private_ltd_shares", "unlimited_company" ], "description": "Entity type of the reporting company.", "examples": [ "public_ltd_shares" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year to be assured.", "examples": [ "2029-12-31" ] }, "reporting_category": { "type": "string", "enum": [ "listed_sti_constituent", "listed_non_sti_market_cap_1bn_plus", "listed_other", "large_non_listed" ], "description": "Same categories as sg.climate_disclosure.file.", "examples": [ "listed_other" ] }, "mandatory": { "type": "boolean", "description": "True when the financial year is FY2029 or later for a listed company, or FY2032 or later for a large non-listed company.", "examples": [ "true" ] }, "provider_type": { "type": "string", "enum": [ "acra_registered_audit_firm", "sac_accredited_tic_firm" ], "description": "Eligible provider type.", "examples": [ "acra_registered_audit_firm" ] }, "provider_name": { "type": "string", "description": "Name of the assurance provider.", "examples": [ "Example Assurance LLP" ] }, "provider_registration_number": { "type": "string", "description": "ACRA or SAC registration or accreditation number.", "examples": [ "T00LL0000A" ] }, "assurance_standard": { "type": "string", "description": "Assurance standard in the engagement letter.", "examples": [ "As set in the engagement letter" ] } }, "required": [ "entity_type", "financial_year_end", "reporting_category", "mandatory", "provider_type", "provider_name", "provider_registration_number" ], "description": "Coordinates the engagement of an ACRA-registered audit firm or Singapore Accreditation Council accredited testing, inspection and certification firm to give limited assurance on Scope 1 and 2 emissions. Mandatory from FY2029 and FY2032." }, "Create_sg_climate_assurance_engage": { "type": "object", "properties": { "type": { "const": "sg.climate_assurance.engage" }, "params": { "$ref": "#/components/schemas/Params_sg_climate_assurance_engage" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Arrange limited assurance on Scope 1 and 2 GHG emissions", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "public_ltd_shares", "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Assurance engagement letter", "source": "uploaded", "required": true }, { "key": "ghg_inventory", "title": "GHG emissions inventory for Scope 1 and 2", "source": "uploaded", "required": true }, { "key": "assurance_report", "title": "Limited assurance report", "source": "uploaded", "required": true }, { "key": "provider_eligibility_check", "title": "Registration or accreditation check on the provider", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "engagement_letter", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "assurance_report", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. The assurance report is published with the sustainability report", "form": "Limited assurance report on Scope 1 and 2 emissions", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "assurance_provider_not_eligible", "type": null, "when": "requirement_error: the provider is neither an ACRA-registered audit firm nor a Singapore Accreditation Council accredited TIC firm." }, { "code": "inventory_scope_mismatch", "type": null, "when": "invalid_request_error: the inventory lacks Scope 1 or Scope 2 data." }, { "code": "report_not_linked_to_disclosure", "type": null, "when": "requirement_error: no sg.climate_disclosure.file action exists for the same financial year." } ] } }, "Params_sg_climate_disclosure_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_shares", "private_ltd_shares", "unlimited_company" ], "description": "Entity type of the reporting company.", "examples": [ "public_ltd_shares" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year being reported.", "examples": [ "2026-12-31" ] }, "reporting_category": { "type": "string", "enum": [ "listed_sti_constituent", "listed_non_sti_market_cap_1bn_plus", "listed_other", "large_non_listed" ], "description": "Category that sets the timeline.", "examples": [ "listed_sti_constituent" ] }, "scopes_in_report": { "type": "array", "items": {}, "description": "Emission scopes reported: scope_1, scope_2, scope_3.", "examples": [ "[\"scope_1\",\"scope_2\",\"scope_3\"]" ] }, "includes_issb_crd": { "type": "boolean", "description": "True when the report carries the other ISSB-based climate-related disclosures: governance, strategy, risk management, metrics and targets.", "examples": [ "true" ] }, "reporting_standard": { "type": "string", "enum": [ "issb_based_singapore_standard", "ifrs_s1_s2", "other_equivalent" ], "description": "Standard applied.", "examples": [ "issb_based_singapore_standard" ] }, "market_cap_30_jun_2025": { "$ref": "#/components/schemas/Money", "description": "Market capitalisation at close of market on 30 June 2025, for non-STI listed companies.", "examples": [ "{\"amount\":1400000000,\"currency\":\"SGD\"}" ] }, "revenue": { "$ref": "#/components/schemas/Money", "description": "Annual revenue, for the large non-listed test.", "examples": [ "{\"amount\":1250000000,\"currency\":\"SGD\"}" ] }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Total assets, for the large non-listed test.", "examples": [ "{\"amount\":640000000,\"currency\":\"SGD\"}" ] }, "parent_report_exemption": { "type": "object", "description": "Large non-listed companies only: parent_name, parent_jurisdiction, standard_used, parent_report_url, entity_covered.", "examples": [ "{\"parent_name\":\"Example Holdings plc\",\"parent_jurisdiction\":\"GB\",\"standard_used\":\"IFRS S2\",\"parent_report_url\":\"https://example.com/report\",\"entity_covered\":true}" ] }, "listed_publication_timing": { "type": "string", "enum": [ "with_annual_report", "within_5_months_after_external_assurance" ], "description": "Listed issuers only: with the annual report, or later but within 5 months of year end where external assurance is carried out.", "examples": [ "with_annual_report" ] }, "assurance_action_id": { "type": "string", "description": "Linked sg.climate_assurance.engage action, when Scope 1 and 2 assurance applies or is voluntary.", "examples": [ "act_6Gm3VkP7" ] } }, "required": [ "entity_type", "financial_year_end", "reporting_category", "scopes_in_report", "includes_issb_crd", "reporting_standard" ], "description": "Builds and tracks the ISSB-based climate-related disclosures and Scope 1, 2 and 3 GHG emissions that listed and large non-listed companies must report, and records publication." }, "Create_sg_climate_disclosure_file": { "type": "object", "properties": { "type": { "const": "sg.climate_disclosure.file" }, "params": { "$ref": "#/components/schemas/Params_sg_climate_disclosure_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare and publish climate-related disclosures and GHG emissions in the sustainability report", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "public_ltd_shares", "private_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sustainability_report", "title": "Sustainability report with climate-related disclosures", "source": "uploaded", "required": true }, { "key": "ghg_inventory", "title": "GHG emissions inventory", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board approval of the report and board statement", "source": "generated", "required": true }, { "key": "assurance_report", "title": "Limited assurance report on Scope 1 and 2", "source": "uploaded", "required": false }, { "key": "parent_sustainability_report", "title": "Parent's published sustainability report covering the company", "source": "uploaded", "required": false }, { "key": "reporting_scope_determination", "title": "Entiva's scope and timeline determination", "source": "generated", "required": true }, { "key": "publication_confirmation", "title": "SGXNet announcement or publication record", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "assurance_report", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "publication_confirmation", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "SGX RegCo", "form": "Sustainability report with ISSB-based climate-related disclosures and GHG emissions", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "reporting_category_not_in_scope_for_year", "type": null, "when": "requirement_error: the category has no disclosure duty for this financial year, for example non-STI listed companies for CRD before FY2028." }, { "code": "large_non_listed_thresholds_not_met", "type": null, "when": "requirement_error: revenue is under S$1bn or total assets are under S$500m, so the entity is not a large non-listed company." }, { "code": "exemption_conditions_not_met", "type": null, "when": "requirement_error: the parent report is not public, not ISSB-based or equivalent, or does not cover the company." }, { "code": "scope_3_missing_for_sti", "type": null, "when": "requirement_error: an STI constituent omits Scope 3 for FY2026 or later." }, { "code": "assurance_provider_not_eligible", "type": null, "when": "requirement_error: the provider is neither an ACRA-registered audit firm nor a Singapore Accreditation Council accredited TIC firm." } ] } }, "Params_sg_controller_notice_notify": { "type": "object", "properties": { "notice_cycle": { "type": "string", "enum": [ "annual_verification", "reasonable_steps", "both" ], "description": "Which notices to send. both is the default and covers the annual statutory duty.", "examples": [ "both" ] }, "cycle_year": { "type": "integer", "description": "Calendar year of the cycle.", "examples": [ "2026" ] }, "delivery_method": { "type": "string", "enum": [ "email", "post", "email_and_post" ], "description": "Notices may go electronically or in hard copy; registered mail is not required.", "examples": [ "email" ] }, "reply_window_days": { "type": "integer", "description": "Days allowed to reply.", "examples": [ "30" ] }, "skip_persons": { "type": "array", "items": {}, "description": "person_ref list who need no notice because they already confirmed accurate particulars or the company knows nothing changed.", "examples": [ "[]" ] }, "skip_reason": { "type": "string", "description": "Documented reason for each skip; ACRA expects the reason to be recorded.", "examples": [ "Controller confirmed all particulars on 2026-09-30." ] } }, "required": [ "notice_cycle", "cycle_year" ], "description": "Runs the yearly RORC verification: the Annex F notice to every registrable controller on the register asking them to confirm they are still controllers and that their particulars are correct, and the reasonable-steps notice to every." }, "Create_sg_controller_notice_notify": { "type": "object", "properties": { "type": { "const": "sg.controller_notice.notify" }, "params": { "$ref": "#/components/schemas/Params_sg_controller_notice_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Send the annual controller verification notices", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annex_f_notice", "title": "Annual update notice", "source": "generated", "required": true }, { "key": "annex_b_notice", "title": "Reasonable-steps notice", "source": "generated", "required": false }, { "key": "notice_delivery_log", "title": "Notice delivery log", "source": "generated", "required": true }, { "key": "controller_replies", "title": "Controller replies", "source": "uploaded", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "controller_replies", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annex_f_notice", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Prescribed notices: Annex B", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_registrable_controller_on_file", "type": null, "when": "requirement_error: the register has no controller and no fallback entry, so there is nobody to notify." }, { "code": "recipient_contact_missing", "type": null, "when": "requirement_error: a recipient has no valid email or postal address." }, { "code": "notice_bounced", "type": null, "when": "requirement_error: delivery failed; Entiva retries by the other channel and flags the partner." }, { "code": "entity_exempt", "type": null, "when": "jurisdiction_error: the entity is exempt from the RORC; no notices are due." } ] } }, "Params_sg_coop_annual_report_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year reported.", "examples": [ "2026-06-30" ] }, "co_op_type": { "type": "string", "enum": [ "credit", "non_credit" ], "description": "Sets which minimum-disclosure checklist applies to the annual report.", "examples": [ "non_credit" ] }, "agm_date": { "type": "string", "format": "date", "description": "Date of the AGM that adopted the accounts.", "examples": [ "2026-11-21" ] }, "auditor": { "type": "object", "description": "firm_name and partner_name of the audit firm and partner for the year.", "examples": [ "{\"firm_name\":\"Example Audit LLP\",\"partner_name\":\"Tan Mei Ling\"}" ] }, "annual_report_checklist": { "type": "array", "items": {}, "description": "Answers to the portal's annual report questions: {item, answer yes|no|n/a, remarks}.", "examples": [ "[{\"item\":\"Board composition disclosed\",\"answer\":\"yes\"}]" ] }, "afs_checklist": { "type": "array", "items": {}, "description": "Answers to the portal's AFS questions: {item, answer yes|no, remarks}.", "examples": [ "[{\"item\":\"Qualified opinion\",\"answer\":\"no\"}]" ] }, "declarant": { "type": "string", "pattern": "^per_", "description": "Authorised personnel who submits and gives the portal declarations.", "examples": [ "per_9Gs2Jk" ] }, "annual_report_document": { "type": "string", "pattern": "^doc_", "description": "PDF of the annual report.", "examples": [ "doc_3FqM8tVn" ] }, "afs_document": { "type": "string", "pattern": "^doc_", "description": "PDF of the signed audited financial statements.", "examples": [ "doc_7DxR2bLh" ] } }, "required": [ "financial_year_end", "co_op_type", "auditor", "annual_report_checklist", "afs_checklist", "declarant", "annual_report_document", "afs_document" ], "description": "Prepares and tracks the Annual Report form and the Audited Financial Statements form on the RCS Co-op Portal, both due within 6 months after the financial year end." }, "Create_sg_coop_annual_report_file": { "type": "object", "properties": { "type": { "const": "sg.coop_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_sg_coop_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a co-operative society's annual report and audited financial statements with the Registry", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Annual report on the co-op's activities", "source": "uploaded", "required": true }, { "key": "audited_financial_statements", "title": "Signed audited financial statements", "source": "uploaded", "required": true }, { "key": "portal_submission_copy", "title": "Printed copy of each submitted portal form", "source": "generated", "required": true } ], "people": [ { "role": "declarant", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "audited_financial_statements", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "portal_submission_copy", "signer_role": "declarant", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Annual Report form and Audited Financial Statements form", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "pdf_only", "type": null, "when": "invalid_request_error: an attachment is not a PDF." }, { "code": "attachment_too_large", "type": null, "when": "invalid_request_error: the files for one form exceed 20MB in total." }, { "code": "remarks_required", "type": null, "when": "invalid_request_error: a 'no' answer on the annual report checklist, or a 'yes' on the AFS checklist, has no remarks." }, { "code": "authorised_personnel_not_registered", "type": null, "when": "requirement_error: the declarant is not a Corppass user for the RCS Co-op Portal or has no co-op approval as authorised personnel." }, { "code": "afs_not_audited", "type": null, "when": "requirement_error: the statements carry no auditor's report." } ] } }, "Params_sg_coop_contribution_election_file": { "type": "object", "properties": { "second_tier_destination": { "type": "string", "enum": [ "ccf", "slf" ], "description": "The destination being chosen.", "examples": [ "slf" ] }, "previous_election": { "type": "string", "enum": [ "none", "ccf", "slf" ], "description": "Current position. none means the co-op is treated as having chosen the CCF.", "examples": [ "none" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "Chairman, Secretary or Treasurer who signs the letter.", "examples": [ "per_2Ld7Vx" ] }, "signatory_office": { "type": "string", "enum": [ "chairman", "secretary", "treasurer" ], "description": "Office held by the signatory.", "examples": [ "treasurer" ] }, "effective_financial_year_end": { "type": "string", "format": "date", "description": "Financial year the election is meant to cover.", "examples": [ "2028-06-30" ] } }, "required": [ "second_tier_destination", "previous_election", "signatory", "signatory_office" ], "description": "Prepares the written notice, signed by the Chairman, Secretary or Treasurer, telling the Registrar whether the co-op's second-tier contribution goes to the Central Co-operative Fund or the Singapore Labour Foundation." }, "Create_sg_coop_contribution_election_file": { "type": "object", "properties": { "type": { "const": "sg.coop_contribution_election.file" }, "params": { "$ref": "#/components/schemas/Params_sg_coop_contribution_election_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar of a co-operative's second-tier contribution destination", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "election_letter", "title": "Letter to the Registrar of Co-operative Societies", "source": "generated", "required": true }, { "key": "committee_resolution", "title": "Committee of management resolution approving the election", "source": "generated", "required": true }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "election_letter", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "committee_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Written notice to the Registrar", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "signatory_office_invalid", "type": null, "when": "requirement_error: the signatory is not the Chairman, Secretary or Treasurer." }, { "code": "election_already_current", "type": null, "when": "invalid_request_error: second_tier_destination equals the election already in force." }, { "code": "effective_year_too_early", "type": null, "when": "invalid_request_error: effective_financial_year_end falls before the earliest year Entiva computes." } ] } }, "Params_sg_coop_fund_contribution_pay": { "type": "object", "properties": { "surplus_financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year whose surplus is contributed on.", "examples": [ "2026-06-30" ] }, "surplus_amount": { "$ref": "#/components/schemas/Money", "description": "Surplus for that year before the excluded gains below.", "examples": [ "{\"amount\":1200000,\"currency\":\"SGD\"}" ] }, "excluded_gains": { "type": "object", "description": "own_use_property_gain and share_disposal_gain, each a money value.", "examples": [ "{\"own_use_property_gain\":{\"amount\":0,\"currency\":\"SGD\"},\"share_disposal_gain\":{\"amount\":0,\"currency\":\"SGD\"}}" ] }, "second_tier_destination": { "type": "string", "enum": [ "ccf", "slf" ], "description": "Where the second-tier amount goes.", "examples": [ "ccf" ] }, "audited_financial_statements": { "type": "string", "pattern": "^doc_", "description": "Audited statements that show the surplus.", "examples": [ "doc_7DxR2bLh" ] }, "election_action_id": { "type": "string", "description": "sg.coop_contribution_election.file action when the destination is slf.", "examples": [ "act_3Ne5BtY1" ] } }, "required": [ "surplus_financial_year_end", "surplus_amount", "second_tier_destination", "audited_financial_statements" ], "description": "Computes the Co-operative Societies Act s71 contribution from the preceding financial year's surplus: 5% of the first S$500,000 to the Central Co-operative Fund, plus 15% of the surplus above that to the CCF or the Singapore Labour." }, "Create_sg_coop_fund_contribution_pay": { "type": "object", "properties": { "type": { "const": "sg.coop_fund_contribution.pay" }, "params": { "$ref": "#/components/schemas/Params_sg_coop_fund_contribution_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Compute and track a co-operative's annual contribution to the CCF or SLF", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "audited_financial_statements", "title": "Audited financial statements", "source": "uploaded", "required": true }, { "key": "contribution_computation", "title": "Contribution computation", "source": "generated", "required": true }, { "key": "payment_proof", "title": "Proof of payment", "source": "uploaded", "required": true }, { "key": "general_meeting_minutes", "title": "Minutes recording the surplus distribution resolution", "source": "uploaded", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "declarant", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "contribution_computation", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Annual contribution under Co-operative Societies Act 1979 s71", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "surplus_not_supported", "type": null, "when": "invalid_request_error: the surplus does not match the audited financial statements." }, { "code": "rate_period_mismatch", "type": null, "when": "invalid_request_error: a second-tier rate was supplied that does not fit the year, which is 15% for years ending on or after 31 Dec 2025." }, { "code": "election_missing", "type": null, "when": "requirement_error: slf was chosen with no election action or evidence of written notice to the Registrar." }, { "code": "payment_proof_missing", "type": null, "when": "requirement_error: no proof of payment was uploaded." } ] } }, "Params_sg_coop_wd1_return_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year reported.", "examples": [ "2026-03-31" ] }, "wd1_workbook": { "type": "string", "pattern": "^doc_", "description": "Completed WD-1 Excel workbook.", "examples": [ "doc_5HtC1yMe" ] }, "declarant": { "type": "string", "pattern": "^per_", "description": "Authorised personnel who submits.", "examples": [ "per_9Gs2Jk" ] }, "proposed_dividend": { "$ref": "#/components/schemas/Money", "description": "Dividend proposed for the AGM.", "examples": [ "{\"amount\":50000,\"currency\":\"SGD\"}" ] }, "car_met_at_year_end": { "type": "boolean", "description": "Whether the required capital adequacy ratio was met at year end, per the workbook.", "examples": [ "true" ] } }, "required": [ "financial_year_end", "wd1_workbook", "declarant", "car_met_at_year_end" ], "description": "Credit co-ops submit the WD-1 Excel workbook on the RCS Co-op Portal within 6 months after year end. It reports the audited year-end position, capital adequacy ratio, minimum liquid assets, restricted investments and loans data." }, "Create_sg_coop_wd1_return_file": { "type": "object", "properties": { "type": { "const": "sg.coop_wd1_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_coop_wd1_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Form WD-1 for a credit co-operative", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "wd1_workbook", "title": "Completed Form WD-1 workbook", "source": "uploaded", "required": true }, { "key": "audited_financial_statements", "title": "Audited financial statements the workbook is based on", "source": "uploaded", "required": true }, { "key": "portal_submission_copy", "title": "Printed copy of the submitted WD-1 form", "source": "generated", "required": true } ], "people": [ { "role": "declarant", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "wd1_workbook", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "portal_submission_copy", "signer_role": "declarant", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Form WD-1", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_a_credit_co_op", "type": null, "when": "requirement_error: the co-op is not recorded as a credit co-op." }, { "code": "excel_only", "type": null, "when": "invalid_request_error: the attachment is not an Excel file or is over 20MB." }, { "code": "dividend_needs_registrar_approval", "type": null, "when": "requirement_error: the capital adequacy ratio was not met and a dividend is proposed." }, { "code": "authorised_personnel_not_registered", "type": null, "when": "requirement_error: the declarant is not registered for the RCS Co-op Portal." } ] } }, "Params_sg_coop_wd1a_return_file": { "type": "object", "properties": { "mid_year_end": { "type": "string", "format": "date", "description": "End of the mid financial year reported.", "examples": [ "2026-09-30" ] }, "wd1a_workbook": { "type": "string", "pattern": "^doc_", "description": "Completed WD-1A workbook.", "examples": [ "doc_1PzG6sNa" ] }, "mid_year_statements": { "type": "string", "pattern": "^doc_", "description": "Unaudited balance sheet and income and expenditure statement at mid year.", "examples": [ "doc_4YcB8rWf" ] }, "declarant": { "type": "string", "pattern": "^per_", "description": "Authorised personnel who submits.", "examples": [ "per_9Gs2Jk" ] } }, "required": [ "mid_year_end", "wd1a_workbook", "mid_year_statements", "declarant" ], "description": "Credit co-ops submit Form WD-1A with the mid-year unaudited balance sheet and income and expenditure statement within 2 months after the end of the mid financial year." }, "Create_sg_coop_wd1a_return_file": { "type": "object", "properties": { "type": { "const": "sg.coop_wd1a_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_coop_wd1a_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Form WD-1A and mid-year unaudited accounts for a credit co-operative", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "wd1a_workbook", "title": "Completed Form WD-1A workbook", "source": "uploaded", "required": true }, { "key": "mid_year_statements", "title": "Mid-year unaudited balance sheet and income and expenditure statement", "source": "uploaded", "required": true }, { "key": "submission_copy", "title": "Copy of what was submitted", "source": "generated", "required": true } ], "people": [ { "role": "declarant", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "mid_year_statements", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "submission_copy", "signer_role": "declarant", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Form WD-1A with mid-year unaudited balance sheet and income and expenditure statement", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_a_credit_co_op", "type": null, "when": "requirement_error: the co-op is not recorded as a credit co-op." }, { "code": "mid_year_date_invalid", "type": null, "when": "invalid_request_error: mid_year_end is not the midpoint of the financial year on file." }, { "code": "statements_missing", "type": null, "when": "requirement_error: the unaudited balance sheet or income and expenditure statement is not attached." } ] } }, "Params_sg_corporate_document_legalise_apostille": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "description": "Entity type key." }, "document_id": { "type": "string", "pattern": "^doc_", "description": "The final document to notarise." }, "document_kind": { "type": "string", "enum": [ "board_resolution", "shareholder_resolution", "certified_constitution_copy", "power_of_attorney", "director_declaration", "certificate_of_incumbency", "other_private_document" ], "description": "Kind of private document." }, "notarial_act": { "type": "string", "enum": [ "notarise_signature", "certify_true_copy", "notarise_declaration" ], "description": "What the notary does." }, "signatorys": { "type": "array", "items": {}, "description": "Array of person_ref for the people who appear before the notary." }, "signatories_in_singapore": { "type": "boolean", "description": "True if every signatory can attend a Singapore notary in person." }, "destination_country": { "type": "string", "description": "ISO 3166 alpha-2 code of the country of use." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Where Entiva sends the apostilled document." } }, "required": [ "entity_type", "document_id", "document_kind", "notarial_act", "signatories_in_singapore", "destination_country", "delivery_address" ], "description": "Has a Singapore notary public notarise a private corporate document, then has the Singapore Academy of Law authenticate the notarial certificate with an apostille. Signers attend the notary in Singapore." }, "Create_sg_corporate_document_legalise_apostille": { "type": "object", "properties": { "type": { "const": "sg.corporate_document.legalise_apostille" }, "params": { "$ref": "#/components/schemas/Params_sg_corporate_document_legalise_apostille" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notarise and apostille a private corporate document for use abroad", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "document_to_notarise", "title": "Document to notarise", "source": "uploaded", "required": true }, { "key": "notarial_certificate", "title": "Notarial certificate", "source": "uploaded", "required": true }, { "key": "sal_apostille_certificate", "title": "Apostille on the notarial certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "notary", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "document_to_notarise", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Singapore Academy of Law", "form": "Notarial certificate, then SAL authentication", "channel": "paper", "government_fee": { "amount": 87.2, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "signatories_outside_singapore", "type": null, "when": "[requirement_error] signatories_in_singapore is false." }, { "code": "remote_notarisation_unavailable", "type": null, "when": "[requirement_error] Remote notarisation is not offered." }, { "code": "document_not_final", "type": null, "when": "[requirement_error] The document is a draft or has no agreed text." }, { "code": "statutory_declaration_route", "type": null, "when": "[requirement_error] The document is a statutory declaration, which is sworn before a Commissioner for Oaths or notary." }, { "code": "signatory_not_verified", "type": null, "when": "[requirement_error] A signatory has not completed identity_address verification." } ] } }, "Params_sg_corporate_tax_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type key." }, "year_of_assessment": { "type": "integer", "description": "Year of Assessment the return is for." }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the return covers." }, "form": { "type": "string", "enum": [ "auto", "c_s_lite", "c_s", "c" ], "description": "Which return to file. 'auto' lets Entiva choose: C-S for revenue of S$200,000 or less, C-S for S$5m or less, otherwise Form C." }, "annual_revenue": { "$ref": "#/components/schemas/Money", "description": "Annual revenue, excluding separate-source income such as interest." }, "chargeable_income": { "$ref": "#/components/schemas/Money", "description": "Chargeable income for the year after tax adjustments, before exemptions that IRAS applies." }, "income_taxable_only_at_17_percent": { "type": "boolean", "description": "True if the company derives only income taxable at the prevailing 17% rate." }, "claims_excluded_reliefs": { "type": "boolean", "description": "True if the company claims carry-back of current-year capital allowances or losses, group relief, investment allowance, or foreign tax credit and tax deducted." }, "dormant_company": { "type": "boolean", "description": "True for a dormant company." }, "tax_computation_source": { "type": "string", "enum": [ "entiva_prepared", "customer_provided" ], "description": "Who prepares the tax computation." }, "financial_statements_document_id": { "type": "string", "pattern": "^doc_", "description": "The financial statements for the year." } }, "required": [ "entity_type", "year_of_assessment", "financial_year_end", "annual_revenue", "chargeable_income", "income_taxable_only_at_17_percent", "claims_excluded_reliefs", "tax_computation_source", "financial_statements_document_id" ], "description": "Files the annual corporate income tax return for a Year of Assessment on myTax Portal by 30 November. Entiva picks Form C-S, C-S or C from the company's facts." }, "Create_sg_corporate_tax_return_file": { "type": "object", "properties": { "type": { "const": "sg.corporate_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_corporate_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the corporate income tax return (Form C-S, C-S or C) with IRAS", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Financial statements for the year", "source": "uploaded", "required": true }, { "key": "tax_computation", "title": "Tax computation", "source": "generated", "required": true }, { "key": "corppass_tax_agent_authorisation", "title": "Corppass authorisation of Entiva tax agent", "source": "uploaded", "required": true }, { "key": "tax_return_instruction", "title": "Tax return filing instruction", "source": "generated", "required": true }, { "key": "iras_return_submission", "title": "Form C-S, C-S or C e-filing submission", "source": "generated", "required": true }, { "key": "tax_return_acknowledgement", "title": "IRAS e-filing acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "tax_return_instruction", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "iras_return_submission", "signer_role": "tax_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "Form C-S", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_not_eligible", "type": null, "when": "[requirement_error] The requested form does not fit the facts, for example c_s with revenue above S$5m or any C-S form for a foreign company branch." }, { "code": "financial_statements_missing", "type": null, "when": "[requirement_error] No approved financial statements are attached for the financial year." }, { "code": "filing_deadline_passed", "type": null, "when": "[registry_error] 30 November has passed." }, { "code": "estimated_assessment_issued", "type": null, "when": "[registry_error] IRAS issued an estimated Notice of Assessment: tax is due in 1 month even if objecting; objections within 2 months with the return, statements and tax computation." }, { "code": "eci_not_filed", "type": null, "when": "[requirement_error] Warning: no ECI was filed or waived for the YA." } ] } }, "Params_sg_employee_earnings_form_issue": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society", "representative_office" ], "description": "Entity type of the employer.", "examples": [ "sole_proprietorship" ] }, "income_year": { "type": "integer", "description": "Calendar year in which the income was derived.", "examples": [ "2026" ] }, "employee_count": { "type": "integer", "description": "Employees in the income year, counting leavers.", "examples": [ "3" ] }, "ais_status": { "type": "string", "enum": [ "not_registered", "unknown" ], "description": "Whether the employer is registered for AIS.", "examples": [ "not_registered" ] }, "records_document": { "type": "string", "pattern": "^doc_", "description": "Payroll records per employee, used to fill each IR8A and appendix.", "examples": [ "doc_6VbN3cRy" ] }, "delivery_method": { "type": "string", "enum": [ "hand_delivery", "registered_post", "courier" ], "description": "How the employer gives each employee the hardcopy forms.", "examples": [ "hand_delivery" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "income_year", "employee_count", "ais_status", "records_document", "delivery_method" ], "description": "For employers not required to use AIS: prepares each employee's IR8A, with Appendix 8A or 8B where they apply, and records delivery by 1 March. The forms are not submitted to IRAS." }, "Create_sg_employee_earnings_form_issue": { "type": "object", "properties": { "type": { "const": "sg.employee_earnings_form.issue" }, "params": { "$ref": "#/components/schemas/Params_sg_employee_earnings_form_issue" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give employees hardcopy IR8A and appendices", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society", "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "employee_income_records", "title": "Payroll records per employee", "source": "uploaded", "required": true }, { "key": "ir8a_forms_pack", "title": "IR8A and appendices per employee", "source": "generated", "required": true }, { "key": "proof_of_delivery", "title": "Delivery log or signed acknowledgements", "source": "uploaded", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ir8a_forms_pack", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. IRAS receives no submission: the employer gives forms to employees and keeps copies", "form": "Form IR8A, with Appendix 8A and Appendix 8B where they apply", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ais_mandatory_employer", "type": null, "when": "requirement_error: the employer has 5 or more employees, an IRAS notice or an AIS registration, so it must file under AIS instead." }, { "code": "records_incomplete", "type": null, "when": "invalid_request_error: a required IR8A field such as date of commencement or cessation is missing." }, { "code": "delivery_proof_missing", "type": null, "when": "requirement_error: no delivery record covers every employee by the deadline." } ] } }, "Params_sg_employment_income_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society", "representative_office" ], "description": "Entity type of the employer.", "examples": [ "private_ltd_shares" ] }, "income_year": { "type": "integer", "description": "Income year of the records being corrected.", "examples": [ "2026" ] }, "original_action_id": { "type": "string", "description": "The sg.employment_income.file action being corrected, when it was filed through Entiva.", "examples": [ "act_7Hq2VnL9" ] }, "correction_method": { "type": "string", "enum": [ "revision", "amendment" ], "description": "revision overwrites earlier records with full correct amounts. amendment sends differences only.", "examples": [ "revision" ] }, "correction_reason": { "type": "string", "enum": [ "wrong_employee_id", "wrong_income_or_deductions", "omitted_employee", "partner_or_sole_proprietor_included", "multiple_incorrect_records", "taxability_indicator_wrong" ], "description": "Why the records are wrong.", "examples": [ "wrong_income_or_deductions" ] }, "records_document": { "type": "string", "pattern": "^doc_", "description": "Records for affected employees only.", "examples": [ "doc_9LwQ2nTs" ] }, "also_amend_ir8a": { "type": "boolean", "description": "True when an Appendix 8A or 8B change also changes IR8A, so an IR8A amendment is sent too.", "examples": [ "false" ] } }, "required": [ "entity_type", "income_year", "correction_method", "correction_reason", "records_document" ], "description": "Corrects IR8A, Appendix 8A or 8B figures already sent under AIS. A revision resends the full correct amounts and is the recommended route." }, "Create_sg_employment_income_amend": { "type": "object", "properties": { "type": { "const": "sg.employment_income.amend" }, "params": { "$ref": "#/components/schemas/Params_sg_employment_income_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Revise or amend employment income records already submitted to IRAS", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society", "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "corrected_records", "title": "Corrected employee records", "source": "uploaded", "required": true }, { "key": "correction_evidence", "title": "Payroll evidence for the correction", "source": "uploaded", "required": false }, { "key": "employee_notice", "title": "Notice to affected employees to wait for any Amended or Additional Notice of Assessment", "source": "generated", "required": false }, { "key": "ais_submission_receipt", "title": "myTax Portal submission acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "corrected_records", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ais_submission_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Authority of Singapore", "form": "Revision or amendment records", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "original_submission_not_found", "type": null, "when": "requirement_error: no earlier AIS submission exists for this employer and income year." }, { "code": "particulars_only_change", "type": null, "when": "invalid_request_error: only personal particulars such as an address are wrong." }, { "code": "wrong_employee_id_needs_two_records", "type": null, "when": "invalid_request_error: wrong_employee_id needs a zeroed or negative record for the wrong ID plus the correct record." }, { "code": "corppass_approver_missing", "type": null, "when": "requirement_error: Entiva's filer does not hold the Approver role for this employer." } ] } }, "Params_sg_employment_income_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society", "representative_office" ], "description": "Entity type of the employer.", "examples": [ "private_ltd_shares" ] }, "income_year": { "type": "integer", "description": "Calendar year in which the income was derived.", "examples": [ "2026" ] }, "submission_mode": { "type": "string", "enum": [ "mytax_digital_service", "customer_payroll_api" ], "description": "mytax_digital_service: Entiva submits on myTax Portal as Corppass Approver. customer_payroll_api: the customer's payroll software submits through AIS-API.", "examples": [ "mytax_digital_service" ] }, "employee_count": { "type": "integer", "description": "Employees in the income year, counting leavers.", "examples": [ "12" ] }, "records_document": { "type": "string", "pattern": "^doc_", "description": "Required for mytax_digital_service.", "examples": [ "doc_4TzK8mQe" ] }, "directors_fees_approval_date": { "type": "string", "format": "date", "description": "Date the AGM or EGM approved directors' fees in that calendar year.", "examples": [ "2026-04-28" ] }, "predecessor_entity_handling": { "type": "string", "enum": [ "report_by_contract_period", "combine_under_current_entity" ], "description": "Only when the employer's constitution changed during the year: report by contract period under each entity, or combine under the current entity.", "examples": [ "combine_under_current_entity" ] } }, "required": [ "entity_type", "income_year", "submission_mode", "employee_count" ], "description": "Sends each employee's annual employment income to IRAS by 1 March so it pre-fills the employee's tax return. Entiva submits on myTax Portal as the employer's Corppass Approver, or tracks a submission made by the customer's payroll." }, "Create_sg_employment_income_file": { "type": "object", "properties": { "type": { "const": "sg.employment_income.file" }, "params": { "$ref": "#/components/schemas/Params_sg_employment_income_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File employment income records under the Auto-Inclusion Scheme", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society", "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "employee_income_records", "title": "Employee income records", "source": "uploaded", "required": true }, { "key": "directors_fees_approval", "title": "Resolution approving directors' fees", "source": "uploaded", "required": false }, { "key": "ais_submission_receipt", "title": "myTax Portal submission acknowledgement", "source": "registry_issued", "required": true }, { "key": "submitted_records_report", "title": "Report of submitted records by employee", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "employee_income_records", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ais_submission_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Inland Revenue Authority of Singapore", "form": "Employment income records", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ais_not_registered", "type": null, "when": "requirement_error: the employer has 5 or more employees or an IRAS notice but no AIS registration is found." }, { "code": "corppass_approver_missing", "type": null, "when": "requirement_error: Entiva's filer does not hold the Approver role for this employer, so the Corppass Admin must grant it." }, { "code": "invalid_employee_identifier", "type": null, "when": "invalid_request_error: an NRIC, FIN or other ID in the records fails format validation." }, { "code": "income_year_not_open", "type": null, "when": "invalid_request_error: income_year is not a completed calendar year open for submission." }, { "code": "records_incomplete", "type": null, "when": "invalid_request_error: a required IR8A field is blank, for example date of commencement for a new joiner." } ] } }, "Params_sg_estimated_chargeable_income_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type key." }, "year_of_assessment": { "type": "integer", "description": "Year of Assessment the ECI is for." }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the ECI covers." }, "annual_revenue": { "$ref": "#/components/schemas/Money", "description": "Revenue for the financial year, as {amount, currency}." }, "estimated_chargeable_income": { "$ref": "#/components/schemas/Money", "description": "ECI before the partial tax exemption and new start-up exemption." }, "claims_group_relief_or_loss_carry_back": { "type": "boolean", "description": "True if group relief or loss carry-back relief is claimed in the ECI." }, "request_instalments": { "type": "boolean", "description": "Ask for GIRO tax instalments." }, "force_filing": { "type": "boolean", "description": "File even though the waiver test passes." } }, "required": [ "entity_type", "year_of_assessment", "financial_year_end", "annual_revenue", "estimated_chargeable_income" ], "description": "Files the company's Estimated Chargeable Income for a Year of Assessment on IRAS myTax Portal within 3 months after the financial year end. If annual revenue is S$5m or less and ECI is nil, no filing is needed: use." }, "Create_sg_estimated_chargeable_income_file": { "type": "object", "properties": { "type": { "const": "sg.estimated_chargeable_income.file" }, "params": { "$ref": "#/components/schemas/Params_sg_estimated_chargeable_income_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Estimated Chargeable Income with IRAS", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "management_accounts", "title": "Management accounts or ECI workings", "source": "uploaded", "required": true }, { "key": "corppass_tax_agent_authorisation", "title": "Corppass authorisation of Entiva tax agent", "source": "uploaded", "required": true }, { "key": "eci_filing_instruction", "title": "ECI filing instruction", "source": "generated", "required": true }, { "key": "iras_eci_submission", "title": "ECI e-filing submission on myTax Portal", "source": "generated", "required": true }, { "key": "eci_acknowledgement", "title": "IRAS ECI e-filing acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "eci_filing_instruction", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "iras_eci_submission", "signer_role": "tax_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "Estimated Chargeable Income, File ECI digital service on myTax Portal", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "eci_waiver_applies", "type": null, "when": "[requirement_error] Revenue is S$5m or less and ECI is nil, so no ECI is due." }, { "code": "eci_already_filed", "type": null, "when": "[requirement_error] An ECI for this YA is already filed." }, { "code": "notice_of_assessment_issued", "type": null, "when": "[registry_error] IRAS already issued a Notice of Assessment for the YA." }, { "code": "corppass_authorisation_missing", "type": null, "when": "[requirement_error] Entiva is not yet an Approver for Corporate Tax in the company's Corppass." }, { "code": "late_filing_no_instalments", "type": null, "when": "[requirement_error] Warning only: the 3-month window has passed." } ] } }, "Params_sg_estimated_chargeable_income_waive": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type key." }, "year_of_assessment": { "type": "integer", "description": "Year of Assessment the determination is for." }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year." }, "annual_revenue": { "$ref": "#/components/schemas/Money", "description": "Revenue for the financial year." }, "eci_is_nil": { "type": "boolean", "description": "True if ECI is nil, measured before the partial tax exemption and the new start-up exemption." } }, "required": [ "entity_type", "year_of_assessment", "financial_year_end", "annual_revenue", "eci_is_nil" ], "description": "Records that the company does not have to file ECI for a Year of Assessment because annual revenue is S$5m or less and ECI is nil. The company self-assesses and IRAS is not told, so nothing is lodged." }, "Create_sg_estimated_chargeable_income_waive": { "type": "object", "properties": { "type": { "const": "sg.estimated_chargeable_income.waive" }, "params": { "$ref": "#/components/schemas/Params_sg_estimated_chargeable_income_waive" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the ECI filing waiver determination", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "revenue_evidence", "title": "Revenue and ECI workings", "source": "uploaded", "required": true }, { "key": "waiver_determination", "title": "ECI waiver determination record", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "waiver_determination", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "None. The waiver is self-assessed and IRAS is not notified", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "revenue_above_waiver_limit", "type": null, "when": "[requirement_error] annual_revenue is above S$5m." }, { "code": "eci_not_nil", "type": null, "when": "[requirement_error] eci_is_nil is false." }, { "code": "notice_of_assessment_received", "type": null, "when": "[registry_error] IRAS issued a Notice of Assessment although the waiver applies." } ] } }, "Params_sg_extension_of_time_apply": { "type": "object", "properties": { "extension_target": { "type": "string", "enum": [ "agm", "annual_return", "agm_and_annual_return", "annual_declaration", "foreign_financial_statements" ], "description": "What to extend. annual_declaration is for LLPs; foreign_financial_statements is for foreign company branches.", "examples": [ "annual_return" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Required except for LLPs.", "examples": [ "2026-06-30" ] }, "current_deadline": { "type": "string", "format": "date", "description": "The deadline being extended.", "examples": [ "2027-01-31" ] }, "reason": { "type": "string", "description": "Reason for the delay, in the customer's words.", "examples": [ "Audit of the Malaysian subsidiary is delayed by the auditor's change of engagement partner." ] }, "sgx_listed": { "type": "boolean", "description": "Companies: whether the company is SGX-listed.", "examples": [ "false" ] }, "is_further_extension": { "type": "boolean", "description": "True if an extension was already granted.", "examples": [ "false" ] }, "home_agm_required": { "type": "boolean", "description": "Foreign company: whether home law requires the statements to be tabled at an AGM.", "examples": [ "false" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "doc_ ids: director's letter, auditor correspondence on the delay, letter on any auditor change, SGX comments for listed entities.", "examples": [ "[\"doc_1RgC4rAuLt\"]" ] } }, "required": [ "extension_target", "current_deadline", "reason" ], "description": "Applies to ACRA for up to 60 more days to hold the AGM or file the annual return, file the LLP annual declaration, or file a foreign company's financial statements (Companies Act s373). Applications must go in before the original deadline." }, "Create_sg_extension_of_time_apply": { "type": "object", "properties": { "type": { "const": "sg.extension_of_time.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_extension_of_time_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for an extension of time", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_request_letter", "title": "Letter requesting the extension", "source": "generated", "required": true }, { "key": "auditor_correspondence", "title": "Auditor's correspondence on the delay", "source": "uploaded", "required": false }, { "key": "auditor_change_letter", "title": "Letter explaining any auditor change", "source": "uploaded", "required": false }, { "key": "sgx_comments", "title": "SGX comments", "source": "uploaded", "required": false }, { "key": "extension_acknowledgement", "title": "ACRA acknowledgement and receipt", "source": "registry_issued", "required": false }, { "key": "extension_approval_notice", "title": "ACRA approval notice", "source": "registry_issued", "required": false }, { "key": "eot_application", "title": "Eot application", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_request_letter", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "eot_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile Manage > Apply for extension of time: 'Extension of Time for AGM", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_already_passed", "type": null, "when": "requirement_error: current_deadline is in the past." }, { "code": "pending_application_exists", "type": null, "when": "requirement_error: an earlier extension for the same target is still pending." }, { "code": "financial_year_not_eligible", "type": null, "when": "requirement_error: a company's financial year end is before 31 Aug 2018." }, { "code": "target_not_applicable", "type": null, "when": "invalid_request_error: extension_target does not fit the entity type, for example annual_declaration for a company." }, { "code": "further_extension_unlikely", "type": null, "when": "requirement_error: is_further_extension is true and no strong supporting reason is given; the action proceeds only on the customer's confirmation." }, { "code": "extension_refused", "type": null, "when": "registry_error: ACRA declined the application; the S$200 is not refunded." } ] } }, "Params_sg_financial_statements_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end of the statements.", "examples": [ "2026-03-31" ] }, "company_category": { "type": "string", "enum": [ "standard", "small_non_publicly_accountable", "company_limited_by_guarantee", "mas_regulated_bank_finance_or_insurer", "solvent_exempt_private_company", "insolvent_exempt_private_company", "dormant_relevant_company" ], "description": "Filing category.", "examples": [ "small_non_publicly_accountable" ] }, "reporting_format": { "type": "string", "enum": [ "full_xbrl", "simplified_xbrl", "pdf_only", "xbrl_fsh_banks", "xbrl_fsh_insurance", "not_required" ], "description": "Format to file. not_required only for solvent exempt private companies and dormant relevant companies.", "examples": [ "simplified_xbrl" ] }, "revenue": { "$ref": "#/components/schemas/Money", "description": "Current-year revenue, consolidated for a group unless exempt from consolidation.", "examples": [ "{\"amount\":38000000,\"currency\":\"SGD\"}" ] }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Total assets at year end, same basis as revenue.", "examples": [ "{\"amount\":21000000,\"currency\":\"SGD\"}" ] }, "publicly_accountable": { "type": "boolean", "description": "True if listed, banking or payment system, insurance, capital markets infrastructure or intermediary, or another specified regulated entity.", "examples": [ "false" ] }, "audited": { "type": "boolean", "description": "Whether the statements are audited.", "examples": [ "false" ] }, "auditor": { "type": "object", "description": "{name, acra_registration_number}.", "examples": [ "{\"name\":\"Lim & Co PAC\",\"acra_registration_number\":\"T08PF0123A\"}" ] }, "accounting_standards": { "type": "string", "description": "Framework used, for example SFRS.", "examples": [ "SFRS(I) for Small Entities" ] }, "financial_statements_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the signed statements PDF.", "examples": [ "doc_1RfK1pDfXz" ] }, "annual_return_action_id": { "type": "string", "description": "act_ id of the sg.annual_return.file action to attach to.", "examples": [ "act_1RfK3nArPq" ] } }, "required": [ "financial_year_end", "company_category", "reporting_format", "audited" ], "description": "Determines the filing format, builds and validates the BizFinx XBRL package where needed, collects the signed PDF, directors' statement and auditor's report, and attaches them to the Bizfile annual return. There is no separate ACRA fee; it." }, "Create_sg_financial_statements_file": { "type": "object", "properties": { "type": { "const": "sg.financial_statements.file" }, "params": { "$ref": "#/components/schemas/Params_sg_financial_statements_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare and attach financial statements to the annual return", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "signed_financial_statements_pdf", "title": "Signed financial statements", "source": "uploaded", "required": false }, { "key": "xbrl_instance", "title": "XBRL instance document", "source": "generated", "required": false }, { "key": "bizfinx_validation_result", "title": "BizFinx validation result", "source": "generated", "required": false }, { "key": "directors_statement", "title": "Directors' statement", "source": "generated", "required": true }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "xbrl_exemption_approval", "title": "ACRA XBRL exemption approval", "source": "registry_issued", "required": false }, { "key": "bizfinx_upload", "title": "Bizfinx upload", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_statement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "signed_financial_statements_pdf", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfinx_upload", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "BizFinx XBRL prepare-and-validate tool, uploaded within the Bizfile 'File annual returns' ", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "xbrl_validation_failed", "type": null, "when": "requirement_error: BizFinx rejects the package." }, { "code": "reporting_format_not_allowed", "type": null, "when": "invalid_request_error: the chosen format does not fit the company_category." }, { "code": "threshold_data_missing", "type": null, "when": "requirement_error: revenue or total_assets is missing, so the smaller-company test cannot be run." }, { "code": "auditor_report_missing", "type": null, "when": "requirement_error: audited is true but no auditor's report is attached." }, { "code": "filename_invalid", "type": null, "when": "invalid_request_error: the PDF filename contains characters other than letters and numbers." }, { "code": "filing_not_required", "type": null, "when": "jurisdiction_error: the company is a solvent exempt private company or dormant relevant company and reporting_format is not not_required." } ] } }, "Params_sg_financial_statements_prepare": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year." }, "reporting_framework": { "type": "string", "enum": [ "auto", "sfrs_i", "sfrs_for_small_entities" ], "description": "Accounting framework. 'auto' lets Entiva choose." }, "audit_status": { "type": "string", "enum": [ "auto", "audit_required", "audit_exempt" ] }, "accounting_records_source": { "type": "string", "enum": [ "entiva_ledger", "accounting_software_connection", "uploaded_trial_balance" ], "description": "Where the books come from." }, "agm_dispensed": { "type": "boolean", "description": "True if the private company has dispensed with the AGM." }, "is_group_parent": { "type": "boolean", "description": "True if consolidated statements are needed because the company has subsidiaries." }, "signing_directors": { "type": "array", "items": {}, "description": "Array of person_ref for the two directors who sign the directors' statement (s201)." }, "exclude_directors_interests_with_member_consent": { "type": "boolean", "description": "Non-listed companies may omit directors' interests in shares and debentures if every member consents; the directors say so in the directors' statement and the." } }, "required": [ "entity_type", "financial_year_end", "accounting_records_source", "signing_directors" ], "description": "Entiva accountants prepare the year's financial statements and directors' statement from the company's books, route them for audit, and collect the directors' approval and signatures." }, "Create_sg_financial_statements_prepare": { "type": "object", "properties": { "type": { "const": "sg.financial_statements.prepare" }, "params": { "$ref": "#/components/schemas/Params_sg_financial_statements_prepare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare the annual financial statements and directors' statement", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trial_balance", "title": "Trial balance and general ledger", "source": "uploaded", "required": true }, { "key": "draft_financial_statements", "title": "Draft financial statements", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Approved financial statements", "source": "generated", "required": true }, { "key": "directors_statement", "title": "Directors' statement", "source": "generated", "required": true }, { "key": "board_resolution_approving_financial_statements", "title": "Board resolution approving the financial statements", "source": "generated", "required": true }, { "key": "management_representation_letter", "title": "Management representation letter", "source": "generated", "required": false }, { "key": "audit_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "xbrl_financial_statements", "title": "Financial statements in the filing format for the annual return", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_approving_financial_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "management_representation_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "audit_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "No filing under this action. Approved statements are laid at the AGM or sent to members, t", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "records_incomplete", "type": null, "when": "[requirement_error] The trial balance is missing, does not balance, or the bank is not reconciled." }, { "code": "audit_status_unconfirmed", "type": null, "when": "[requirement_error] audit_status is audit_exempt but there is no completed sg.audit_exemption.claim for the year." }, { "code": "audit_required_no_auditor", "type": null, "when": "[requirement_error] An audit is required and no auditor is engaged." }, { "code": "vcc_audit_required", "type": null, "when": "[requirement_error] audit_exempt was requested for a VCC." }, { "code": "directors_statement_signatories_missing", "type": null, "when": "[requirement_error] Fewer than two signing directors are given and the company does not have a single director." } ] } }, "Params_sg_financial_statements_relief_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the financial statements the relief is for." }, "scope": { "type": "string", "enum": [ "financial_statements", "directors_statement", "both" ], "description": "Which document the relief concerns." }, "relief_subject": { "type": "string", "enum": [ "directors_interests_in_shares_or_debentures", "other_form_or_content" ], "description": "What the relief is about. directors_interests_in_shares_or_debentures can be handled without an application by non-listed companies when all members consent." }, "requirement_to_relax": { "type": "string", "description": "The specific form or content requirement, for example the Twelfth Schedule item or disclosure." }, "grounds": { "type": "string", "description": "Why the relief is justified." }, "proposed_alternative_disclosure": { "type": "string", "description": "What will be disclosed instead." }, "is_listed": { "type": "boolean", "description": "True for a listed company." }, "all_members_consent": { "type": "boolean", "description": "True if every member has consented to leaving out directors' interests." } }, "required": [ "entity_type", "financial_year_end", "scope", "relief_subject", "requirement_to_relax", "grounds", "proposed_alternative_disclosure" ], "description": "Applies on Bizfile for relief from specific form and content requirements for the financial statements or the directors' statement. It does not cover audit exemption or the rule that two directors sign the directors' statement." }, "Create_sg_financial_statements_relief_apply": { "type": "object", "properties": { "type": { "const": "sg.financial_statements_relief.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_financial_statements_relief_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to ACRA for relief from financial statement or directors' statement form and content requirements", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "relief_application", "title": "Relief application with grounds", "source": "generated", "required": true }, { "key": "board_resolution_authorising_application", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "relief_submission", "title": "Bizfile application: Apply for exemption from financial statement requirements", "source": "generated", "required": true }, { "key": "acra_relief_decision", "title": "ACRA decision on the relief", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_authorising_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "relief_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'Apply for exemption from financial statement requirements', lodgement ty", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "automatic_relief_applies", "type": null, "when": "[requirement_error] Relief is only about directors' interests, the company is not listed and all members consent: no application is needed." }, { "code": "audit_exemption_not_covered", "type": null, "when": "[requirement_error] The request is really about audit exemption, which is assessed separately." }, { "code": "two_director_signature_not_waivable", "type": null, "when": "[requirement_error] The relief asked for would remove the requirement for at least two directors to sign the directors' statement, which this relief does not cover." }, { "code": "wrong_application_type", "type": null, "when": "[requirement_error] The request is about accounting standards." } ] } }, "Params_sg_foreign_company_annual_return_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Foreign company's financial year end.", "examples": [ "2026-03-31" ] }, "home_agm_required": { "type": "boolean", "description": "Whether home-country law requires the statements to be tabled at an AGM.", "examples": [ "true" ] }, "home_agm_date": { "type": "string", "format": "date", "description": "Date of the home AGM.", "examples": [ "2026-09-10" ] }, "head_office_fs_basis": { "type": "string", "enum": [ "listed_exchange_rules", "ifrs_or_sfrsi_similar", "home_jurisdiction_standards", "unaudited_summary" ], "description": "Basis of the head office statements (s373).", "examples": [ "home_jurisdiction_standards" ] }, "head_office_fs_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the head office statements.", "examples": [ "doc_1RgD1hHoFs" ] }, "head_office_fs_translation": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the English translation, if the original is not in English.", "examples": [ "doc_1RgD1iTrEn" ] }, "branch_status": { "type": "string", "enum": [ "active", "dormant" ], "description": "Active branches file audited statements; dormant branches file unaudited ones.", "examples": [ "active" ] }, "branch_fs_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the Singapore branch statements of profit and loss, assets and liabilities.", "examples": [ "doc_1RgD1jBrFs" ] }, "branch_auditor": { "type": "object", "description": "{name, acra_registration_number} of the ACRA-registered public accountant.", "examples": [ "{\"name\":\"Lim & Co PAC\",\"acra_registration_number\":\"T08PF0123A\"}" ] }, "statement_by_directors_document": { "type": "string", "pattern": "^doc_", "description": "Required when the head office files unaudited summary statements or prepares none.", "examples": [ "doc_1RgD1kSbDs" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The branch's authorised representative.", "examples": [ "per_1QdD5w" ] }, "register_locations": { "type": "object", "description": "For rorc, rond and rons: csp_registered_office, registered_office or exempt:.", "examples": [ "{\"rorc\":\"csp_registered_office\",\"rond\":\"csp_registered_office\"}" ] }, "extension_of_time_action_id": { "type": "string", "description": "act_ id of a granted s373 extension.", "examples": [ "act_1RgC5eEoAp" ] } }, "required": [ "financial_year_end", "home_agm_required", "head_office_fs_basis", "head_office_fs_document", "branch_status", "branch_fs_document", "authorised_representative" ], "description": "Files the registered foreign company's annual filing on Bizfile under Companies Act s373: the head office financial statements, the Singapore branch statements, the statement by directors where the head office files unaudited summary." }, "Create_sg_foreign_company_annual_return_file": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the foreign company annual filing", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "head_office_financial_statements", "title": "Head office financial statements", "source": "uploaded", "required": true }, { "key": "english_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "branch_financial_statements", "title": "Singapore branch financial statements", "source": "uploaded", "required": true }, { "key": "branch_auditor_report", "title": "Branch auditor's report", "source": "uploaded", "required": false }, { "key": "statement_by_directors", "title": "Statement by directors", "source": "generated", "required": false }, { "key": "annual_filing_acknowledgement", "title": "Bizfile acknowledgement", "source": "registry_issued", "required": false }, { "key": "bizfile_annual_filing", "title": "Bizfile annual filing", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_by_directors", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "branch_auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_annual_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File annual returns' eService for a foreign company", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "branch_audit_missing", "type": null, "when": "requirement_error: the branch is active and no audited branch statements or auditor are provided." }, { "code": "authorised_representative_missing", "type": null, "when": "requirement_error: no ordinarily resident authorised representative is on record for the branch." }, { "code": "translation_missing", "type": null, "when": "requirement_error: statements are not in English and no translation is attached." }, { "code": "home_agm_date_missing", "type": null, "when": "invalid_request_error: home_agm_required is true without home_agm_date." }, { "code": "statement_by_directors_unsigned", "type": null, "when": "requirement_error: the statement by directors is required and not fully signed." }, { "code": "relief_needed", "type": null, "when": "requirement_error: the branch statements cannot be prepared." } ] } }, "Params_sg_foreign_company_branch_waiver_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the foreign company's financial year the waiver is for." }, "head_office_country": { "type": "string", "description": "ISO 3166 alpha-2 code of the country where the foreign company is incorporated." }, "grounds": { "type": "string", "description": "Why the branch should not need to file its own statements." }, "branch_statements_can_be_prepared": { "type": "boolean", "description": "True if the branch's balance sheet and income statement can be prepared." }, "signing_directors": { "type": "array", "items": {}, "description": "Array of person_ref for the foreign company directors who sign the declaration." } }, "required": [ "entity_type", "financial_year_end", "head_office_country", "grounds", "branch_statements_can_be_prepared", "signing_directors" ], "description": "Applies on Bizfile for a waiver so that a foreign company's Singapore branch need not lodge its own financial statements with the annual filing. The branch's balance sheet and income statement must still be provided unless they cannot be." }, "Create_sg_foreign_company_branch_waiver_apply": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_branch_waiver.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_branch_waiver_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to ACRA for a waiver of the Singapore branch's annual financial statements (Companies Act s373)", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "waiver_application", "title": "Waiver application with grounds", "source": "generated", "required": true }, { "key": "directors_declaration", "title": "Directors' declaration for the exemption application", "source": "generated", "required": true }, { "key": "board_authorisation", "title": "Foreign company authorisation of the application", "source": "uploaded", "required": true }, { "key": "waiver_submission", "title": "Bizfile application: Singapore branch waiver", "source": "generated", "required": true }, { "key": "acra_waiver_decision", "title": "ACRA decision on the waiver", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "waiver_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'Apply for exemption from financial statement requirements', type 'Singap", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "branch_dormant_no_waiver_needed", "type": null, "when": "[requirement_error] Warning: a dormant branch files unaudited statements and may not need a waiver." }, { "code": "waiver_scope_head_office", "type": null, "when": "[requirement_error] The request concerns head office statements." }, { "code": "directors_declaration_missing", "type": null, "when": "[requirement_error] No signed directors' declaration is attached." }, { "code": "filing_due_date_passed", "type": null, "when": "[requirement_error] The annual filing due date has passed." } ] } }, "Params_sg_foreign_company_filing_extension_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the financial year the extension is for." }, "reason": { "type": "string", "description": "Reason for the extension, entered on Bizfile." }, "must_table_fs_at_agm_in_country_of_incorporation": { "type": "boolean", "description": "Must be false: the extension is open only to branches not required to table financial statements or hold an AGM in their country of incorporation." } }, "required": [ "entity_type", "financial_year_end", "reason", "must_table_fs_at_agm_in_country_of_incorporation" ], "description": "Applies on Bizfile for a 60-day extension of time to file the financial statements of a foreign company's Singapore branch. Open only to a branch that is not required to table financial statements at an AGM in its country of incorporation." }, "Create_sg_foreign_company_filing_extension_apply": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_filing_extension.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_filing_extension_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to ACRA for a 60-day extension to file a foreign company's financial statements (Companies Act s373)", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_application", "title": "Extension of time application", "source": "generated", "required": true }, { "key": "extension_submission", "title": "Bizfile application: Extension of Time for Filing of Financial Statement for Foreign Company", "source": "generated", "required": true }, { "key": "acra_extension_approval", "title": "ACRA approval notification", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_application", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "extension_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile: Manage > Apply for extension of time > 'Extension of Time for Filing of Financial", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_tabling_required", "type": null, "when": "[requirement_error] must_table_fs_at_agm_in_country_of_incorporation is true." }, { "code": "extension_already_granted", "type": null, "when": "[registry_error] An extension for the same financial year was already granted." }, { "code": "reason_missing", "type": null, "when": "[invalid_request_error] reason is empty." } ] } }, "Params_sg_foreign_company_filing_relief_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the foreign company's financial year." }, "provision": { "type": "string", "enum": [ "s373_13_alternative_document", "s373_13a_relief" ], "description": "s373_13_alternative_document: permission to file another document in place of the head-office financial statements. s373_13a_relief: relief from audit or." }, "scope": { "type": "string", "enum": [ "head_office", "singapore_branch" ], "description": "Whose statements the application concerns." }, "relief_covers": { "type": "string", "enum": [ "audit_requirement", "form_and_content" ], "description": "Required for s373_13a_relief." }, "alternative_document_description": { "type": "string", "description": "Required for s373_13_alternative_document." }, "head_office_country": { "type": "string", "description": "ISO 3166 alpha-2 code of the country of incorporation." }, "grounds": { "type": "string", "description": "Why the permission or relief is justified." }, "signing_directors": { "type": "array", "items": {}, "description": "Array of person_ref for the foreign company directors who sign the declaration." } }, "required": [ "entity_type", "financial_year_end", "provision", "scope", "head_office_country", "grounds", "signing_directors" ], "description": "Applies on Bizfile for permission to file another document in place of the foreign company's head-office financial statements, or for relief from the audit or the form-and-content requirements for the head office or the Singapore branch." }, "Create_sg_foreign_company_filing_relief_apply": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_filing_relief.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_filing_relief_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to ACRA for permission to file another head-office document (s373) or audit or form-and-content relief (s373)", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "relief_application", "title": "Application with grounds", "source": "generated", "required": true }, { "key": "directors_declaration", "title": "Directors' declaration for the exemption application", "source": "generated", "required": true }, { "key": "board_authorisation", "title": "Foreign company authorisation of the application", "source": "uploaded", "required": true }, { "key": "relief_submission", "title": "Bizfile application: foreign company relief", "source": "generated", "required": true }, { "key": "acra_relief_decision", "title": "ACRA decision", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "relief_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'Apply for exemption from financial statement requirements', type 'foreig", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "provision_parameters_missing", "type": null, "when": "[invalid_request_error] relief_covers is missing for s373_13a_relief, or alternative_document_description is missing for s373_13_alternative_document." }, { "code": "listed_company_follow_listing_rules", "type": null, "when": "[requirement_error] Warning: listed foreign companies follow their exchange's listing rules for head-office statements." }, { "code": "wrong_application_type", "type": null, "when": "[requirement_error] The request is for a branch waiver or an extension of time." }, { "code": "directors_declaration_missing", "type": null, "when": "[requirement_error] No signed directors' declaration is attached." } ] } }, "Params_sg_foreign_company_fs_relief_apply": { "type": "object", "properties": { "relief_type": { "type": "string", "enum": [ "branch_accounts_waiver_s373_12", "branch_accounts_relief_s373_13a", "head_office_statements_relief_s373_13" ], "description": "Which statutory power is invoked.", "examples": [ "branch_accounts_waiver_s373_12" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Financial year the application covers.", "examples": [ "2026-03-31" ] }, "ground": { "type": "string", "enum": [ "impractical_given_nature_of_operations", "no_real_value_given_amount", "disproportionately_expensive", "misleading_or_harmful", "misleading_or_inappropriate", "unreasonable_burden" ], "description": "Statutory ground: compliance is impractical, of no real value, disproportionately expensive, misleading or harmful, or would make the documents misleading or.", "examples": [ "disproportionately_expensive" ] }, "explanation": { "type": "string", "description": "Facts supporting the ground.", "examples": [ "The branch is a representative sales desk with S$18,000 of annual expenses; a separate audit would cost more than its turnover." ] }, "alternative_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the document proposed in place of the required statements.", "examples": [ "doc_1RgE2mAlDc" ] }, "directors_declaration": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the signed directors' declaration attached to the application.", "examples": [ "doc_1RgE2nDcLr" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The branch's authorised representative.", "examples": [ "per_1QdD5w" ] } }, "required": [ "relief_type", "financial_year_end", "ground", "explanation", "directors_declaration", "authorised_representative" ], "description": "Applies to ACRA to waive the Singapore branch statements (s373), to relieve the branch statements from audit or form and content requirements (s373), or to allow the head office to file another document or be relieved of audit or form." }, "Create_sg_foreign_company_fs_relief_apply": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_fs_relief.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_fs_relief_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a foreign company financial statements waiver or relief", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_declaration", "title": "Directors' declaration", "source": "generated", "required": true }, { "key": "supporting_explanation", "title": "Supporting explanation and figures", "source": "uploaded", "required": true }, { "key": "alternative_document", "title": "Proposed alternative document", "source": "uploaded", "required": false }, { "key": "acra_decision", "title": "ACRA decision", "source": "registry_issued", "required": false }, { "key": "bizfile_exemption_application", "title": "Bizfile exemption application", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_exemption_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply for exemption from financial statement requirements' eService, with the dir", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ground_not_supported", "type": null, "when": "requirement_error: the explanation does not meet a statutory ground; Entiva warns before submission." }, { "code": "declaration_missing", "type": null, "when": "requirement_error: the directors' declaration is unsigned or not attached." }, { "code": "relief_type_ground_mismatch", "type": null, "when": "invalid_request_error: the ground does not fit relief_type (for example a waiver ground for s373 relief)." }, { "code": "relief_refused", "type": null, "when": "registry_error: ACRA declined; the S$200 is not refunded and the annual filing deadline still applies." } ] } }, "Params_sg_gst_filing_extension_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "description": "Entity type key." }, "accounting_period_end": { "type": "string", "format": "date", "description": "Last day of the accounting period whose return needs more time." }, "reason": { "type": "string", "enum": [ "first_return_after_registration", "it_system_breakdown", "new_accounting_software_or_it_system", "key_personnel_long_medical_leave", "company_restructuring", "seamless_filing_software_api_issue" ], "description": "The reason, from the list IRAS accepts: first_return_after_registration; it_system_breakdown, new_accounting_software_or_it_system." }, "reason_details": { "type": "string", "description": "Facts that show the reason applies." } }, "required": [ "entity_type", "accounting_period_end", "reason", "reason_details" ], "description": "Asks IRAS for a short extension of the GST F5 filing due date. IRAS generally does not grant extensions and accepts only a few reasons, for a maximum of 2 weeks." }, "Create_sg_gst_filing_extension_request": { "type": "object", "properties": { "type": { "const": "sg.gst_filing_extension.request" }, "params": { "$ref": "#/components/schemas/Params_sg_gst_filing_extension_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request an extension of time to file a GST return", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "supporting_evidence", "title": "Supporting documents for the reason", "source": "uploaded", "required": false }, { "key": "extension_request_form", "title": "GST filing extension request form", "source": "generated", "required": true }, { "key": "extension_request_submission", "title": "Submission of the IRAS extension request", "source": "generated", "required": true }, { "key": "iras_extension_outcome", "title": "IRAS outcome email", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "extension_request_form", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "extension_request_submission", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "IRAS GST filing extension request form", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "reason_not_accepted", "type": null, "when": "[requirement_error] The reason is one IRAS refuses or does not fit the list." }, { "code": "request_too_late", "type": null, "when": "[requirement_error] Fewer than 5 working days remain before the due date." }, { "code": "supporting_documents_missing", "type": null, "when": "[requirement_error] The reason needs documents and none are attached." }, { "code": "extensions_generally_not_granted", "type": null, "when": "[requirement_error] Warning: IRAS says extensions are generally not granted and one month is a reasonable deadline." } ] } }, "Params_sg_gst_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "description": "Entity type key." }, "accounting_period_start": { "type": "string", "format": "date", "description": "First day of the GST accounting period." }, "accounting_period_end": { "type": "string", "format": "date", "description": "Last day of the GST accounting period." }, "is_nil_return": { "type": "boolean", "description": "True if there was no business activity in the period." }, "standard_rated_supplies": { "$ref": "#/components/schemas/Money", "description": "Box 1: total value of standard-rated supplies, excluding GST." }, "zero_rated_supplies": { "$ref": "#/components/schemas/Money", "description": "Box 2: total value of zero-rated supplies, net of credit and debit notes." }, "exempt_supplies": { "$ref": "#/components/schemas/Money", "description": "Box 3: total value of exempt supplies." }, "taxable_purchases": { "$ref": "#/components/schemas/Money", "description": "Box 5: total value of standard-rated and zero-rated purchases, excluding GST." }, "output_tax_due": { "$ref": "#/components/schemas/Money", "description": "Box 6: GST charged on standard-rated supplies." }, "input_tax_and_refunds_claimed": { "$ref": "#/components/schemas/Money", "description": "Box 7: GST incurred on claimable purchases, plus other refunds such as bad debt relief." }, "revenue": { "$ref": "#/components/schemas/Money", "description": "Box 13: revenue from main income sources per the accounts." }, "other_boxes": { "type": "object", "description": "Optional boxes as {box_9..box_21: money}; omit a box for No." }, "giro_enrolled": { "type": "boolean", "description": "True if the entity pays by GIRO." } }, "required": [ "entity_type", "accounting_period_start", "accounting_period_end", "standard_rated_supplies", "zero_rated_supplies", "exempt_supplies", "taxable_purchases", "output_tax_due", "input_tax_and_refunds_claimed", "revenue" ], "description": "Files the GST F5 return for one accounting period on IRAS myTax Portal and sets up payment. The return and payment are due 1 month after the end of the accounting period." }, "Create_sg_gst_return_file": { "type": "object", "properties": { "type": { "const": "sg.gst_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_gst_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the GST return and pay GST", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gst_workings", "title": "GST workings", "source": "uploaded", "required": true }, { "key": "corppass_gst_authorisation", "title": "Corppass authorisation of Entiva for GST", "source": "uploaded", "required": true }, { "key": "gst_return_instruction", "title": "GST return filing instruction", "source": "generated", "required": true }, { "key": "gst_f5_submission", "title": "GST F5 e-filing submission on myTax Portal", "source": "generated", "required": true }, { "key": "gst_f5_acknowledgement", "title": "IRAS acknowledgement page", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "gst_return_instruction", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gst_f5_submission", "signer_role": "tax_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "GST F5 on myTax Portal", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_gst_registered", "type": null, "when": "[requirement_error] The entity is not GST-registered, so there is no GST return to file." }, { "code": "return_already_filed", "type": null, "when": "[requirement_error] A return for this accounting period is already on file." }, { "code": "accounting_period_invalid", "type": null, "when": "[invalid_request_error] The period overlaps or leaves a gap with the entity's other accounting periods, or the dates are reversed." }, { "code": "corppass_authorisation_missing", "type": null, "when": "[requirement_error] Entiva is not yet authorised for GST in the entity's Corppass." }, { "code": "box_consistency_warning", "type": null, "when": "[requirement_error] Warning: the box values look inconsistent, for example output tax is far from the standard-rated supplies, or a nil return carries values." } ] } }, "Params_sg_gst_return_rectify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "description": "Entity type key." }, "affected_periods": { "type": "array", "items": {}, "description": "One object per affected accounting period: {accounting_period_start, accounting_period_end, revised_boxes}. revised_boxes lists only the boxes that change, as." }, "description_of_errors": { "type": "string", "description": "Description of the errors." }, "net_gst_amount_in_error": { "$ref": "#/components/schemas/Money", "description": "Net GST in error across all affected periods, as a positive amount." }, "net_gst_error_direction": { "type": "string", "enum": [ "underpaid_gst", "overpaid_gst" ], "description": "underpaid_gst: GST was understated. overpaid_gst: GST was overstated and a refund is claimed." }, "largest_other_box_error_percent_of_total_supplies": { "type": "number", "description": "Largest error in any other box, as a percentage of total supplies for each affected period." }, "error_discovered_on": { "type": "string", "format": "date", "description": "When the error was found." }, "voluntary_disclosure": { "type": "boolean", "description": "True to use the Voluntary Disclosure Programme: Entiva requests the F7 on myTax and e-files it within 14 days." }, "force_f7": { "type": "boolean", "description": "File an F7 even though the administrative concession would let the error be fixed in the next F5." } }, "required": [ "entity_type", "affected_periods", "description_of_errors", "net_gst_amount_in_error", "net_gst_error_direction" ], "description": "Files GST F7 on myTax Portal to correct errors in a submitted GST F5, F7 or F8, or to claim GST overpaid. Small errors can instead be adjusted in the next F5." }, "Create_sg_gst_return_rectify": { "type": "object", "properties": { "type": { "const": "sg.gst_return.rectify" }, "params": { "$ref": "#/components/schemas/Params_sg_gst_return_rectify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Correct errors in a filed GST return", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "error_analysis", "title": "Error analysis and corrected workings", "source": "uploaded", "required": true }, { "key": "corppass_gst_authorisation", "title": "Corppass authorisation of Entiva for GST", "source": "uploaded", "required": true }, { "key": "gst_f7_instruction", "title": "GST F7 filing instruction", "source": "generated", "required": true }, { "key": "gst_f7_submission", "title": "GST F7 e-filing submission on myTax Portal", "source": "generated", "required": true }, { "key": "gst_f7_acknowledgement", "title": "IRAS acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "gst_f7_instruction", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gst_f7_submission", "signer_role": "tax_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "GST F7 on myTax Portal: File GST Return/Edit Past Return > Request for GST F7 > Submit Req", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "administrative_concession_applies", "type": null, "when": "[requirement_error] The net GST error is S$3,000 or less and other box errors are within 5% of total supplies." }, { "code": "revenue_box_only_error", "type": null, "when": "[requirement_error] The only error is in Box 13." }, { "code": "outside_five_year_window", "type": null, "when": "[registry_error] More than 5 years have passed since the end of the affected period." }, { "code": "f7_request_expired", "type": null, "when": "[registry_error] The F7 request on myTax was not e-filed within 14 days and was deleted." }, { "code": "original_return_not_found", "type": null, "when": "[requirement_error] No filed return exists for one of the affected periods." } ] } }, "Params_sg_ipc_donation_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_guarantee", "registered_society" ], "description": "Entity type of the IPC.", "examples": [ "public_ltd_guarantee" ] }, "calendar_year": { "type": "integer", "description": "Calendar year in which the donations were received.", "examples": [ "2026" ] }, "route": { "type": "string", "enum": [ "iras_donation_api", "coc_unreported_donations_return" ], "description": "iras_donation_api: records go to IRAS through a Donation Management System or in-house API. coc_unreported_donations_return: return to the Commissioner of.", "examples": [ "iras_donation_api" ] }, "donation_records_document": { "type": "string", "pattern": "^doc_", "description": "Donation listing used to reconcile against what the DMS reported, or to prepare the Commissioner return.", "examples": [ "doc_2KyP7nWc" ] }, "unreported_donation_categories": { "type": "array", "items": {}, "description": "Needed for coc_unreported_donations_return: categories of donations not reported to IRAS.", "examples": [ "[\"payroll_deduction\"]" ] }, "dms_vendor": { "type": "string", "description": "Donation Management System the IPC uses, for the iras_donation_api route.", "examples": [ "Example DMS Pte. Ltd." ] } }, "required": [ "entity_type", "calendar_year", "route" ], "description": "Tracks and prepares the annual report of tax-deductible donations an IPC received in the previous calendar year. IRAS takes donation records through its Donation API, and the Commissioner of Charities takes a return only for donations not." }, "Create_sg_ipc_donation_return_file": { "type": "object", "properties": { "type": { "const": "sg.ipc_donation_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_ipc_donation_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report an IPC's tax-deductible donations", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "public_ltd_guarantee", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "donation_records", "title": "Donation records for the calendar year", "source": "uploaded", "required": true }, { "key": "dms_submission_evidence", "title": "DMS or IRAS submission confirmation", "source": "uploaded", "required": false }, { "key": "unreported_donations_return", "title": "Return of tax-deductible donations not reported to IRAS", "source": "generated", "required": false }, { "key": "charity_portal_receipt", "title": "Charity Portal submission confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "donation_records", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "charity_portal_receipt", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "Tax-deductible donation records", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_an_ipc", "type": null, "when": "requirement_error: the entity has no IPC status on file." }, { "code": "dms_evidence_missing", "type": null, "when": "requirement_error: the iras_donation_api route has no evidence that records reached IRAS." }, { "code": "unreported_donations_not_described", "type": null, "when": "invalid_request_error: coc_unreported_donations_return without categories." }, { "code": "approver_role_missing", "type": null, "when": "requirement_error: nobody holds the Approver role for 'Submission of Donation Records'." } ] } }, "Params_sg_llp_annual_declaration_file": { "type": "object", "properties": { "first_declaration": { "type": "boolean", "description": "True for the LLP's first declaration.", "examples": [ "false" ] }, "previous_declaration_date": { "type": "string", "format": "date", "description": "Date of the last declaration.", "examples": [ "2025-12-10" ] }, "solvency_position": { "type": "string", "enum": [ "able_to_pay_debts", "unable_to_pay_debts" ], "description": "The managers' declaration: able or unable to pay the LLP's debts.", "examples": [ "able_to_pay_debts" ] }, "insolvency_option": { "type": "string", "description": "Required when unable_to_pay_debts: the follow-up option Bizfile shows.", "examples": [ "under_winding_up_process" ] }, "entity_information_confirmed": { "type": "boolean", "description": "Customer confirms the entity profile, SSIC code, registered office, partners and managers are current.", "examples": [ "true" ] }, "approving_managers": { "type": "array", "items": {}, "description": "person_ref list of managers who approve the solvency position.", "examples": [ "[\"per_1QdF4r\",\"per_1QdF5s\"]" ] }, "acknowledge_late_penalty": { "type": "boolean", "description": "Required once the deadline has passed.", "examples": [ "false" ] }, "extension_of_time_action_id": { "type": "string", "description": "act_ id of a granted LLP extension.", "examples": [ "act_1RgC5eEoAp" ] } }, "required": [ "first_declaration", "solvency_position", "entity_information_confirmed", "approving_managers" ], "description": "Files the LLP's annual declaration on Bizfile, stating whether the LLP can or cannot pay its debts. The managers approve their solvency opinion first, then Entiva's CSP checks the entity record and submits." }, "Create_sg_llp_annual_declaration_file": { "type": "object", "properties": { "type": { "const": "sg.llp_annual_declaration.file" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_annual_declaration_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the LLP annual declaration", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "managers_solvency_approval", "title": "Managers' approval of the solvency position", "source": "generated", "required": true }, { "key": "annual_declaration_acknowledgement", "title": "Bizfile acknowledgement", "source": "registry_issued", "required": false }, { "key": "business_profile", "title": "Free Business Profile", "source": "registry_issued", "required": false }, { "key": "bizfile_annual_declaration", "title": "Bizfile annual declaration", "source": "generated", "required": true } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "managers_solvency_approval", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_annual_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "ACRA", "form": "Bizfile Annual filing > Limited liability partnership > File annual declarations", "channel": "online", "government_fee": { "amount": 30, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "filing_window_not_open", "type": null, "when": "requirement_error: more than 3 months remain before the deadline; Bizfile does not accept the declaration yet." }, { "code": "entity_information_outdated", "type": null, "when": "requirement_error: partners, managers, registered office or SSIC code on ACRA's record are out of date." }, { "code": "manager_approval_missing", "type": null, "when": "requirement_error: a manager has not approved the solvency position." }, { "code": "insolvency_option_missing", "type": null, "when": "invalid_request_error: solvency_position is unable_to_pay_debts without insolvency_option." }, { "code": "late_penalty_unacknowledged", "type": null, "when": "requirement_error: the deadline has passed and the penalty is not acknowledged." } ] } }, "Params_sg_llp_annual_declaration_extension_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llp" ], "description": "Entity type key." }, "annual_declaration_due_date": { "type": "string", "format": "date", "description": "The current due date of the annual declaration: within 15 months of registration for the first one, then yearly and within 15 months of the last." }, "reason": { "type": "string", "description": "Reason for the extension." }, "is_further_extension": { "type": "boolean", "description": "True if an earlier extension was already granted." } }, "required": [ "entity_type", "annual_declaration_due_date", "reason" ], "description": "Applies on Bizfile for a 60-day extension to file the LLP's annual declaration. The application must be submitted before the due date, and ACRA advises at least 14 working days ahead." }, "Create_sg_llp_annual_declaration_extension_apply": { "type": "object", "properties": { "type": { "const": "sg.llp_annual_declaration_extension.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_annual_declaration_extension_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to ACRA for a 60-day extension to file an LLP annual declaration (s30)", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_application", "title": "Extension of time application", "source": "generated", "required": true }, { "key": "extension_submission", "title": "Bizfile application: Extension of Time under S30", "source": "generated", "required": true }, { "key": "acra_extension_notification", "title": "ACRA submission and approval notifications", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_application", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "extension_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile: Manage > Apply for extension of time > 'Extension of Time under S30", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "due_date_passed", "type": null, "when": "[registry_error] The due date has passed." }, { "code": "application_pending", "type": null, "when": "[registry_error] An earlier extension application is still pending review." }, { "code": "late_application_risk", "type": null, "when": "[requirement_error] Warning: fewer than 14 working days remain, so ACRA may not decide before the due date." }, { "code": "further_extension_unlikely", "type": null, "when": "[requirement_error] Warning: a further extension costs S$200 and ACRA is unlikely to grant it without strong supporting reasons." } ] } }, "Params_sg_nominee_register_change": { "type": "object", "properties": { "register": { "type": "string", "enum": [ "rond", "rons" ], "description": "rond for nominee directors, rons for nominee shareholders.", "examples": [ "rond" ] }, "change_type": { "type": "string", "enum": [ "nominee_added", "nominee_ceased", "nominator_particulars_changed", "nominator_particulars_corrected", "no_nominees_statement" ], "description": "What changed.", "examples": [ "nominee_added" ] }, "nominee": { "type": "string", "pattern": "^per_", "description": "The nominee director or nominee shareholder.", "examples": [ "per_1QdJ8v" ] }, "nominator": { "type": "string", "pattern": "^per_", "description": "The person or entity the nominee acts for.", "examples": [ "per_1QdJ9w" ] }, "nominee_basis": { "type": "string", "enum": [ "meets_resident_director_rule", "acts_on_nominator_directions", "votes_on_nominator_instructions", "receives_dividends_for_nominator" ], "description": "Why the person is a nominee: appointed to meet the resident-director rule, acts on the nominator's directions, votes shares on the nominator's instructions, or.", "examples": [ "meets_resident_director_rule" ] }, "became_nominee_date": { "type": "string", "format": "date", "description": "Date the person became a nominee.", "examples": [ "2026-10-14" ] }, "ceased_nominee_date": { "type": "string", "format": "date", "description": "Date the person stopped being a nominee.", "examples": [ "2026-10-14" ] }, "nominee_notice_date": { "type": "string", "format": "date", "description": "Date the nominee informed the company.", "examples": [ "2026-10-15" ] }, "nominator_particulars": { "type": "object", "description": "Individual: full_name, aliases, residential_address, email, contact_number, nationality, id_or_passport_number, date_of_birth.", "examples": [ "{\"full_name\":\"Anna Wirth\",\"nationality\":\"Swiss\",\"email\":\"anna@example.ch\",\"contact_number\":\"+41791234567\"}" ] }, "arranged_by_partner_csp": { "type": "boolean", "description": "True if Entiva's Entiva arranged the nominee director; a fit and proper assessment is then required.", "examples": [ "true" ] } }, "required": [ "register", "change_type" ], "description": "Records a change in the private register of nominee directors or nominee shareholders and lodges it with ACRA's central register: a nominee added or ceased, a nominator's particulars changed or corrected, or a statement that no nominee." }, "Create_sg_nominee_register_change": { "type": "object", "properties": { "type": { "const": "sg.nominee_register.change" }, "params": { "$ref": "#/components/schemas/Params_sg_nominee_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update the nominee director or nominee shareholder register", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nominee_notice", "title": "Nominee's notice to the company", "source": "uploaded", "required": false }, { "key": "nominator_identity", "title": "Nominator identity support", "source": "uploaded", "required": false }, { "key": "nomination_agreement", "title": "Nomination arrangement", "source": "uploaded", "required": false }, { "key": "fit_and_proper_assessment", "title": "Fit and proper assessment", "source": "generated", "required": false }, { "key": "nominee_register_extract", "title": "Updated register extract", "source": "generated", "required": true }, { "key": "central_nominee_register_receipt", "title": "Central register update receipt", "source": "registry_issued", "required": false }, { "key": "central_nominee_register_update", "title": "Central nominee register update", "source": "generated", "required": true } ], "people": [ { "role": "nominee_director", "verification_level": "identity_address" }, { "role": "nominee", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nominee_notice", "signer_role": "nominee_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "central_nominee_register_update", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update Registers of Nominee Directors and Nominee Shareholders' eService", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_not_applicable", "type": null, "when": "jurisdiction_error: rons for a company limited by guarantee." }, { "code": "nominator_particulars_incomplete", "type": null, "when": "requirement_error: required nominator particulars such as email, contact number or ID number are missing." }, { "code": "fit_and_proper_pending", "type": null, "when": "requirement_error: an arranged nominee director has no approved fit and proper assessment; Entiva will not arrange the nominee without one." }, { "code": "entity_exempt", "type": null, "when": "jurisdiction_error: the entity is exempt from the nominee registers; use sg.register_exemption.declare." }, { "code": "nominee_disclosure_late", "type": null, "when": "requirement_error: the nominee informed the company outside the 30-day window or the 7-day and 2-business-day lodging clocks have run; Entiva proceeds and flags the breach to." } ] } }, "Params_sg_partnership_partner_cessation_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llp", "lp", "general_partnership" ], "description": "Entity type key." }, "partner": { "type": "string", "pattern": "^per_", "description": "The partner who is leaving." }, "precedent_partner": { "type": "string", "pattern": "^per_", "description": "The precedent partner who gives the notice." }, "event": { "type": "string", "enum": [ "ceasing_to_be_partner", "leaving_singapore_over_3_months" ], "description": "ceasing_to_be_partner: the partner ceases or is about to cease. leaving_singapore_over_3_months: the partner is leaving or intends to leave Singapore for more." }, "expected_event_date": { "type": "string", "format": "date", "description": "Expected date of cessation, or of leaving Singapore." }, "partner_new_address": { "$ref": "#/components/schemas/Address", "description": "The partner's new address, which the notice must state." }, "likely_chargeable_to_tax": { "type": "boolean", "description": "True if the partner is likely to be chargeable to tax in Singapore." }, "partner_is_singapore_citizen_or_pr": { "type": "boolean", "description": "True if the partner is a Singapore citizen or PR." }, "leaving_singapore_permanently": { "type": "boolean", "description": "For a PR: true if leaving Singapore permanently." }, "moneys_due_to_partner": { "$ref": "#/components/schemas/Money", "description": "Amount due or payable to the partner by the partnership." } }, "required": [ "entity_type", "partner", "precedent_partner", "event", "expected_event_date", "partner_new_address", "likely_chargeable_to_tax", "partner_is_singapore_citizen_or_pr" ], "description": "The precedent partner gives IRAS one month's written notice when a partner ceases, or is about to cease, being a partner, or is leaving Singapore for more than 3 months, and is likely to be chargeable to tax in Singapore. The partnership." }, "Create_sg_partnership_partner_cessation_notify": { "type": "object", "properties": { "type": { "const": "sg.partnership_partner_cessation.notify" }, "params": { "$ref": "#/components/schemas/Params_sg_partnership_partner_cessation_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give IRAS one month's written notice that a partner is leaving", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "llp", "lp", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "iras_written_notice", "title": "Written notice to IRAS", "source": "generated", "required": true }, { "key": "comptroller_permission", "title": "Comptroller's permission to release moneys to the partner", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "iras_written_notice", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "Written notice to IRAS. IRAS's page prescribes no form and does not name a channel", "channel": "both", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_not_required_concession", "type": null, "when": "[requirement_error] The partner is a Singapore citizen, or a PR not leaving Singapore permanently." }, { "code": "notice_period_too_short", "type": null, "when": "[requirement_error] Warning: fewer than 30 days remain before the event date." }, { "code": "partner_not_likely_chargeable", "type": null, "when": "[requirement_error] likely_chargeable_to_tax is false, so no notice is needed." }, { "code": "wrong_tax_clearance_form", "type": null, "when": "[requirement_error] Form IR21 is for employees, not partners." }, { "code": "precedent_partner_not_identified", "type": null, "when": "[requirement_error] precedent_partner_id is not the precedent partner of the entity." } ] } }, "Params_sg_partnership_tax_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llp", "lp", "general_partnership" ], "description": "Entity type key." }, "year_of_assessment": { "type": "integer", "description": "Year of Assessment." }, "basis_period_start": { "type": "string", "format": "date", "description": "First day of the partnership's accounting year." }, "basis_period_end": { "type": "string", "format": "date", "description": "Last day of the partnership's accounting year." }, "precedent_partner": { "type": "string", "pattern": "^per_", "description": "The precedent partner: the first partner named in the partnership agreement, or the partner the other partners appoint." }, "revenue": { "$ref": "#/components/schemas/Money", "description": "Revenue per the statement of accounts." }, "divisible_profit": { "$ref": "#/components/schemas/Money", "description": "Divisible profit or loss after deducting partners' salaries, allowances, bonuses, CPF contributions, interest on capital and expenses paid for partners." }, "partners": { "type": "array", "items": {}, "description": "One object per partner: {person_id, status, share_percentage}." }, "foreign_sourced_income": { "$ref": "#/components/schemas/Money", "description": "Foreign-sourced income received through the partnership, unless specifically tax-exempt." }, "statement_of_accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "The profit and loss account and balance sheet." }, "partnership_allocation_template_document_id": { "type": "string", "pattern": "^doc_", "description": "The Partnership Allocation Template, completed offline." }, "file_by_28_feb": { "type": "boolean", "description": "True to file by 28 February so that the allocation pre-fills partners' Form B/B1." } }, "required": [ "entity_type", "year_of_assessment", "basis_period_start", "basis_period_end", "precedent_partner", "revenue", "divisible_profit", "partners", "statement_of_accounts_document_id" ], "description": "Files Form P for a partnership on myTax Portal. The precedent Entiva files between 1 February and 18 April, declares each partner's acting or sleeping status and share, and the partners then declare their shares in their own returns." }, "Create_sg_partnership_tax_return_file": { "type": "object", "properties": { "type": { "const": "sg.partnership_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_partnership_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Partnership Income Tax Return with IRAS", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "llp", "lp", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_of_accounts", "title": "Statement of accounts", "source": "uploaded", "required": true }, { "key": "certified_statement_of_accounts", "title": "Certified statement of accounts", "source": "generated", "required": false }, { "key": "partnership_allocation_template", "title": "Partnership Allocation Template", "source": "uploaded", "required": false }, { "key": "tax_agent_authorisation_evidence", "title": "Evidence that the partnership authorised Entiva tax agent on myTax Portal", "source": "uploaded", "required": false }, { "key": "form_p_instruction", "title": "Form P filing instruction", "source": "generated", "required": true }, { "key": "form_p_submission", "title": "Form P e-filing submission", "source": "generated", "required": true }, { "key": "form_p_acknowledgement", "title": "IRAS Form P acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_p_instruction", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_statement_of_accounts", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_p_submission", "signer_role": "tax_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "Form P", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "e_filing_not_open", "type": null, "when": "[requirement_error] Warning: e-filing opens on 1 February." }, { "code": "partner_shares_invalid", "type": null, "when": "[invalid_request_error] share_percentage values do not total 100, or a partner has no acting or sleeping status." }, { "code": "certified_statement_required", "type": null, "when": "[requirement_error] Revenue is S$500,000 or more and no certified statement of accounts is signed by the precedent partner." }, { "code": "allocation_template_required", "type": null, "when": "[requirement_error] The partnership has more than 10 partners and no Partnership Allocation Template is attached." }, { "code": "precedent_partner_not_identified", "type": null, "when": "[requirement_error] precedent_partner_id is not a partner of the entity." } ] } }, "Params_sg_register_exemption_declare": { "type": "object", "properties": { "registers": { "type": "array", "items": {}, "description": "Registers covered: rorc, rond, rons.", "examples": [ "[\"rorc\",\"rond\",\"rons\"]" ] }, "exemption_category": { "type": "string", "enum": [ "listed_on_singapore_exchange", "singapore_financial_institution", "wholly_owned_by_singapore_government", "wholly_owned_by_statutory_body", "wholly_owned_subsidiary_of_exempt_company", "listed_overseas_with_equivalent_transparency", "foreign_wholly_owned_subsidiary_of_singapore_financial_institution", "foreign_primary_listing_on_singapore_exchange", "llp_partners_all_exempt_companies" ], "description": "The ACRA category relied on.", "examples": [ "listed_on_singapore_exchange" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the entity became exempt.", "examples": [ "2026-08-03" ] }, "supporting_evidence": { "type": "array", "items": {}, "description": "doc_ ids: listing evidence, MAS directory entry, ownership chart or similar.", "examples": [ "[\"doc_1RgL1zLsEv\"]" ] }, "confirming_director": { "type": "string", "pattern": "^per_", "description": "Director who confirms the facts behind the exemption.", "examples": [ "per_1QdA7x" ] } }, "required": [ "registers", "exemption_category", "effective_date", "supporting_evidence", "confirming_director" ], "description": "Records that an entity is exempt from keeping the register of registrable controllers, the register of nominee directors or the register of nominee shareholders, tells ACRA through the relevant Bizfile eService, and sets the category to be." }, "Create_sg_register_exemption_declare": { "type": "object", "properties": { "type": { "const": "sg.register_exemption.declare" }, "params": { "$ref": "#/components/schemas/Params_sg_register_exemption_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare an exemption from the controller and nominee registers", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_determination_record", "title": "Exemption determination record", "source": "generated", "required": true }, { "key": "exemption_evidence", "title": "Evidence of exempt status", "source": "uploaded", "required": true }, { "key": "acra_exemption_receipt", "title": "Bizfile submission receipt", "source": "registry_issued", "required": false }, { "key": "bizfile_register_exemption", "title": "Bizfile register exemption", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "exemption_determination_record", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_register_exemption", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update Register of Registrable Controllers' eService, and 'Update Registers of No", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "exemption_not_available", "type": null, "when": "jurisdiction_error: the entity is being wound up, in receivership, under judicial management or being struck off and fits no category, or the category does not suit the entity." }, { "code": "category_entity_mismatch", "type": null, "when": "invalid_request_error: for example a company category chosen for an LLP." }, { "code": "evidence_missing", "type": null, "when": "requirement_error: no evidence of the exempt status is attached." }, { "code": "register_not_applicable", "type": null, "when": "invalid_request_error: rons for a company limited by guarantee, or a nominee register for an LLP." } ] } }, "Params_sg_registrable_controller_change": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "controller_added", "controller_ceased", "particulars_changed", "particulars_corrected", "unconfirmed_controller_entry", "no_controller_identified" ], "description": "What changed.", "examples": [ "controller_added" ] }, "controller": { "type": "string", "pattern": "^per_", "description": "The individual or legal entity controller.", "examples": [ "per_1QdH7u" ] }, "basis": { "type": "array", "items": {}, "description": "Why the person is registrable.", "examples": [ "[\"interest_over_25_percent_shares\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the person became or ceased to be a controller, or the change occurred.", "examples": [ "2026-10-12" ] }, "confirmation_date": { "type": "string", "format": "date", "description": "Date the controller confirmed.", "examples": [ "2026-10-15" ] }, "notice_sent_date": { "type": "string", "format": "date", "description": "For unconfirmed_controller_entry: date the notice went out.", "examples": [ "2026-09-01" ] }, "particulars": { "type": "object", "description": "Particulars to enter.", "examples": [ "{\"full_name\":\"Wei Jie Chen\",\"nationality\":\"Singaporean\",\"email\":\"weijie@example.sg\",\"contact_number\":\"+6591234567\"}" ] }, "controller_statement_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the controller's signed, dated statement that the information is true and accurate.", "examples": [ "doc_1RgJ1wCsRc" ] }, "executive_control_persons": { "type": "array", "items": {}, "description": "For no_controller_identified: person_ref list of directors with executive control and CEOs.", "examples": [ "[\"per_1QdA7x\"]" ] }, "entry_note": { "type": "string", "description": "Note to enter with an unconfirmed or fallback entry.", "examples": [ "Particulars not confirmed by the registrable controller." ] }, "trigger_action_id": { "type": "string", "description": "act_ id of the action that caused the change, such as a share transfer.", "examples": [ "act_1RgJ0tShTr" ] } }, "required": [ "change_type", "effective_date" ], "description": "Records a change in the private register of registrable controllers and lodges it with ACRA's Central RORC: a controller added or ceased, particulars changed or corrected, a controller's reply still outstanding after the notice window, or." }, "Create_sg_registrable_controller_change": { "type": "object", "properties": { "type": { "const": "sg.registrable_controller.change" }, "params": { "$ref": "#/components/schemas/Params_sg_registrable_controller_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update the register of registrable controllers", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "controller_confirmation", "title": "Controller's signed confirmation", "source": "uploaded", "required": false }, { "key": "controller_identity", "title": "Controller identity support", "source": "uploaded", "required": false }, { "key": "notice_log", "title": "Notice and reply log", "source": "generated", "required": false }, { "key": "rorc_register_extract", "title": "Updated register extract", "source": "generated", "required": true }, { "key": "central_rorc_receipt", "title": "Central RORC update receipt", "source": "registry_issued", "required": false }, { "key": "rorc_entry", "title": "Rorc entry", "source": "generated", "required": true }, { "key": "central_rorc_update", "title": "Central rorc update", "source": "generated", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "controller_confirmation", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "rorc_entry", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "central_rorc_update", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update Register of Registrable Controllers' eService", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "controller_confirmation_missing", "type": null, "when": "requirement_error: a confirmed entry needs the controller's signed and dated statement." }, { "code": "entity_exempt", "type": null, "when": "jurisdiction_error: the entity is exempt from keeping a RORC; use sg.register_exemption.declare to record the category." }, { "code": "basis_missing", "type": null, "when": "invalid_request_error: controller_added without a basis for being registrable." }, { "code": "particulars_incomplete", "type": null, "when": "requirement_error: required particulars such as email, contact number or ID number are missing." }, { "code": "register_entry_late", "type": null, "when": "requirement_error: the 7-day private register deadline or the 2-business-day central deadline has passed; Entiva proceeds but flags the breach for the partner." }, { "code": "controller_unresolved", "type": null, "when": "requirement_error: a corporate controller has no natural person identified through the chain, so the look-through is incomplete." } ] } }, "Params_sg_representative_office_declaration_file": { "type": "object", "properties": { "trigger": { "type": "string", "enum": [ "annual", "new_chief_representative" ], "description": "annual: the yearly declaration. new_chief_representative: a new Chief Representative has joined.", "examples": [ "new_chief_representative" ] }, "licence_number": { "type": "string", "description": "RO licence number.", "examples": [ "RO-2027-001283" ] }, "declared_by": { "type": "string", "enum": [ "chief_representative", "parent_company" ], "description": "Who makes the declaration.", "examples": [ "chief_representative" ] }, "chief_representative": { "type": "string", "pattern": "^per_", "description": "The current Chief Representative.", "examples": [ "per_6Jx4Rb" ] }, "declaration_link_received_on": { "type": "string", "format": "date", "description": "Date Enterprise Singapore sent the declaration link.", "examples": [ "2027-05-10" ] }, "terms_compliance_confirmed": { "type": "boolean", "description": "The declarant confirms the RO has complied with the Enterprise Singapore Terms and Conditions.", "examples": [ "true" ] } }, "required": [ "trigger", "licence_number", "declared_by", "chief_representative", "declaration_link_received_on", "terms_compliance_confirmed" ], "description": "For ROs under the post-1 April 2027 regime: tracks the Enterprise Singapore link, prepares the declaration of compliance with the Terms and Conditions, and records it once a year and whenever a new Chief Representative joins. Activity." }, "Create_sg_representative_office_declaration_file": { "type": "object", "properties": { "type": { "const": "sg.representative_office_declaration.file" }, "params": { "$ref": "#/components/schemas/Params_sg_representative_office_declaration_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Make a Representative Office's annual declaration of compliance", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "compliance_declaration", "title": "Declaration of compliance with Enterprise Singapore Terms and Conditions", "source": "generated", "required": true }, { "key": "terms_review_memo", "title": "Entiva's review of the RO's activities against the Terms and Conditions", "source": "generated", "required": true }, { "key": "declaration_confirmation", "title": "Enterprise Singapore confirmation of the declaration", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "compliance_declaration", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Enterprise Singapore", "form": "Declaration of compliance with Terms and Conditions", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "regime_not_applicable", "type": null, "when": "requirement_error: the licence is not under the post-1 Apr 2027 regime, or the date is before 1 Apr 2027." }, { "code": "declaration_link_missing", "type": null, "when": "requirement_error: no Enterprise Singapore link has been received." }, { "code": "chief_representative_not_verified", "type": null, "when": "requirement_error: the Chief Representative has not passed identity verification." }, { "code": "terms_review_incomplete", "type": null, "when": "requirement_error: the review against the Terms and Conditions is not complete, so compliance cannot be confirmed." } ] } }, "Params_sg_representative_office_licence_extend": { "type": "object", "properties": { "licence_number": { "type": "string", "description": "Current RO licence or registration number.", "examples": [ "RO-2025-004417" ] }, "registration_start_date": { "type": "string", "format": "date", "description": "Date the RO was first registered.", "examples": [ "2025-12-16" ] }, "licence_expiry_date": { "type": "string", "format": "date", "description": "Current expiry.", "examples": [ "2026-12-15" ] }, "extension_years": { "type": "integer", "description": "Years requested.", "examples": [ "2" ] }, "chief_representative": { "type": "string", "pattern": "^per_", "description": "Chief Representative stationed in Singapore.", "examples": [ "per_6Jx4Rb" ] }, "parent_entity": { "type": "string", "pattern": "^ent_", "description": "The foreign parent, held as a legal entity record with its registration number.", "examples": [ "ent_8WdT5mYe" ] }, "ro_purpose": { "type": "string", "description": "Stated purpose of the RO, repeated in the parent's letter.", "examples": [ "Market research and liaison for the parent's Southeast Asia sales" ] }, "reminder_received_on": { "type": "string", "format": "date", "description": "Date of the Enterprise Singapore reminder email.", "examples": [ "2026-10-15" ] } }, "required": [ "licence_number", "registration_start_date", "licence_expiry_date", "extension_years", "chief_representative", "parent_entity", "ro_purpose" ], "description": "Files a new Enterprise Singapore application on GoBusiness to extend an RO by up to 2 years after its first year, to a maximum of 3 years in total. Enterprise Singapore's Renew function does not apply to ROs." }, "Create_sg_representative_office_licence_extend": { "type": "object", "properties": { "type": { "const": "sg.representative_office_licence.extend" }, "params": { "$ref": "#/components/schemas/Params_sg_representative_office_licence_extend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Extend a Representative Office licence by a new application", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "parent_certificate_of_incorporation", "title": "Parent's certificate of incorporation", "source": "uploaded", "required": true }, { "key": "parent_financial_statements", "title": "Parent's latest audited accounts", "source": "uploaded", "required": true }, { "key": "ro_purpose_letter", "title": "Signed letter on the parent's letterhead stating the RO's purpose", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Parent's board resolution approving the extension and the third-party filer", "source": "generated", "required": true }, { "key": "chief_representative_identity", "title": "Chief Representative's passport and work pass or NRIC", "source": "uploaded", "required": true }, { "key": "gobusiness_acknowledgement", "title": "GoBusiness application acknowledgement", "source": "registry_issued", "required": true }, { "key": "extended_licence", "title": "Extended RO licence", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ro_purpose_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gobusiness_acknowledgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Enterprise Singapore", "form": "New application for the Representative Office licence", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "maximum_term_reached", "type": null, "when": "requirement_error: the RO has been registered 3 years, so no further extension is available." }, { "code": "first_year_not_elapsed", "type": null, "when": "requirement_error: the RO has not completed its first year." }, { "code": "reminder_window_missed", "type": null, "when": "registry_error: the 7-day response window after Enterprise Singapore's reminder has passed and the RO may be deregistered." }, { "code": "application_after_regime_change", "type": null, "when": "invalid_request_error: the application date is on or after 1 Apr 2027, when different rules apply that this action type does not cover." }, { "code": "corppass_admin_not_eligible", "type": null, "when": "requirement_error: the foreign entity's Corppass admin has no NRIC or FIN and no third-party filer authorisation is on file." } ] } }, "Params_sg_revised_financial_statements_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "description": "Entity type key." }, "original_transaction_number": { "type": "string", "description": "ACRA transaction number of the filing in which the error occurred, as shown in Bizfile." }, "original_financial_year_end": { "type": "string", "format": "date", "description": "Year end of the financial statements being revised." }, "revision_date": { "type": "string", "format": "date", "description": "The date the directors approved the revised financial statements." }, "nature_of_noncompliance": { "type": "string", "description": "The aspects in which the original statements did not comply with the Companies Act." }, "material_revisions": { "type": "string", "description": "The material revisions made." }, "confirms_later_events_not_dealt_with": { "type": "boolean", "description": "True to confirm the revised statements say that events after the date of the original statements have not been dealt with." }, "original_was_audited": { "type": "boolean", "description": "True if the originals were audited." }, "signing_directors": { "type": "array", "items": {}, "description": "Array of person_ref for the directors who sign the new directors' statement." }, "recipients_notified_on": { "type": "string", "format": "date", "description": "Date the revised statements, new directors' statement and amended auditor's report were sent to all original recipients and everyone entitled to notice of a." }, "is_dormant_relevant_company": { "type": "boolean", "description": "True if the company is a dormant relevant company." }, "error_is_in_xbrl_or_annual_return_form": { "type": "boolean", "description": "True if the error is only in the XBRL financial statements or the annual return form." } }, "required": [ "entity_type", "original_transaction_number", "original_financial_year_end", "revision_date", "nature_of_noncompliance", "material_revisions", "confirms_later_events_not_dealt_with", "original_was_audited", "signing_directors" ], "description": "After the directors voluntarily revise defective financial statements without a court order, lodges the Notification of Revised Financial Statements on Bizfile within 30 days of the revision date and sends the revised statements to." }, "Create_sg_revised_financial_statements_file": { "type": "object", "properties": { "type": { "const": "sg.revised_financial_statements.file" }, "params": { "$ref": "#/components/schemas/Params_sg_revised_financial_statements_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Lodge revised financial statements", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "revised_financial_statements", "title": "Revised financial statements", "source": "uploaded", "required": true }, { "key": "revised_directors_statement", "title": "New directors' statement replacing the original", "source": "generated", "required": true }, { "key": "amended_auditor_report", "title": "Amended auditor's report", "source": "uploaded", "required": false }, { "key": "board_resolution_approving_revision", "title": "Board resolution approving the revised financial statements", "source": "generated", "required": true }, { "key": "distribution_evidence", "title": "Evidence the revised statements were sent to the required recipients", "source": "generated", "required": true }, { "key": "noe_submission", "title": "Notification of Revised Financial Statements on Bizfile", "source": "generated", "required": true }, { "key": "noe_acknowledgement", "title": "ACRA acknowledgement and outcome", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_approving_revision", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "revised_directors_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "amended_auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "noe_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General lodgement eService: 'File notice of error' > 'Notification of Revised Fina", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "lodgement_deadline_exceeded", "type": null, "when": "[requirement_error] More than 30 days have passed since the revision date." }, { "code": "section_202a_not_applicable", "type": null, "when": "[requirement_error] The company is a dormant relevant company, or the error is only in the XBRL file or the annual return form." }, { "code": "original_transaction_not_found", "type": null, "when": "[registry_error] The transaction number does not match a filing for this entity." }, { "code": "revised_statements_not_distributed", "type": null, "when": "[requirement_error] No evidence the revised statements reached the original recipients and everyone entitled to notice of a general meeting." }, { "code": "amended_audit_report_missing", "type": null, "when": "[requirement_error] The originals were audited and no amended auditor's report is attached." } ] } }, "Params_sg_society_annual_return_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year reported.", "examples": [ "2026-03-31" ] }, "agm_held": { "type": "boolean", "description": "False if no AGM was held.", "examples": [ "true" ] }, "agm_date": { "type": "string", "format": "date", "description": "Date of the AGM.", "examples": [ "2026-09-26" ] }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Gross income for the year.", "examples": [ "{\"amount\":180000,\"currency\":\"SGD\"}" ] }, "gross_expenditure": { "$ref": "#/components/schemas/Money", "description": "Gross expenditure for the year.", "examples": [ "{\"amount\":165000,\"currency\":\"SGD\"}" ] }, "auditor_class": { "type": "string", "enum": [ "society_auditor", "qualified_company_auditor" ], "description": "society_auditor if both figures are S$500,000 or below. qualified_company_auditor if either is above.", "examples": [ "society_auditor" ] }, "management_committee": { "type": "array", "items": {}, "description": "person_ref list of the current management committee with office held, including the President, Secretary and Treasurer.", "examples": [ "[\"per_3Ht8Ns\",\"per_7Qv2Lc\",\"per_5Wb9Jd\"]" ] }, "statement_of_accounts": { "type": "string", "pattern": "^doc_", "description": "Audited and certified Income and Expenditure Statement and Balance Sheet for the last financial year.", "examples": [ "doc_8NhV4rKe" ] } }, "required": [ "financial_year_end", "agm_held", "gross_income", "gross_expenditure", "auditor_class", "management_committee", "statement_of_accounts" ], "description": "Prepares the management committee particulars and the audited, certified statement of accounts, and tracks submission by the society's President, Secretary and Treasurer on ROS eServices within one month after the AGM." }, "Create_sg_society_annual_return_file": { "type": "object", "properties": { "type": { "const": "sg.society_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_society_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a registered society's annual return with the Registry of Societies", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_of_accounts", "title": "Audited and certified statement of accounts", "source": "uploaded", "required": true }, { "key": "management_committee_particulars", "title": "Management committee particulars", "source": "generated", "required": true }, { "key": "agm_minutes", "title": "AGM minutes", "source": "uploaded", "required": false }, { "key": "ros_filed_confirmation", "title": "ROS eServices confirmation, status 'Filed'", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "registry_idv" }, { "role": "officer", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_accounts", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_filed_confirmation", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "Annual Returns", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "accounts_not_certified", "type": null, "when": "requirement_error: the statement of accounts carries no auditor certification." }, { "code": "auditor_class_mismatch", "type": null, "when": "requirement_error: auditor_class does not match the S$500,000 test on income and expenditure." }, { "code": "attachment_too_large", "type": null, "when": "invalid_request_error: a file is over 5MB or not docx, pdf, png or jpg." }, { "code": "office_bearer_corppass_missing", "type": null, "when": "requirement_error: an office bearer has no Corppass access to the society's ROS account, so the society's Corppass Administrator must assign it." }, { "code": "management_committee_incomplete", "type": null, "when": "invalid_request_error: the President, Secretary or Treasurer is missing from the list." } ] } }, "Params_sg_society_certified_copy_request": { "type": "object", "properties": { "request_basis": { "type": "string", "enum": [ "certified_true_copy", "document_not_available_online" ], "description": "certified_true_copy of an online document, or a document not available online.", "examples": [ "certified_true_copy" ] }, "document_type": { "type": "string", "enum": [ "constitution", "management_committee_details", "annual_return", "statement_of_accounts", "other" ], "description": "What is requested.", "examples": [ "constitution" ] }, "period": { "type": "string", "description": "Year or date range, where relevant.", "examples": [ "2025" ] }, "estimated_pages": { "type": "integer", "description": "Used only to estimate the S$5 per page charge in the quote.", "examples": [ "12" ] }, "for_use_abroad": { "type": "boolean", "description": "True to chain an apostille request after delivery.", "examples": [ "false" ] }, "requester": { "type": "string", "pattern": "^per_", "description": "Person ROS contacts.", "examples": [ "per_3Ht8Ns" ] } }, "required": [ "request_basis", "document_type" ], "description": "Requests certified true copies and documents not available online. ROS charges a S$65 search fee plus S$5 for each page successfully extracted, and replies within 3 to 5 working days after payment." }, "Create_sg_society_certified_copy_request": { "type": "object", "properties": { "type": { "const": "sg.society_certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_sg_society_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a certified true copy or an offline document from the Registry of Societies", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "membership_proof", "title": "Proof of membership", "source": "uploaded", "required": false }, { "key": "certified_copy", "title": "Certified true copy or extracted document", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "certified_copy", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "Purchase of Documents: certified true copy or document not available online", "channel": "online", "government_fee": { "amount": 65, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "membership_required", "type": null, "when": "permission_error: the document is members only and no verified member is attached." }, { "code": "extraction_failed", "type": null, "when": "registry_error: ROS could not extract pages." }, { "code": "document_available_online", "type": null, "when": "requirement_error: an uncertified online copy suffices." } ] } }, "Params_sg_society_document_repurchase": { "type": "object", "properties": { "requested_documents": { "type": "array", "items": {}, "description": "List of {document_type, period}. document_type is constitution, management_committee_changes, annual_return or audited_statement_of_accounts.", "examples": [ "[{\"document_type\":\"constitution\"},{\"document_type\":\"annual_return\",\"period\":\"2025\"}]" ] }, "requester_capacity": { "type": "string", "enum": [ "society_member", "individual_user" ], "description": "society_member logs in through 'For Registered Societies'. individual_user logs in as a member of the public.", "examples": [ "individual_user" ] }, "requester": { "type": "string", "pattern": "^per_", "description": "Required for audited statements of accounts, which only members may buy.", "examples": [ "per_3Ht8Ns" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "requested_documents", "requester_capacity" ], "description": "Buys documents ROS sells online, such as the constitution, management committee changes, annual returns and audited statements of accounts, at S$10 each." }, "Create_sg_society_document_repurchase": { "type": "object", "properties": { "type": { "const": "sg.society_document.repurchase" }, "params": { "$ref": "#/components/schemas/Params_sg_society_document_repurchase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Buy society documents from the Registry of Societies", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "membership_proof", "title": "Proof of membership", "source": "uploaded", "required": false }, { "key": "purchased_documents", "title": "Documents purchased from ROS", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "purchased_documents", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "purchased_documents", "signer_role": "member", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "Purchase of Documents", "channel": "online", "government_fee": { "amount": 10, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "members_only_document", "type": null, "when": "permission_error: audited statements of accounts were requested without a verified society member." }, { "code": "document_not_available_online", "type": null, "when": "requirement_error: ROS does not sell this document online." }, { "code": "download_window_expired", "type": null, "when": "registry_error: ROS links lapsed after 7 calendar days before download." } ] } }, "Params_sg_vcc_annual_return_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "VCC financial year end.", "examples": [ "2026-06-30" ] }, "agm_status": { "type": "string", "enum": [ "held", "dispensed" ], "description": "Whether the AGM was held or dispensed with.", "examples": [ "held" ] }, "agm_date": { "type": "string", "format": "date", "description": "Required when agm_status is held.", "examples": [ "2026-10-09" ] }, "no_agm_notice_date": { "type": "string", "format": "date", "description": "Required when dispensed: date of the 60-day notice to members.", "examples": [ "2026-09-20" ] }, "statements_send_date": { "type": "string", "format": "date", "description": "Required when dispensed: date the audited statements were sent to members.", "examples": [ "2026-11-25" ] }, "investment_strategy": { "type": "string", "description": "Updated investment strategy of the VCC.", "examples": [ "Long-only Asia-Pacific listed equities with a 10% cash buffer." ] }, "sub_funds": { "type": "array", "items": {}, "description": "Each sub-fund as {name, uen, investment_strategy}.", "examples": [ "[{\"name\":\"APAC Growth Sub-Fund\",\"uen\":\"T25VC0001AS01\",\"investment_strategy\":\"Growth equities\"}]" ] }, "financial_statements_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the PDF statements as presented at the AGM or sent to members.", "examples": [ "doc_1RgF1aVcFs" ] }, "sub_fund_financial_statements": { "type": "array", "items": {}, "description": "doc_ ids of the sub-fund statements.", "examples": [ "[\"doc_1RgF1bSfFs\"]" ] }, "statement_by_directors_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the signed statement by directors.", "examples": [ "doc_1RgF1cSbDs" ] }, "auditor_report_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the auditor's report.", "examples": [ "doc_1RgF1dArRp" ] }, "directors_statement_signers": { "type": "array", "items": {}, "description": "person_ref list of signing directors: at least two, or the sole director.", "examples": [ "[\"per_1QdE1p\",\"per_1QdE2q\"]" ] }, "officer_and_manager_particulars_confirmed": { "type": "boolean", "description": "Customer confirms the directors, secretary and manager shown to ACRA are current.", "examples": [ "true" ] }, "acknowledge_late_penalty": { "type": "boolean", "description": "Required once the deadline has passed.", "examples": [ "false" ] }, "extension_of_time_action_id": { "type": "string", "description": "act_ id of a granted extension.", "examples": [ "act_1RgC5eEoAp" ] } }, "required": [ "financial_year_end", "agm_status", "investment_strategy", "financial_statements_document", "statement_by_directors_document", "auditor_report_document", "directors_statement_signers", "officer_and_manager_particulars_confirmed" ], "description": "Files the variable capital company's annual return in VCC eServices after the AGM. The return lists the directors, secretary and manager, each sub-fund and its investment strategy, and attaches the financial statements as presented at the." }, "Create_sg_vcc_annual_return_file": { "type": "object", "properties": { "type": { "const": "sg.vcc_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the VCC annual return", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "vcc_financial_statements", "title": "VCC financial statements", "source": "uploaded", "required": true }, { "key": "sub_fund_financial_statements", "title": "Sub-fund financial statements", "source": "uploaded", "required": false }, { "key": "statement_by_directors", "title": "Statement by directors", "source": "generated", "required": true }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": true }, { "key": "annual_return_acknowledgement", "title": "VCC eServices acknowledgement", "source": "registry_issued", "required": false }, { "key": "business_profile", "title": "Free Business Profile", "source": "registry_issued", "required": false }, { "key": "vcc_annual_return", "title": "Vcc annual return", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "none" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_by_directors", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "vcc_annual_return", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC eServices > Annual Filing > Annual Return", "channel": "online", "government_fee": { "amount": 1600, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_not_recorded", "type": null, "when": "requirement_error: the AGM was neither held nor dispensed with in Entiva's records for the year." }, { "code": "statements_mismatch", "type": null, "when": "requirement_error: the statements filed differ from those presented at the AGM or sent to members." }, { "code": "sub_fund_data_missing", "type": null, "when": "requirement_error: a sub-fund on ACRA's record has no strategy or statements." }, { "code": "directors_statement_unsigned", "type": null, "when": "requirement_error: not enough directors have signed." }, { "code": "overdue_returns_exist", "type": null, "when": "requirement_error: an earlier year is unfiled; file the overdue return first." }, { "code": "late_penalty_unacknowledged", "type": null, "when": "requirement_error: the deadline has passed and the penalty is not acknowledged." } ] } }, "Params_sg_xbrl_exemption_apply": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end of the affected statements.", "examples": [ "2026-03-31" ] }, "validation_error_description": { "type": "string", "description": "The BizFinx validation error and why it cannot be fixed.", "examples": [ "Rule 4012 fails on the cash flow tie-out after rounding in a foreign-currency subsidiary." ] }, "bizfinx_validation_result": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the failing validation output.", "examples": [ "doc_1RfM8vVlDz" ] }, "xbrl_file": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the XBRL file that fails validation.", "examples": [ "doc_1RfM8wXbRl" ] }, "signed_financial_statements": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the signed financial statements presented at the AGM.", "examples": [ "doc_1RfK1pDfXz" ] }, "annual_return_action_id": { "type": "string", "description": "act_ id of the annual return waiting on the exemption.", "examples": [ "act_1RfK3nArPq" ] } }, "required": [ "financial_year_end", "validation_error_description", "bizfinx_validation_result", "xbrl_file", "signed_financial_statements" ], "description": "Requests ACRA's exemption from XBRL filing when BizFinx validation shows a genuine error that cannot be fixed. The request is free, goes by email, and takes 3 to 7 working days." }, "Create_sg_xbrl_exemption_apply": { "type": "object", "properties": { "type": { "const": "sg.xbrl_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_xbrl_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for an XBRL filing exemption", "x-entiva": { "jurisdiction": "sg", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_request_form", "title": "ACRA XBRL exemption request form", "source": "generated", "required": true }, { "key": "signed_agm_financial_statements", "title": "Signed AGM financial statements", "source": "uploaded", "required": true }, { "key": "failing_xbrl_file", "title": "XBRL file", "source": "uploaded", "required": true }, { "key": "xbrl_exemption_approval", "title": "ACRA approval", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "signed_agm_financial_statements", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_request_form", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "XBRL exemption request form, emailed to acra_xbrl_application@acra.gov.sg with the signed ", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "error_not_genuine", "type": null, "when": "registry_error: ACRA treats the validation error as fixable and rejects the request." }, { "code": "annual_return_deadline_at_risk", "type": null, "when": "requirement_error: fewer than 7 working days remain before the annual return is due; the action warns and continues." }, { "code": "exemption_not_needed", "type": null, "when": "jurisdiction_error: the company is a solvent exempt private company or dormant relevant company, which need not file XBRL." }, { "code": "documents_incomplete", "type": null, "when": "requirement_error: the validation result, XBRL file or signed statements are missing." } ] } }, "Params_sg_cooperative_agm_hold": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the AGM covers.", "examples": [ "2026-06-30" ] }, "agm_date": { "type": "string", "format": "date", "description": "Date the AGM is or was held.", "examples": [ "2026-11-20" ] }, "registrar_extension_until": { "type": "string", "format": "date", "description": "A later AGM deadline allowed by the Registrar in this case (s53)." }, "mode": { "type": "string", "enum": [ "physical", "hybrid", "virtual" ], "description": "Hybrid and virtual meetings need a by-law that allows them.", "examples": [ "physical" ] }, "venue": { "type": "string", "description": "Address or platform.", "examples": [ "Society hall" ] }, "notice_sent_on": { "type": "string", "format": "date", "description": "Date the notice, annual report and audited financial statements were made available to every member and delegate entitled to attend.", "examples": [ "2026-10-30" ] }, "bylaw_notice_days": { "type": "integer", "description": "A longer notice period set by the by-laws, in clear days.", "examples": [ "15" ] }, "credit_coop": { "type": "boolean", "description": "True for a credit co-op.", "examples": [ "false" ] }, "agenda": { "type": "array", "items": {}, "description": "[{item: string, type: confirm_minutes | approve_afs | surplus_distribution | committee_honorarium | bylaw_amendment | election_or_removal | appoint_auditors |." }, "chair": { "type": "string", "pattern": "^per_", "description": "Chairman of the meeting.", "examples": [ "per_1Ak5vTz9" ] }, "attendance": { "type": "object", "description": "Recorded after the meeting: {members_entitled: integer, members_present: integer, quorum_met_at_start: boolean, quorum_formed_after_30_minutes?: boolean}." }, "resolutions": { "type": "array", "items": {}, "description": "Recorded after the meeting: [{agenda_item, result: carried | lost, votes_for, votes_against, abstentions}]." }, "election": { "type": "object", "description": "For an election or removal: {ballot: secret, candidates: person_ref[], elected: person_ref[], removed: person_ref[]}." }, "annual_report_document_id": { "type": "string", "pattern": "^doc_", "description": "The annual report on the society's activities, in the Registry's required format.", "examples": [ "doc_5Rj2wNe7" ] }, "afs_document_id": { "type": "string", "pattern": "^doc_", "description": "The signed audited financial statements and auditor's report.", "examples": [ "doc_8Cm4yHs1" ] }, "draft_minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "Customer-drafted minutes." }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref[] for other documents sent with the notice." } }, "required": [ "financial_year_end", "agm_date", "mode", "notice_sent_on", "credit_coop", "agenda", "chair", "annual_report_document_id", "afs_document_id" ], "description": "Plans a co-op's AGM so that it falls within 6 months after the financial year end (Co-operative Societies Act s53), prepares the notice, agenda, annual report and signed audited financial statements for members at least 15 clear days." }, "Create_sg_cooperative_agm_hold": { "type": "object", "properties": { "type": { "const": "sg.cooperative_agm.hold" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_agm_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare, hold and minute a co-operative society's annual general meeting", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "agm_notice_and_agenda", "title": "Notice of AGM and agenda", "source": "generated", "required": true }, { "key": "annual_report", "title": "Annual report on the society's activities", "source": "uploaded", "required": true }, { "key": "signed_afs", "title": "Signed audited financial statements and auditor's report", "source": "uploaded", "required": true }, { "key": "members_statements_of_account", "title": "Members' statements of account", "source": "uploaded", "required": false }, { "key": "proof_of_notice", "title": "Proof that the documents were made available to members", "source": "uploaded", "required": false }, { "key": "attendance_record", "title": "Attendance record and quorum count", "source": "generated", "required": true }, { "key": "ballot_record", "title": "Record of the secret ballot", "source": "generated", "required": false }, { "key": "minutes", "title": "Minutes of the AGM", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "appointee", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 20, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "agm_notice_and_agenda", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "signed_afs", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None for this action", "form": "AGM notice, minutes and minute book entries under Co-operative Societies Act s53 and the b", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_after_deadline", "type": null, "when": "agm_date is later than 6 months after financial_year_end and no registrar_extension_until is given." }, { "code": "notice_period_too_short", "type": null, "when": "Fewer than 15 clear days lie between notice_sent_on and agm_date." }, { "code": "quorum_not_met", "type": null, "when": "Resolutions are marked carried but attendance shows no quorum and the 30-minute fallback was not used." }, { "code": "election_not_by_secret_ballot", "type": null, "when": "An election or removal is recorded without a secret ballot." }, { "code": "tie_marked_carried", "type": null, "when": "A tied vote is marked carried." }, { "code": "bylaw_amendment_not_cleared", "type": null, "when": "The agenda has a by-law amendment but the draft table was not sent to the Registry at least 2 months before the notice." }, { "code": "proxy_not_permitted", "type": null, "when": "An individual member's proxy vote is recorded." } ] } }, "Params_sg_cooperative_agm_return_file": { "type": "object", "properties": { "agm_date": { "type": "string", "format": "date", "description": "Date the AGM was held.", "examples": [ "2026-10-10" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year covered.", "examples": [ "2026-04-30" ] }, "credit_coop": { "type": "boolean", "description": "True for a credit co-op, which also completes Section 2 of the update form.", "examples": [ "false" ] }, "source_action_id": { "type": "string", "description": "The act_ id of the sg.cooperative_agm.hold action.", "examples": [ "act_2Qs7nBd4" ] }, "office_bearers": { "type": "array", "items": {}, "description": "The full list after the AGM: [{person_id: person_ref, office_held: string, elected_on?: date, ceased_on?: date}]." }, "declaration_signatory": { "type": "string", "pattern": "^per_", "description": "The officer who signs the declaration in Section 3.", "examples": [ "per_1Ak5vTz9" ] }, "credit_section_document_id": { "type": "string", "pattern": "^doc_", "description": "Completed Section 2." }, "minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "Minutes of the AGM, kept with the pack." }, "late_acknowledged": { "type": "boolean", "description": "True to accept a submission after the date Entiva scheduled.", "examples": [ "false" ] } }, "required": [ "agm_date", "financial_year_end", "credit_coop", "office_bearers", "declaration_signatory" ], "description": "After the AGM, completes the Registry's AGM Form and the 'COM Members and Key Officers Update' from the AGM record and prepares them for the committee to submit to the Registry of Co-operative Societies. The society submits; Entiva." }, "Create_sg_cooperative_agm_return_file": { "type": "object", "properties": { "type": { "const": "sg.cooperative_agm_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_agm_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit the AGM Form and the list of office bearers to the Registry", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "agm_form", "title": "AGM Form", "source": "generated", "required": true }, { "key": "com_members_update", "title": "COM Members and Key Officers Update", "source": "generated", "required": true }, { "key": "agm_minutes", "title": "Minutes of the AGM", "source": "uploaded", "required": false }, { "key": "submission_proof", "title": "Proof of submission to the Registry", "source": "uploaded", "required": true }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "com_members_update", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "agm_form", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "AGM Form", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agm_not_recorded", "type": null, "when": "No sg.cooperative_agm.hold record exists for agm_date and source_action_id is empty." }, { "code": "declaration_unsigned", "type": null, "when": "Section 3 has not been signed by the declaration signatory." }, { "code": "office_bearer_particulars_missing", "type": null, "when": "A listed officer lacks a verified identity or an office title." }, { "code": "template_outdated", "type": null, "when": "The Registry has reissued a template since the pack was generated." }, { "code": "submission_proof_missing", "type": null, "when": "The submission requirement is open and no proof of sending has been uploaded." } ] } }, "Params_sg_cooperative_annual_report_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the report covers.", "examples": [ "2026-04-30" ] }, "credit_coop": { "type": "boolean", "description": "True for a credit co-op.", "examples": [ "false" ] }, "annual_report_document_id": { "type": "string", "pattern": "^doc_", "description": "The annual report on the society's activities.", "examples": [ "doc_5Rj2wNe7" ] }, "annual_report_requirements_document_id": { "type": "string", "pattern": "^doc_", "description": "The completed 'Annual report requirements' XLSX.", "examples": [ "doc_9Dk4tVb6" ] }, "afs_document_id": { "type": "string", "pattern": "^doc_", "description": "The signed audited financial statements.", "examples": [ "doc_8Cm4yHs1" ] }, "afs_form_document_id": { "type": "string", "pattern": "^doc_", "description": "The completed 'Audited Financial Statements and Auditors' Report' XLSX.", "examples": [ "doc_1Ve7nQp3" ] }, "auditors_report_document_id": { "type": "string", "pattern": "^doc_", "description": "The auditor's report.", "examples": [ "doc_6Gh2zWm8" ] }, "form_wd_1_document_id": { "type": "string", "pattern": "^doc_", "description": "Completed Form WD-1." }, "registrar_extension": { "type": "object", "description": "If the Registrar extended the deadline for a special reason (s34): {granted_until: date, reference: string}." }, "agm_action_id": { "type": "string", "description": "The act_ id of the AGM action at which the statements were laid.", "examples": [ "act_2Qs7nBd4" ] }, "late_acknowledged": { "type": "boolean", "description": "True to accept a submission after the 6-month limit.", "examples": [ "false" ] } }, "required": [ "financial_year_end", "credit_coop", "annual_report_document_id", "annual_report_requirements_document_id", "afs_document_id", "afs_form_document_id", "auditors_report_document_id" ], "description": "Prepares the pack the society must send to the Registry within 6 months after each financial year end (Co-operative Societies Act s34): the annual report, the audited financial statements and the auditor's report, with the Registry's." }, "Create_sg_cooperative_annual_report_file": { "type": "object", "properties": { "type": { "const": "sg.cooperative_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit a co-operative society's annual report and audited financial statements", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Annual report", "source": "uploaded", "required": true }, { "key": "annual_report_requirements", "title": "Annual report requirements", "source": "uploaded", "required": true }, { "key": "signed_afs", "title": "Signed audited financial statements", "source": "uploaded", "required": true }, { "key": "afs_form", "title": "Audited Financial Statements and Auditors' Report", "source": "uploaded", "required": true }, { "key": "auditors_report", "title": "Auditor's report", "source": "uploaded", "required": true }, { "key": "form_wd_1", "title": "Form WD-1", "source": "uploaded", "required": false }, { "key": "submission_proof", "title": "Proof of submission to the Registry", "source": "uploaded", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "signed_afs", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditors_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Annual report, audited financial statements and auditor's report, with the Registry's 'Ann", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "afs_unsigned", "type": null, "when": "signed_afs or the auditor's report is not signed." }, { "code": "template_mismatch", "type": null, "when": "The credit and non-credit annual report templates do not match credit_coop." }, { "code": "deadline_passed", "type": null, "when": "More than 6 months have passed since financial_year_end, there is no registrar_extension and late_acknowledged is not true." }, { "code": "wd1_missing", "type": null, "when": "credit_coop is true and form_wd_1_document_id is empty." }, { "code": "submission_proof_missing", "type": null, "when": "The submission requirement is open and no proof of sending has been uploaded." } ] } }, "Params_sg_cooperative_office_bearers_change": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "elected_at_general_meeting", "appointed_by_committee", "resigned", "removed", "term_ended", "particulars_changed", "annual_update" ], "description": "What triggered the update.", "examples": [ "resigned" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change.", "examples": [ "2026-10-12" ] }, "office_bearers": { "type": "array", "items": {}, "description": "The full current list: [{person_id: person_ref, office_held: string, appointed_on?: date, ceased_on?: date}]." }, "changes": { "type": "array", "items": {}, "description": "Summary of what changed: [{person_id, office_held, change: added | ceased | changed, date}]." }, "credit_coop": { "type": "boolean", "description": "True for a credit co-op, which also completes Section 2.", "examples": [ "false" ] }, "credit_section_document_id": { "type": "string", "pattern": "^doc_", "description": "Completed Section 2." }, "declaration_signatory": { "type": "string", "pattern": "^per_", "description": "The officer who signs the declaration in Section 3.", "examples": [ "per_1Ak5vTz9" ] }, "late_acknowledged": { "type": "boolean", "description": "True to accept a submission after the scheduled date.", "examples": [ "false" ] } }, "required": [ "change_type", "effective_date", "office_bearers", "credit_coop", "declaration_signatory" ], "description": "Prepares the 'COM Members and Key Officers Update' when committee members or key officers change outside the AGM, or for the yearly refresh, and gets the declaration signed. The society submits the update to the Registry of Co-operative." }, "Create_sg_cooperative_office_bearers_change": { "type": "object", "properties": { "type": { "const": "sg.cooperative_office_bearers.change" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_office_bearers_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update the Registry on a co-operative society's committee and key officers", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "com_members_update", "title": "COM Members and Key Officers Update", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "submission_proof", "title": "Proof of submission to the Registry", "source": "uploaded", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "com_members_update", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "COM Members and Key Officers Update", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "declaration_unsigned", "type": null, "when": "Section 3 has not been signed." }, { "code": "office_bearer_particulars_missing", "type": null, "when": "A listed officer lacks a verified identity or an office title." }, { "code": "election_not_recorded", "type": null, "when": "change_type is elected_at_general_meeting and no sg.cooperative_agm.hold record covers the election." }, { "code": "template_outdated", "type": null, "when": "The Registry has reissued the template since the pack was generated." }, { "code": "submission_proof_missing", "type": null, "when": "The submission requirement is open and no proof of sending has been uploaded." } ] } }, "Params_sg_directors_resolution_record": { "type": "object", "properties": { "resolution_type": { "type": "string", "enum": [ "written", "sole_director" ], "description": "written: signed by all directors, counterparts allowed. sole_director: the only director records and signs the decision.", "examples": [ "written" ] }, "title": { "type": "string", "description": "Short title shown in the minute book.", "examples": [ "Approve operating bank account and signatories" ] }, "category": { "type": "string", "enum": [ "officer_appointment", "officer_removal", "share_issue_or_transfer", "financial_statements", "registered_office", "banking_and_finance", "agent_mandate_authorisation", "corporate_representative_authorisation", "convening_general_meeting", "strike_off_or_winding_up", "other" ], "description": "What the resolution is about.", "examples": [ "banking_and_finance" ] }, "resolutions": { "type": "array", "items": {}, "description": "One or more resolutions, each {number: integer, text: string, effective_date?: date}.", "examples": [ "[{\"number\":1,\"text\":\"That the Company open a corporate operating account with a bank in Singapore.\"}]" ] }, "signatories": { "type": "array", "items": {}, "description": "person_ref[] of the directors who sign.", "examples": [ "[\"per_3Nw8dRz1\",\"per_7Kc2pQx9\"]" ] }, "alternate_signatories": { "type": "array", "items": {}, "description": "[{alternate_person_id: person_ref, principal_person_id: person_ref}] for an alternate director signing for a director." }, "interested_directors": { "type": "array", "items": {}, "description": "person_ref[] of directors with an interest in the matter." }, "circulated_on": { "type": "string", "format": "date", "description": "Date the draft goes to the directors.", "examples": [ "2026-10-17" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the resolutions take effect, if later than the date of the last signature.", "examples": [ "2026-10-19" ] }, "related_action_id": { "type": "string", "description": "The act_ id of the action this resolution authorises, if any.", "examples": [ "act_4Ld9sWq2" ] }, "draft_document_id": { "type": "string", "pattern": "^doc_", "description": "A customer-drafted resolution.", "examples": [ "doc_6Tz1mRe8" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref[] attached to the minute-book entry." } }, "required": [ "resolution_type", "title", "category", "resolutions" ], "description": "Drafts a directors' resolution that is passed without a meeting, collects each director's signature and enters it in the minute book. Use it for a written resolution signed by all directors, or for a sole director recording and signing a." }, "Create_sg_directors_resolution_record": { "type": "object", "properties": { "type": { "const": "sg.directors_resolution.record" }, "params": { "$ref": "#/components/schemas/Params_sg_directors_resolution_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a directors' written resolution or sole-director resolution", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "draft_resolution", "title": "Customer-drafted resolution", "source": "uploaded", "required": false }, { "key": "supporting_documents", "title": "Supporting documents", "source": "uploaded", "required": false }, { "key": "minute_book_entry", "title": "Minute book entry", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "alternate_director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "minute_book_entry", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Minute book entry", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "signatory_not_a_director", "type": null, "when": "A named signatory is not a director in office on circulated_on." }, { "code": "sole_director_record_not_available", "type": null, "when": "resolution_type is sole_director but the company has more than one director in office." }, { "code": "constitution_requires_meeting", "type": null, "when": "The constitution or the subject matter requires a board meeting." }, { "code": "alternate_not_permitted", "type": null, "when": "An alternate signs without a constitutional power to appoint alternates or without board approval of the appointment." } ] } }, "Params_sg_foreign_company_member_register_change": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "member_added", "member_ceased", "holding_changed", "member_particulars_changed", "allotment_recorded" ], "description": "What changed.", "examples": [ "member_added" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the member was entered, ceased, or the holding or particulars changed.", "examples": [ "2026-10-09" ] }, "member": { "type": "object", "description": "{kind: individual | legal_entity, name: string, address: address, person_id?: person_ref}.", "examples": [ "{\"kind\":\"legal_entity\",\"name\":\"Harbourline Holdings Ltd\",\"person_id\":\"per_6Bc2nVx7\"}" ] }, "holding": { "type": "object", "description": "For a company with share capital: {share_class, shares_held: integer, amount_paid: money, amount_agreed_to_be_considered_paid?: money}.", "examples": [ "{\"share_class\":\"Ordinary\",\"shares_held\":25000,\"amount_paid\":{\"amount\":25000,\"currency\":\"GBP\"}}" ] }, "allotment": { "type": "object", "description": "For allotment_recorded: {allotted_on: date, shares_allotted: integer, issue_price_per_share: money}." }, "listing_status": { "type": "string", "enum": [ "unlisted", "sgx_listed", "overseas_listed" ], "description": "unlisted: list every member. sgx_listed: ACRA's guide says to list only the Central Depository as member. overseas_listed: Entiva checks the 2023 exemption.", "examples": [ "unlisted" ] }, "is_nominee_shareholder": { "type": "boolean", "description": "True if this member holds on another person's instructions.", "examples": [ "false" ] }, "evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Evidence of the change: share transfer instrument, allotment notice, or an extract from the home-country register.", "examples": [ "doc_3Yb7kQn1" ] }, "related_action_id": { "type": "string", "description": "The act_ id of an action that caused the change." } }, "required": [ "change_type", "effective_date", "member", "evidence_document_id" ], "description": "Keeps the branch's public register of members up to date. Every foreign company registered in Singapore must keep a register of its members in Singapore and reflect changes within 30 days." }, "Create_sg_foreign_company_member_register_change": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_member_register.change" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_member_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a foreign company's public register of members in Singapore", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members", "source": "generated", "required": true }, { "key": "member_index", "title": "Index of members", "source": "generated", "required": false }, { "key": "update_instruction", "title": "Instruction to update the register", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "update_instruction", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_members", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Branch register of members", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "member_particulars_incomplete", "type": null, "when": "name, address, or shares and amount paid are missing." }, { "code": "register_not_required", "type": null, "when": "listing_status is sgx_listed or the company relies on the 2023 listed-foreign-company exemption." }, { "code": "update_overdue", "type": null, "when": "effective_date is more than 30 days ago." }, { "code": "nominee_disclosure_required", "type": null, "when": "is_nominee_shareholder is true and no nominee action follows within 7 days." } ] } }, "Params_sg_foreign_company_member_register_location_change": { "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "initial_notice", "change_of_location" ], "description": "initial_notice: first notice after registration. change_of_location: the address has changed.", "examples": [ "change_of_location" ] }, "location_type": { "type": "string", "enum": [ "registered_office", "other_singapore_address" ], "description": "The register can be kept at the registered office in Singapore or at another place in Singapore.", "examples": [ "other_singapore_address" ] }, "address": { "$ref": "#/components/schemas/Address", "description": "The Singapore address where the register is kept.", "examples": [ "{\"line1\":\"10 Anson Road\",\"line2\":\"#12-05\",\"city\":\"Singapore\",\"postal_code\":\"079903\",\"country\":\"SG\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the register moved, or the date of registration for an initial notice.", "examples": [ "2026-10-12" ] }, "previous_address": { "$ref": "#/components/schemas/Address", "description": "The old address, for change_of_location." } }, "required": [ "purpose", "location_type", "address", "effective_date" ], "description": "Notifies ACRA of the Singapore address at which the branch's register of members is kept, on first registration and whenever the address changes. The foreign company must give the notice within 30 days (Companies Act s379 and)." }, "Create_sg_foreign_company_member_register_location_change": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_member_register_location.change" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_member_register_location_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify ACRA where a foreign company's register of members is kept", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "location_confirmation", "title": "Statement of where the register is kept", "source": "generated", "required": true }, { "key": "bizfile_declaration", "title": "Bizfile submission declaration", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "Bizfile acknowledgement and Inbox confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "location_confirmation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bizfile_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "ACRA", "form": "Update entity information: location of the branch register of members", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_not_in_singapore", "type": null, "when": "The address is not in Singapore." }, { "code": "no_authorised_representative", "type": null, "when": "The branch has no authorised representative on record to confirm the notice." }, { "code": "notice_overdue", "type": null, "when": "effective_date is more than 30 days ago." }, { "code": "location_unchanged", "type": null, "when": "The address already matches ACRA's record." } ] } }, "Params_sg_foreign_company_nominee_register_change": { "type": "object", "properties": { "register": { "type": "string", "enum": [ "nominee_directors", "nominee_shareholders" ], "description": "Which register.", "examples": [ "nominee_directors" ] }, "change_type": { "type": "string", "enum": [ "nominee_added", "nominee_ceased", "nominator_particulars_changed", "no_nominees_confirmation", "exemption_declaration" ], "description": "What to record.", "examples": [ "nominee_added" ] }, "nominee": { "type": "string", "pattern": "^per_", "description": "The nominee director or nominee shareholder.", "examples": [ "per_3Nw8dRz1" ] }, "shareholder_name": { "type": "string", "description": "For nominee_shareholders: the shareholder's name as it appears in the register of members." }, "nominator": { "type": "string", "pattern": "^per_", "description": "The nominator, an individual or legal entity with the particulars ACRA requires.", "examples": [ "per_6Bc2nVx7" ] }, "informed_company_on": { "type": "string", "format": "date", "description": "Date the nominee informed the company.", "examples": [ "2026-10-12" ] }, "date_became_nominee": { "type": "string", "format": "date", "description": "Actual date the nominee relationship began.", "examples": [ "2026-10-01" ] }, "date_ceased_nominee": { "type": "string", "format": "date", "description": "Date the relationship ended, for nominee_ceased." }, "changed_fields": { "type": "array", "items": {}, "description": "For nominator_particulars_changed: the names of the fields that changed, for example [\"residential_address\"]." }, "exemption_category": { "type": "string", "enum": [ "singapore_financial_institution", "wholly_owned_subsidiary_of_singapore_fi", "overseas_listed_with_transparency", "primary_listing_on_approved_singapore_exchange" ], "description": "For exemption_declaration.", "examples": [ "overseas_listed_with_transparency" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref[] kept with the register: the nominee's letter or email, and the nominator's ID or certificate of registration." } }, "required": [ "register", "change_type" ], "description": "Enters a nominee, a change to a nominator's particulars, a cessation, a 'no nominees' confirmation or an exemption declaration in the branch's private register of nominee directors or of nominee shareholders, then files the same." }, "Create_sg_foreign_company_nominee_register_change": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_nominee_register.change" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_nominee_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a foreign company's register of nominee directors or nominee shareholders", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nominee_disclosure", "title": "Nominee's information to the company", "source": "uploaded", "required": false }, { "key": "nominator_identity", "title": "Nominator's identity evidence", "source": "uploaded", "required": false }, { "key": "register_entry", "title": "Register entry", "source": "generated", "required": true }, { "key": "update_instruction", "title": "Instruction to update the register", "source": "generated", "required": true }, { "key": "bizfile_declaration", "title": "Bizfile submission declaration", "source": "generated", "required": true }, { "key": "central_filing_acknowledgement", "title": "Central ROND/RONS filing acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "nominee_director", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nominee_disclosure", "signer_role": "nominee_director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "update_instruction", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bizfile_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "register_entry", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'Update Registers of Nominee Directors and Nominee Shareholders'", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nominator_particulars_incomplete", "type": null, "when": "A required nominator particular is missing: full name, aliases if any, residential address, email, contact number, nationality, ID or passport number, date of birth and the date." }, { "code": "position_holder_cessation_pending", "type": null, "when": "change_type is nominee_ceased for a director whose appointment has not been withdrawn." }, { "code": "private_register_overdue", "type": null, "when": "More than 7 days since informed_company_on." }, { "code": "central_filing_overdue", "type": null, "when": "More than 2 business days since the private entry." }, { "code": "exemption_category_required", "type": null, "when": "change_type is exemption_declaration and exemption_category is empty." }, { "code": "nominee_not_found", "type": null, "when": "nominee_person_id is not a director or member of the branch on the effective date." } ] } }, "Params_sg_holding_company_minutes_file": { "type": "object", "properties": { "meeting_date": { "type": "string", "format": "date", "description": "Date of the subsidiary's general meeting that the minute records.", "examples": [ "2026-10-14" ] }, "minutes_signed_on": { "type": "string", "format": "date", "description": "Date the representative signed the minute.", "examples": [ "2026-10-15" ] }, "minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "The signed minute as a PDF up to 5MB.", "examples": [ "doc_5Pd8wKs3" ] }, "holding_company": { "type": "string", "pattern": "^per_", "description": "The holding company, held as a legal-entity person record.", "examples": [ "per_2Vb6eKc9" ] }, "representative": { "type": "string", "pattern": "^per_", "description": "The individual authorised by the holding company under s179 who signed the minute.", "examples": [ "per_4Gh7sNd2" ] }, "authorisation_document_id": { "type": "string", "pattern": "^doc_", "description": "Resolution of the holding company's directors or governing body authorising the representative (s179).", "examples": [ "doc_8Qw2nBz6" ] }, "holds_all_issued_shares": { "type": "boolean", "description": "Must be true: the holding company is beneficially entitled to all the issued shares of the subsidiary (s179).", "examples": [ "true" ] }, "matter_requires_lodgement": { "type": "boolean", "description": "Must be true: the minute records a resolution or matter that must be lodged with the Registrar (s179).", "examples": [ "true" ] }, "related_action_id": { "type": "string", "description": "The act_ id of the lodging action for the resolution the minute records, if lodged separately.", "examples": [ "act_6Rb1mQs9" ] }, "late_lodgement_acknowledged": { "type": "boolean", "description": "Required and true if the 14 days have passed.", "examples": [ "false" ] } }, "required": [ "meeting_date", "minutes_signed_on", "minutes_document_id", "holding_company", "representative", "authorisation_document_id", "holds_all_issued_shares", "matter_requires_lodgement" ], "description": "Where a holding company owns all the issued shares of a subsidiary, a minute signed by its authorised representative can record that a resolution or matter was passed at the subsidiary's general meeting (Companies Act s179). If the minute." }, "Create_sg_holding_company_minutes_file": { "type": "object", "properties": { "type": { "const": "sg.holding_company_minutes.file" }, "params": { "$ref": "#/components/schemas/Params_sg_holding_company_minutes_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Lodge a copy of minutes signed by a holding company's representative", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "holding_company_minute", "title": "Minute signed by the holding company's representative", "source": "uploaded", "required": true }, { "key": "representative_authorisation", "title": "Holding company's authorisation of its representative (s179)", "source": "uploaded", "required": true }, { "key": "bizfile_declaration", "title": "Bizfile submission declaration", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "Bizfile acknowledgement and Inbox confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "member", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "holding_company_minute", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "representative_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "ACRA", "form": "Notice of Resolution: type 'Copy of Minutes", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "holding_company_not_sole_member", "type": null, "when": "The shareholding record shows another member, so s179 does not apply." }, { "code": "representative_not_authorised", "type": null, "when": "No s179 authorisation is on file for the person who signed." }, { "code": "matter_not_lodgeable", "type": null, "when": "matter_requires_lodgement is false." }, { "code": "lodgement_overdue", "type": null, "when": "More than 14 days have passed since minutes_signed_on and late_lodgement_acknowledged is not true." }, { "code": "attachment_rejected", "type": null, "when": "A PDF exceeds 5MB or cannot be made compliant with ACRA's file-name rules." } ] } }, "Params_sg_llp_partners_resolution_record": { "type": "object", "properties": { "decision_method": { "type": "string", "enum": [ "written", "meeting_minutes" ], "description": "written: signed by the deciding partners. meeting_minutes: a partners' meeting recorded with attendance and votes.", "examples": [ "written" ] }, "category": { "type": "string", "enum": [ "partner_change", "capital_or_profit_share", "annual_declaration", "banking_and_finance", "strike_off_or_winding_up", "other" ], "description": "What the decision is about.", "examples": [ "banking_and_finance" ] }, "title": { "type": "string", "description": "Short title.", "examples": [ "Approve LLP operating account" ] }, "decision_text": { "type": "string", "description": "Full text of the decision.", "examples": [ "That the LLP open an operating account with a bank in Singapore." ] }, "llp_agreement_clause": { "type": "string", "description": "The clause of the LLP agreement that authorises this decision and sets the voting rule.", "examples": [ "Clause 7.2 (unanimous partners)" ] }, "decided_by": { "type": "array", "items": {}, "description": "person_ref[] of the partners or managers who sign." }, "meeting": { "type": "object", "description": "For meeting_minutes: {date, mode: physical | hybrid | virtual, chair_person_id, attendees: person_ref[], quorum_met: boolean}." }, "effective_date": { "type": "string", "format": "date", "description": "Date the decision takes effect.", "examples": [ "2026-10-20" ] }, "related_action_id": { "type": "string", "description": "The act_ id of an action the decision authorises.", "examples": [ "act_8Cn5kRy2" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref[] attached to the record." } }, "required": [ "decision_method", "category", "title", "decision_text", "decided_by" ], "description": "Records a decision of an LLP's partners or managers made under the LLP agreement, collects the signatures and keeps the record in the LLP's file. The Companies Act resolution and minute rules do not apply to an LLP, and no ACRA filing." }, "Create_sg_llp_partners_resolution_record": { "type": "object", "properties": { "type": { "const": "sg.llp_partners_resolution.record" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_partners_resolution_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a Singapore LLP partners' or managers' decision", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_decision", "title": "Partners' or managers' decision", "source": "generated", "required": true }, { "key": "llp_agreement", "title": "LLP agreement", "source": "uploaded", "required": false }, { "key": "corporate_partner_authorisation", "title": "Corporate partner's authorisation of its representative", "source": "uploaded", "required": false }, { "key": "record_entry", "title": "Entry in the LLP's decision record", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_decision", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "record_entry", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Record entry under the LLP agreement", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "signatory_not_a_partner", "type": null, "when": "A name in decided_by is not a partner or manager of the LLP." }, { "code": "llp_agreement_required", "type": null, "when": "Neither llp_agreement_clause nor an uploaded LLP agreement is on file and the decision is not unanimous." }, { "code": "minimum_partners_breached", "type": null, "when": "The decision would leave the LLP with fewer than 2 partners." } ] } }, "Params_sg_meeting_minutes_record": { "type": "object", "properties": { "meeting_type": { "type": "string", "enum": [ "annual_general_meeting", "extraordinary_general_meeting", "directors_meeting", "chief_executive_officers_meeting" ], "description": "Type of meeting.", "examples": [ "extraordinary_general_meeting" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Date the meeting was held.", "examples": [ "2026-10-14" ] }, "mode": { "type": "string", "enum": [ "physical", "hybrid", "virtual" ], "description": "Physical, hybrid or fully virtual.", "examples": [ "hybrid" ] }, "venue": { "type": "string", "description": "Address or platform.", "examples": [ "Registered office and video link" ] }, "notice_sent_on": { "type": "string", "format": "date", "description": "Date notice of a general meeting was sent.", "examples": [ "2026-09-29" ] }, "chair": { "type": "string", "pattern": "^per_", "description": "Chair of this meeting.", "examples": [ "per_3Nw8dRz1" ] }, "attendees": { "type": "array", "items": {}, "description": "[{person_id: person_ref, capacity: director | member | proxy | corporate_representative | secretary | auditor | other, votes_held?: integer}]." }, "quorum_met": { "type": "boolean", "description": "Whether a quorum was present when business began.", "examples": [ "true" ] }, "resolutions": { "type": "array", "items": {}, "description": "[{number, text, kind: ordinary | special | board, result: carried | lost | withdrawn, votes_for?, votes_against?, abstentions?, by_poll?: boolean}]." }, "signing_chair": { "type": "string", "enum": [ "this_meeting", "next_meeting" ], "description": "Whose chair signs: the chair of this meeting or of the next one (s188).", "examples": [ "this_meeting" ] }, "holding_company_representative_present": { "type": "boolean", "description": "True if a representative of a holding company that owns all the shares signed a minute (s179).", "examples": [ "false" ] }, "lodge_with_acra": { "type": "boolean", "description": "Default true when any resolution is special or binds a class.", "examples": [ "true" ] }, "draft_minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "Customer-drafted minutes.", "examples": [ "doc_1Qe4yTc6" ] }, "related_action_id": { "type": "string", "description": "The act_ id of an action the meeting authorised.", "examples": [ "act_6Hs3dPv8" ] } }, "required": [ "meeting_type", "meeting_date", "mode", "chair", "attendees", "quorum_met" ], "description": "Drafts the minutes of an AGM, EGM, directors' meeting or chief executive officers' meeting, records attendance, quorum and each resolution with its vote, gets the chair's signature and enters the minutes in the minute book. Meeting." }, "Create_sg_meeting_minutes_record": { "type": "object", "properties": { "type": { "const": "sg.meeting_minutes.record" }, "params": { "$ref": "#/components/schemas/Params_sg_meeting_minutes_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record minutes of a general meeting or directors' meeting", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_meeting", "title": "Notice of the meeting", "source": "uploaded", "required": false }, { "key": "attendance_record", "title": "Attendance record", "source": "generated", "required": true }, { "key": "proxy_instruments", "title": "Proxy instruments", "source": "uploaded", "required": false }, { "key": "poll_results", "title": "Poll results", "source": "uploaded", "required": false }, { "key": "minutes", "title": "Minutes of the meeting", "source": "generated", "required": true }, { "key": "minute_book_entry", "title": "Minute book entry", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 95, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "minute_book_entry", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Minute book entry", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "quorum_not_met", "type": null, "when": "quorum_met is false and the resolutions list contains carried resolutions." }, { "code": "notice_period_not_met", "type": null, "when": "A special resolution was carried on less than 14 days' notice or 21 days and the 95% short-notice consent is not documented." }, { "code": "special_resolution_threshold_not_met", "type": null, "when": "A special resolution is marked carried with fewer than three-fourths of votes cast in favour." }, { "code": "minutes_entry_overdue", "type": null, "when": "meeting_date is more than one month ago." }, { "code": "virtual_meeting_not_permitted", "type": null, "when": "mode is hybrid or virtual and the constitution does not allow it." } ] } }, "Params_sg_members_resolution_record": { "type": "object", "properties": { "passed_by": { "type": "string", "enum": [ "written_resolution", "sole_member_record" ], "description": "written_resolution: several members agree in writing. sole_member_record: the company has one member who records and signs.", "examples": [ "written_resolution" ] }, "resolution_kind": { "type": "string", "enum": [ "ordinary", "special", "s76_9b_e" ], "description": "ordinary needs a majority of total voting rights. special needs at least 75% of total voting rights. s76_9b_e is a resolution that states it is made under s76.", "examples": [ "special" ] }, "subject": { "type": "string", "enum": [ "allot_shares", "alter_constitution", "change_name", "dispense_with_agm", "remove_director_or_auditor", "approve_financial_statements", "appoint_auditor", "other" ], "description": "What the resolution decides.", "examples": [ "allot_shares" ] }, "title": { "type": "string", "description": "Short title for the minute book.", "examples": [ "Authority to allot 10,000 ordinary shares" ] }, "resolution_text": { "type": "string", "description": "Full text.", "examples": [ "That, as a special resolution, ..." ] }, "circulated_on": { "type": "string", "format": "date", "description": "Date the text is first sent to the members.", "examples": [ "2026-10-17" ] }, "signatories": { "type": "array", "items": {}, "description": "[{member_person_id: person_ref, signing_capacity: self | proxy | attorney | corporate_representative, signing_person_id?: person_ref}]." }, "binds_class_of_shareholders": { "type": "boolean", "description": "True if the resolution effectively binds a class of shareholders (s186).", "examples": [ "false" ] }, "requires_special_notice": { "type": "boolean", "description": "True if the Act requires special notice for this resolution.", "examples": [ "false" ] }, "lodge_with_acra": { "type": "boolean", "description": "Default true when the resolution is special or binds a class.", "examples": [ "true" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the resolution takes effect if later than the date it is passed.", "examples": [ "2026-10-20" ] }, "related_action_id": { "type": "string", "description": "The act_ id of the action this resolution authorises.", "examples": [ "act_2Rw8nKc5" ] }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref[] attached to the minute-book entry." } }, "required": [ "passed_by", "resolution_kind", "subject", "title", "resolution_text", "signatories" ], "description": "Passes an ordinary or special resolution of members without a meeting. A private company or unlisted public company circulates a written resolution under Companies Act ss184A-184F and members agree by signature, by a permitted proxy, or by." }, "Create_sg_members_resolution_record": { "type": "object", "properties": { "type": { "const": "sg.members_resolution.record" }, "params": { "$ref": "#/components/schemas/Params_sg_members_resolution_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a members' written resolution or sole-member resolution", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' written resolution", "source": "generated", "required": true }, { "key": "corporate_representative_authorisation", "title": "Corporate member's authorisation of its representative (s179)", "source": "uploaded", "required": false }, { "key": "power_of_attorney", "title": "Power of attorney", "source": "uploaded", "required": false }, { "key": "supporting_documents", "title": "Supporting documents", "source": "uploaded", "required": false }, { "key": "minute_book_entry", "title": "Minute book entry", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "identity" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "proxy", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "power_of_attorney", "signer_role": "lawyer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "minute_book_entry", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None for the resolution itself", "form": "Minute book entry", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_available", "type": null, "when": "The company is a listed public company." }, { "code": "written_resolution_excluded", "type": null, "when": "subject is dispense_with_agm or remove_director_or_auditor, or requires_special_notice is true, and passed_by is written_resolution (s184A)." }, { "code": "sole_member_mismatch", "type": null, "when": "passed_by is sole_member_record but the register shows more than one member." }, { "code": "proxy_signature_not_permitted", "type": null, "when": "A signatory signs as proxy or agent but the constitution does not allow it for written resolutions." }, { "code": "threshold_not_reached", "type": null, "when": "The signature requests were closed or expired before the required voting rights agreed." }, { "code": "mandate_scope_exceeded", "type": null, "when": "An agent key tried to sign outside its mandate's signing authority." } ] } }, "Params_sg_ordinary_resolution_file": { "type": "object", "properties": { "legal_basis": { "type": "string", "enum": [ "s186_class_binding", "other_provision" ], "description": "Why this ordinary resolution is lodged. s186_class_binding: it effectively binds a class of shareholders. other_provision: another provision of the Act or.", "examples": [ "s186_class_binding" ] }, "other_provision_reference": { "type": "string", "description": "Required when legal_basis is other_provision." }, "passed_by": { "type": "string", "enum": [ "general_meeting", "written_resolution", "sole_member_record" ], "description": "How the resolution was passed.", "examples": [ "general_meeting" ] }, "passed_on": { "type": "string", "format": "date", "description": "Date of the meeting or of passing.", "examples": [ "2026-10-14" ] }, "nature_of_resolution": { "type": "string", "description": "The 'Nature of ordinary resolution' option in Bizfile.", "examples": [ "Resolution binding a class of shareholders" ] }, "description": { "type": "string", "description": "Description of the resolution, as entered in Bizfile.", "examples": [ "Ordinary resolution of the holders of Class A shares approving a variation of dividend entitlements" ] }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "The signed resolution as a PDF.", "examples": [ "doc_9Lc2xTn4" ] }, "holding_company_minutes": { "type": "object", "description": "{signed_on: date, document_id: document_ref}.", "examples": [ "{\"signed_on\":\"2026-10-14\",\"document_id\":\"doc_5Pd8wKs3\"}" ] }, "source_action_id": { "type": "string", "description": "The act_ id of the action that recorded the resolution.", "examples": [ "act_5Jt2vXa6" ] }, "late_lodgement_acknowledged": { "type": "boolean", "description": "Required and true if the deadline has passed.", "examples": [ "false" ] } }, "required": [ "legal_basis", "passed_by", "passed_on", "description", "resolution_document_id" ], "description": "Lodges a copy of an ordinary resolution through the Bizfile Notice of Resolution eService. An ordinary resolution is lodged only if a provision of the law requires it, most commonly because it effectively binds a class of shareholders." }, "Create_sg_ordinary_resolution_file": { "type": "object", "properties": { "type": { "const": "sg.ordinary_resolution.file" }, "params": { "$ref": "#/components/schemas/Params_sg_ordinary_resolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Lodge a notice of ordinary resolution with ACRA", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Signed ordinary resolution", "source": "uploaded", "required": true }, { "key": "holding_company_minutes", "title": "Minute signed by the holding company's representative", "source": "uploaded", "required": false }, { "key": "bizfile_declaration", "title": "Bizfile submission declaration", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "Bizfile acknowledgement and Inbox confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "bizfile_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Notice of Resolution", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_lodgement_requirement", "type": null, "when": "legal_basis is not supported by the partner's check." }, { "code": "other_provision_reference_missing", "type": null, "when": "legal_basis is other_provision and other_provision_reference is empty." }, { "code": "resolution_unsigned", "type": null, "when": "resolution_document_id is not a fully signed copy and no source_action_id is passed." }, { "code": "lodgement_overdue", "type": null, "when": "The 14-day default has passed and late_lodgement_acknowledged is not true." }, { "code": "attachment_rejected", "type": null, "when": "A PDF exceeds 5MB or cannot be made compliant with ACRA's file-name rules." } ] } }, "Params_sg_special_resolution_file": { "type": "object", "properties": { "passed_by": { "type": "string", "enum": [ "general_meeting", "written_resolution", "sole_member_record" ], "description": "How the resolution was passed.", "examples": [ "written_resolution" ] }, "passed_on": { "type": "string", "format": "date", "description": "Date of the meeting, or the date a written or sole-member resolution was passed.", "examples": [ "2026-10-17" ] }, "subject_area": { "type": "string", "enum": [ "share_capital", "winding_up_or_restructuring", "company_name", "constitution", "other" ], "description": "What the resolution is about. company_name and constitution are rejected here because the name change and constitution amendment actions lodge their own.", "examples": [ "other" ] }, "description": { "type": "string", "description": "Description of the resolution, as entered in Bizfile.", "examples": [ "Special resolution under clause 14.3 of the Constitution approving a group financing arrangement" ] }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "The signed resolution as a PDF.", "examples": [ "doc_4Ke9vXb2" ] }, "minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "Minutes of the meeting, attached for the record.", "examples": [ "doc_7Wn3tLc5" ] }, "source_action_id": { "type": "string", "description": "The act_ id of the sg.members_resolution.record or sg.meeting_minutes.record action that produced the resolution.", "examples": [ "act_3Fk8wZt1" ] }, "holding_company_minutes": { "type": "object", "description": "{signed_on: date, document_id: document_ref}.", "examples": [ "{\"signed_on\":\"2026-10-17\",\"document_id\":\"doc_2Hy6pNa8\"}" ] }, "late_lodgement_acknowledged": { "type": "boolean", "description": "Required and true if passed_on is more than 14 days ago.", "examples": [ "false" ] } }, "required": [ "passed_by", "passed_on", "subject_area", "description", "resolution_document_id" ], "description": "Lodges a copy of a special resolution with ACRA through the Bizfile Notice of Resolution eService. The company must lodge every special resolution within 14 days of passing it (Companies Act s186)." }, "Create_sg_special_resolution_file": { "type": "object", "properties": { "type": { "const": "sg.special_resolution.file" }, "params": { "$ref": "#/components/schemas/Params_sg_special_resolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Lodge a notice of special resolution with ACRA", "x-entiva": { "jurisdiction": "sg", "stage": "governance", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Signed special resolution", "source": "uploaded", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the meeting", "source": "uploaded", "required": false }, { "key": "holding_company_minutes", "title": "Minute signed by the holding company's representative", "source": "uploaded", "required": false }, { "key": "bizfile_declaration", "title": "Bizfile submission declaration", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "Bizfile acknowledgement and Inbox confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "bizfile_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Notice of Resolution", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_dedicated_action", "type": null, "when": "subject_area is company_name or constitution." }, { "code": "resolution_not_special", "type": null, "when": "The source action shows the resolution was ordinary or failed the 75% test." }, { "code": "resolution_unsigned", "type": null, "when": "resolution_document_id is not a fully signed copy and no source_action_id is passed." }, { "code": "lodgement_overdue", "type": null, "when": "passed_on is more than 14 days ago and late_lodgement_acknowledged is not true." } ] } }, "Params_sg_auditor_appoint": { "type": "object", "properties": { "auditor_type": { "type": "string", "enum": [ "public_accounting_entity", "public_accountant_individual" ], "description": "The auditor must be an ACRA-registered public accountant or public accounting entity." }, "auditor_name": { "type": "string", "description": "Registered name of the auditor." }, "acra_registration_number": { "type": "string", "description": "The auditor's number on ACRA's register of public accountants or accounting entities." }, "engagement_partner_name": { "type": "string", "description": "Engagement partner, if the auditor is a firm." }, "appointment_basis": { "type": "string", "enum": [ "first_auditor_by_directors", "appointed_at_agm", "casual_vacancy_by_directors" ], "description": "first_auditor_by_directors: s205, within 3 months of incorporation. appointed_at_agm: s205. casual_vacancy_by_directors: s205." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-10-19" ] }, "agm_date": { "type": "string", "format": "date", "description": "Required when appointment_basis is appointed_at_agm." }, "replaces_auditor_name": { "type": "string", "description": "Outgoing auditor, if any." } }, "required": [ "auditor_type", "auditor_name", "acra_registration_number", "appointment_basis", "effective_date" ], "description": "Appoints an auditor for a Singapore company or VCC and files the appointment on Bizfile. The first auditor is appointed by the directors within 3 months of incorporation, later auditors at each AGM, and casual vacancies by the directors." }, "Create_sg_auditor_appoint": { "type": "object", "properties": { "type": { "const": "sg.auditor.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_auditor_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an auditor", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointing_resolution", "title": "Directors' resolution or members' ordinary resolution at the AGM", "source": "generated", "required": true }, { "key": "auditor_consent", "title": "Auditor's consent or engagement letter", "source": "uploaded", "required": true }, { "key": "auditor_registration_check", "title": "ACRA register check of the auditor", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile auditor appointment", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "auditor", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointing_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_consent", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile appointment of auditor", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_not_registered", "type": null, "when": "" }, { "code": "agm_date_required", "type": null, "when": "[invalid_request_error] appointment_basis is appointed_at_agm and agm_date is missing." }, { "code": "audit_exempt_no_appointment_needed", "type": null, "when": "[invalid_request_error] The company qualifies for audit exemption and is not appointing voluntarily." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_auditor_withdraw": { "type": "object", "properties": { "auditor_name": { "type": "string", "description": "The auditor as recorded on ACRA's register." }, "effective_date": { "type": "string", "format": "date", "description": "Date the auditor ceased to act.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "not_reappointed", "resigned_at_agm", "resigned_with_acra_consent", "removed_by_members", "term_ended", "other" ], "description": "Why the auditor ceased." }, "resignation_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "The auditor's written notice of resignation." }, "acra_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for resigned_with_acra_consent: ACRA's consent decision." }, "general_meeting_date": { "type": "string", "format": "date", "description": "Required for removed_by_members: the meeting that passed the resolution." }, "replacement_planned": { "type": "boolean", "description": "True if a new auditor will be appointed." } }, "required": [ "auditor_name", "effective_date", "reason", "replacement_planned" ], "description": "Records that an auditor has ceased to act and notifies ACRA. A removal can only be made by a general meeting resolution on special notice, and the company must notify the Registrar immediately." }, "Create_sg_auditor_withdraw": { "type": "object", "properties": { "type": { "const": "sg.auditor.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_auditor_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw an auditor", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Auditor's notice of resignation", "source": "uploaded", "required": false }, { "key": "acra_consent", "title": "ACRA consent to resign", "source": "uploaded", "required": false }, { "key": "removal_resolution", "title": "Members' resolution removing the auditor, passed on special notice", "source": "generated", "required": false }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of auditor", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "auditor", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resignation_notice", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "removal_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "acra_consent_required", "type": null, "when": "[requirement_error] A public interest company or qualifying VCC auditor resigns before the end of its term and no ACRA consent is attached." }, { "code": "special_notice_required", "type": null, "when": "[requirement_error] reason is removed_by_members and no meeting with special notice is evidenced." }, { "code": "audit_vacancy", "type": null, "when": "[requirement_error] replacement_planned is false and the company is not audit-exempt." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_auditor_resignation_consent_request": { "type": "object", "properties": { "auditor_name": { "type": "string", "description": "The resigning auditor." }, "acra_registration_number": { "type": "string", "description": "The auditor's ACRA registration number." }, "entity_class": { "type": "string", "enum": [ "public_interest_company", "qualifying_vcc", "subsidiary_of_pic_or_qualifying_vcc" ], "description": "Why consent is needed." }, "ground": { "type": "string", "enum": [ "unable_to_perform_to_required_standard", "sole_proprietor_ill_health", "loss_of_independence", "parent_required_auditor_change", "other_circumstances" ], "description": "The ground ACRA may approve." }, "proposed_resignation_date": { "type": "string", "format": "date", "description": "Date the auditor wants to resign." }, "statement_of_reasons_document_id": { "type": "string", "pattern": "^doc_", "description": "The auditor's written statement of reasons." }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref ids of supporting evidence, such as medical certificates, evidence of lost independence, or the parent's auditor-change requirement." }, "disputes_with_management_disclosed": { "type": "boolean", "description": "Whether any disputes with management exist." }, "independence_matters_disclosure": { "type": "string", "description": "Disclosure of any matter that may undermine audit independence or integrity, such as opinion shopping or inducement." }, "company_notified_on": { "type": "string", "format": "date", "description": "Date the auditor gave the company or VCC written notice and a copy of the statement." } }, "required": [ "auditor_name", "acra_registration_number", "entity_class", "ground", "statement_of_reasons_document_id", "disputes_with_management_disclosed", "independence_matters_disclosure", "company_notified_on" ], "description": "An auditor of a public interest company, a qualifying VCC or a subsidiary of either applies to ACRA for consent to resign before the end of its appointed term. The applicant is the auditor, not the company." }, "Create_sg_auditor_resignation_consent_request": { "type": "object", "properties": { "type": { "const": "sg.auditor_resignation_consent.request" }, "params": { "$ref": "#/components/schemas/Params_sg_auditor_resignation_consent_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Auditor applies for ACRA consent to resign early", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "public_ltd_shares", "public_ltd_guarantee", "private_ltd_shares", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_of_reasons", "title": "Auditor's written statement of reasons", "source": "uploaded", "required": true }, { "key": "acra_manual_form", "title": "ACRA manual form for consent to resign as auditor of public interest companies or their subsidiaries", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Supporting evidence for the stated ground", "source": "uploaded", "required": false }, { "key": "notice_to_company", "title": "Written notice to the company with a copy of the statement", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile General lodgement", "source": "generated", "required": true }, { "key": "acra_consent_decision", "title": "ACRA's consent or refusal", "source": "registry_issued", "required": false } ], "people": [ { "role": "auditor", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "statement_of_reasons", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "acra_manual_form", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General lodgement: 'Apply for consent to resign as auditor of public interest comp", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "consent_not_required", "type": null, "when": "[invalid_request_error] The entity is not a public interest company, qualifying VCC or their subsidiary, or the auditor is resigning at an AGM." }, { "code": "statement_of_reasons_missing", "type": null, "when": "[requirement_error] No statement of reasons is attached." }, { "code": "consent_refused", "type": null, "when": "[registry_error] ACRA refuses consent." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_business_details_change": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "One or more of: business_name, business_activity, registered_office_address.", "examples": [ "[{\"field\":\"business_activity\",\"new_value\":\"Retail of consumer electronics\"}]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect.", "examples": [ "2026-10-14" ] }, "approved_name_reference": { "type": "string", "description": "Required for business_name: the reference of the approved name application." }, "other_owners_informed": { "type": "boolean", "description": "The other owners have been told before the filing, as ACRA asks." } }, "required": [ "changes", "effective_date", "other_owners_informed" ], "description": "Updates a registered sole proprietorship or general partnership's business name, business activity or registered office address on Bizfile within 14 days. A name change follows ACRA's separate business-name procedure first, then the entity." }, "Create_sg_business_details_change": { "type": "object", "properties": { "type": { "const": "sg.business_details.change" }, "params": { "$ref": "#/components/schemas/Params_sg_business_details_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Sole proprietorship or partnership: change the business name, activity or address", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "owners_consent", "title": "Owners' or partners' consent to the change", "source": "generated", "required": true }, { "key": "address_evidence", "title": "Evidence for the new address", "source": "uploaded", "required": false }, { "key": "name_approval", "title": "ACRA name approval", "source": "registry_issued", "required": false }, { "key": "bizfile_filing", "title": "Bizfile 'Update entity information'", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "owners_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update entity information'", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_not_approved", "type": null, "when": "[requirement_error] changes includes business_name and no approved name reference is supplied." }, { "code": "address_not_acceptable", "type": null, "when": "[requirement_error] The registered office address cannot be a P.O." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_business_position_holder_appoint": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "owner", "partner", "nominee_or_trustee", "authorised_representative" ], "description": "The position being filled." }, "person": { "type": "string", "pattern": "^per_", "description": "The incoming holder: an individual, or a corporation acting as owner or partner." }, "effective_date": { "type": "string", "format": "date", "description": "Date the holder joins.", "examples": [ "2026-10-19" ] }, "medisave_cleared": { "type": "boolean", "description": "The incoming owner or partner confirms outstanding MediSave liabilities to the CPF Board are cleared." }, "beneficiary": { "type": "object", "description": "Required for nominee_or_trustee: {type: individual | corporate | class_of_children, person_id, relationship}." }, "all_owners_overseas": { "type": "boolean", "description": "True if every owner or partner lives overseas, which makes an authorised representative compulsory." }, "other_owners_informed": { "type": "boolean", "description": "The existing owners have been told before the filing, as ACRA asks." } }, "required": [ "position", "person", "effective_date", "medisave_cleared", "other_owners_informed" ], "description": "Adds an owner, partner, nominee or trustee, or authorised representative to a registered sole proprietorship or general partnership. Changes are due within 14 days." }, "Create_sg_business_position_holder_appoint": { "type": "object", "properties": { "type": { "const": "sg.business_position_holder.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_business_position_holder_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Sole proprietorship or partnership: appoint an owner, partner or authorised representative", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "holder_consent", "title": "Incoming holder's consent", "source": "generated", "required": true }, { "key": "owners_agreement", "title": "Existing owners' or partners' agreement to the change", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "holder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "owners_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "partner_limit_exceeded", "type": null, "when": "[requirement_error] A general partnership would exceed 20 partners." }, { "code": "sole_owner_replacement_unsupported", "type": null, "when": "[requirement_error] The action would replace the sole owner of a sole proprietorship." }, { "code": "authorised_representative_required", "type": null, "when": "[requirement_error] All owners are overseas and no resident authorised representative is in place." }, { "code": "medisave_not_cleared", "type": null, "when": "[requirement_error] medisave_cleared is false for an owner or partner." }, { "code": "owner_not_eligible", "type": null, "when": "[requirement_error] The incoming owner is an undischarged bankrupt without permission (Business Names Registration Act s34)." } ] } }, "Params_sg_business_position_holder_withdraw": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "owner", "partner", "nominee_or_trustee", "authorised_representative" ], "description": "The position being ended." }, "person": { "type": "string", "pattern": "^per_", "description": "The departing holder." }, "effective_date": { "type": "string", "format": "date", "description": "Date the holder left.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "retirement", "resignation", "death", "dissolution_of_interest", "stopped_being_qualified", "other" ], "description": "Why the holder left." }, "replacement_authorised_representative": { "type": "string", "pattern": "^per_", "description": "Needed when the departing holder is the sole authorised representative of a business whose owners all live overseas." }, "notice_document_id": { "type": "string", "pattern": "^doc_", "description": "The holder's written notice of departure, if any." } }, "required": [ "position", "person", "effective_date", "reason" ], "description": "Withdraws an owner, partner, nominee or trustee, or authorised representative of a registered sole proprietorship or general partnership and files the change on Bizfile within 14 days. The departing partner and the continuing partners must." }, "Create_sg_business_position_holder_withdraw": { "type": "object", "properties": { "type": { "const": "sg.business_position_holder.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_business_position_holder_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Sole proprietorship or partnership: withdraw an owner, partner or authorised representative", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "departure_notice", "title": "Departing holder's notice", "source": "uploaded", "required": false }, { "key": "owners_agreement", "title": "Continuing owners' or partners' acknowledgement", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "departure_notice", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "owners_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "cannot_withdraw_last_owner", "type": null, "when": "[requirement_error] The holder is the last owner or partner." }, { "code": "authorised_representative_required", "type": null, "when": "[requirement_error] All owners are overseas and no replacement authorised representative is given." }, { "code": "partner_minimum_not_met", "type": null, "when": "[requirement_error] A general partnership would drop below 2 partners." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_ceo_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The incoming CEO, created with POST /v1/people." }, "effective_date": { "type": "string", "format": "date", "description": "Appointment date.", "examples": [ "2026-10-19" ] }, "is_also_director": { "type": "boolean", "description": "True if the CEO is also on the board." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing CEO." } }, "required": [ "person", "effective_date" ], "description": "Appoints a CEO, an optional position. If a company appoints one, ACRA requires the CEO's details to be filed." }, "Create_sg_ceo_appoint": { "type": "object", "properties": { "type": { "const": "sg.ceo.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_ceo_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a chief executive officer", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointing_resolution", "title": "Directors' resolution appointing the CEO", "source": "generated", "required": true }, { "key": "ceo_acceptance", "title": "CEO's acceptance of appointment", "source": "generated", "required": false }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointing_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ceo_acceptance", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity is a VCC or another type outside applies_to." }, { "code": "verification_required", "type": null, "when": "[requirement_error] The CEO has no identity_address verification." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] A screening alert on the CEO is being reviewed." } ] } }, "Params_sg_ceo_withdraw": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The departing CEO." }, "effective_date": { "type": "string", "format": "date", "description": "Date the CEO ceased to hold the position.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "resignation", "removal", "death", "term_ended", "other" ], "description": "Why the CEO ceased." }, "resignation_letter_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when reason is resignation." } }, "required": [ "person", "effective_date", "reason" ], "description": "Records a CEO's resignation, removal or death and withdraws the CEO on Bizfile within 14 days. If the CEO was entered in the register of registrable controllers as the fallback entry, Entiva chains the register update." }, "Create_sg_ceo_withdraw": { "type": "object", "properties": { "type": { "const": "sg.ceo.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_ceo_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a chief executive officer", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "CEO's resignation letter", "source": "uploaded", "required": false }, { "key": "withdrawal_resolution", "title": "Directors' resolution accepting the resignation or removing the CEO", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "withdrawal_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "person_not_ceo", "type": null, "when": "[invalid_request_error] The person is not recorded as the entity's CEO." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_director_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The incoming director, created with POST /v1/people." }, "effective_date": { "type": "string", "format": "date", "description": "Appointment date.", "examples": [ "2026-10-19" ] }, "designation": { "type": "string", "enum": [ "director", "alternate_director" ], "description": "director or alternate_director." }, "principal_director": { "type": "string", "pattern": "^per_", "description": "Required for alternate_director: the director the alternate stands in for." }, "appointed_by": { "type": "string", "enum": [ "board", "members" ], "description": "Who makes the appointment under the constitution." }, "consent_form": { "type": "string", "enum": [ "form_45", "form_45a" ], "description": "form_45, or form_45a when leave of court and/or the Official Assignee's written consent is involved." }, "residency_basis": { "type": "string", "enum": [ "singapore_citizen", "permanent_resident", "employment_pass", "personalised_employment_pass", "one_pass", "entrepass", "other_fin_holder", "non_resident" ], "description": "Basis for Singapore residency." }, "pass_issuer_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for FIN holders: consent from the pass-issuing authority." }, "vcc_director_role": { "type": "string", "enum": [ "resident_director", "fund_manager_director", "qualified_representative", "independent_director" ], "description": "VCC only." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing director." }, "is_nominee": { "type": "boolean", "description": "If true the API returns nominee_use_dedicated_action." } }, "required": [ "person", "effective_date", "designation", "appointed_by", "consent_form", "residency_basis" ], "description": "Appoints a director or alternate director to a Singapore company or VCC. The incoming director signs Form 45 personally, the board or members approve, and Entiva's registered CSP files on Bizfile within 14 days, so no Singpass." }, "Create_sg_director_appoint": { "type": "object", "properties": { "type": { "const": "sg.director.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "consent_form", "title": "Consent to act as director and statement of non-disqualification", "source": "generated", "required": true }, { "key": "appointing_resolution", "title": "Directors' resolution or members' ordinary resolution appointing the director", "source": "generated", "required": true }, { "key": "pass_issuer_consent", "title": "MOM or ICA consent for a FIN or Employment Pass holder", "source": "uploaded", "required": false }, { "key": "alternate_appointment", "title": "Board approval of the alternate director and instrument from the principal director", "source": "generated", "required": false }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "consent_form", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "appointing_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "appointing_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders' with Form 45 kept under s173C", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_not_eligible", "type": null, "when": "[requirement_error] Under 18, lacking capacity, disqualified or an undischarged bankrupt without leave." }, { "code": "pass_issuer_consent_required", "type": null, "when": "[requirement_error] The person holds a FIN or Employment Pass and no pass-issuer consent is attached." }, { "code": "principal_director_required", "type": null, "when": "[invalid_request_error] designation is alternate_director and principal_director_id is missing." }, { "code": "nominee_use_dedicated_action", "type": null, "when": "[invalid_request_error] is_nominee is true." }, { "code": "use_foreign_company_action", "type": null, "when": "[jurisdiction_error] The entity is a foreign company branch." }, { "code": "verification_required", "type": null, "when": "[requirement_error] The incoming director has no identity_address verification." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] A screening alert on the incoming director is being reviewed." } ] } }, "Params_sg_director_change": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The director whose particulars changed." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect.", "examples": [ "2026-10-14" ] }, "changes": { "type": "object", "description": "The new values." }, "deed_poll_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when changes.name is present." }, "supporting_document_id": { "type": "string", "pattern": "^doc_", "description": "New passport or pass for an ID or nationality change." } }, "required": [ "person", "effective_date", "changes" ], "description": "Updates a director's name, ID, nationality, addresses, contact number or email on Bizfile within 14 days. Singapore citizens and PRs report name, ID, nationality and residential address changes to ICA, which passes them to ACRA." }, "Create_sg_director_change": { "type": "object", "properties": { "type": { "const": "sg.director.change" }, "params": { "$ref": "#/components/schemas/Params_sg_director_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a director's particulars", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deed_poll", "title": "Deed poll for the name change", "source": "uploaded", "required": false }, { "key": "id_evidence", "title": "New passport or pass", "source": "uploaded", "required": false }, { "key": "particulars_confirmation", "title": "Director's confirmation of the new particulars", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile 'Update position holder information'", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "deed_poll", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "particulars_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update position holder information'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deed_poll_required", "type": null, "when": "[requirement_error] changes.name is present with no deed poll." }, { "code": "no_filing_required", "type": null, "when": "[invalid_request_error] Only ICA-synced fields changed for a citizen or PR." }, { "code": "contact_address_invalid", "type": null, "when": "[invalid_request_error] The contact address is a P.O." }, { "code": "use_foreign_company_action", "type": null, "when": "[jurisdiction_error] The entity is a foreign company branch." } ] } }, "Params_sg_director_withdraw": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The departing director." }, "designation": { "type": "string", "enum": [ "director", "alternate_director" ], "description": "The position being withdrawn." }, "effective_date": { "type": "string", "format": "date", "description": "Date the person ceased to hold office.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "resignation", "removal_by_members", "death", "disqualification", "bankruptcy", "term_ended", "other" ], "description": "Why the director ceased." }, "reason_detail": { "type": "string", "description": "Free-text detail, required when reason is other." }, "resignation_letter_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when reason is resignation." }, "supporting_document_id": { "type": "string", "pattern": "^doc_", "description": "Court order, bankruptcy statement or death certificate for the other reasons." }, "replacement_director": { "type": "string", "pattern": "^per_", "description": "Required when the departing director is the only resident director." } }, "required": [ "person", "designation", "effective_date", "reason" ], "description": "Records a director's resignation, removal, disqualification or death and withdraws the director on Bizfile within 14 days. Officers cannot withdraw themselves on Bizfile, so Entiva's CSP files." }, "Create_sg_director_withdraw": { "type": "object", "properties": { "type": { "const": "sg.director.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_director_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a director", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Director's resignation letter", "source": "uploaded", "required": false }, { "key": "withdrawal_resolution", "title": "Board acknowledgement of the resignation, or members' resolution removing the director", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Court order, bankruptcy statement or death certificate", "source": "uploaded", "required": false }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "withdrawal_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_resident_director", "type": null, "when": "[requirement_error] The withdrawal would leave no director ordinarily resident in Singapore." }, { "code": "last_director", "type": null, "when": "[requirement_error] The withdrawal would leave the company with no director." }, { "code": "special_notice_required", "type": null, "when": "[requirement_error] reason is removal_by_members and no meeting with special notice is evidenced." }, { "code": "use_foreign_company_action", "type": null, "when": "[jurisdiction_error] The entity is a foreign company branch." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_foreign_company_position_holder_appoint": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "director", "authorised_representative" ], "description": "The position being filled." }, "person": { "type": "string", "pattern": "^per_", "description": "The incoming director or authorised representative." }, "effective_date": { "type": "string", "format": "date", "description": "Appointment date.", "examples": [ "2026-10-19" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "The outgoing holder." }, "residency_basis": { "type": "string", "enum": [ "singapore_citizen", "permanent_resident", "employment_pass", "personalised_employment_pass", "one_pass", "entrepass", "other" ], "description": "Required for authorised_representative: how the person meets local residency requirements." }, "foreign_company_resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "The foreign company's board resolution or equivalent appointing the director or authorising the representative." } }, "required": [ "position", "person", "effective_date", "foreign_company_resolution_document_id" ], "description": "Notifies ACRA of a new director or authorised representative of a foreign company's registered Singapore branch. Foreign position holders can be appointed only through a CSP, so Entiva files." }, "Create_sg_foreign_company_position_holder_appoint": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_position_holder.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_position_holder_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Foreign company: appoint a director or authorised representative", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_company_resolution", "title": "Foreign company resolution appointing the position holder", "source": "uploaded", "required": true }, { "key": "consent_to_act", "title": "Position holder's consent to act", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "foreign_company_resolution", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorised_representative_not_resident", "type": null, "when": "[requirement_error] The representative does not meet local residency requirements." }, { "code": "residency_basis_required", "type": null, "when": "[invalid_request_error] position is authorised_representative and residency_basis is missing." }, { "code": "translation_required", "type": null, "when": "[requirement_error] The resolution is not in English and no certified translation is attached." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity is not a foreign company branch." } ] } }, "Params_sg_foreign_company_position_holder_withdraw": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "director", "authorised_representative" ], "description": "The position being ended." }, "person": { "type": "string", "pattern": "^per_", "description": "The departing holder." }, "effective_date": { "type": "string", "format": "date", "description": "Date the holder ceased.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "resignation", "removal", "death", "disqualification", "other" ], "description": "Why the holder ceased." }, "replacement_authorised_representative": { "type": "string", "pattern": "^per_", "description": "Required when withdrawing the branch's only authorised representative." }, "foreign_company_resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "The foreign company's resolution or the holder's resignation notice." } }, "required": [ "position", "person", "effective_date", "reason" ], "description": "Notifies ACRA that a director or authorised representative of a foreign company's Singapore branch has ceased, within 30 days. The branch must keep one authorised representative, so Entiva requires a replacement when the sole." }, "Create_sg_foreign_company_position_holder_withdraw": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_position_holder.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_position_holder_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Foreign company: withdraw a director or authorised representative", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cessation_evidence", "title": "Resignation notice or foreign company resolution", "source": "uploaded", "required": false }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cessation_evidence", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorised_representative_required", "type": null, "when": "[requirement_error] The withdrawal would leave the branch with no authorised representative and no replacement is given." }, { "code": "translation_required", "type": null, "when": "[requirement_error] The evidence is not in English and no certified translation is attached." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity is not a foreign company branch." } ] } }, "Params_sg_manager_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The incoming manager." }, "effective_date": { "type": "string", "format": "date", "description": "Appointment date.", "examples": [ "2026-10-19" ] }, "manager_type": { "type": "string", "enum": [ "llp_manager", "lp_local_manager" ], "description": "llp_manager or lp_local_manager." }, "ordinarily_resident_in_singapore": { "type": "boolean", "description": "Whether the manager is ordinarily resident in Singapore." }, "medisave_cleared": { "type": "boolean", "description": "Confirmation for the position." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing manager." } }, "required": [ "person", "effective_date", "manager_type", "ordinarily_resident_in_singapore" ], "description": "Appoints an LLP manager or a limited partnership's manager. An LLP needs at least one manager who is a natural person aged 18 or over and ordinarily resident in Singapore." }, "Create_sg_manager_appoint": { "type": "object", "properties": { "type": { "const": "sg.manager.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_manager_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a manager of an LLP or limited partnership", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "llp", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "manager_consent", "title": "Manager's consent to act", "source": "generated", "required": true }, { "key": "partners_resolution", "title": "Partners' resolution appointing the manager", "source": "generated", "required": true }, { "key": "residency_evidence", "title": "Evidence of residency in Singapore", "source": "uploaded", "required": false }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "manager_consent", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "partners_resolution", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "manager_not_resident", "type": null, "when": "[requirement_error] An LLP has no manager who is a natural person aged 18 or over and ordinarily resident in Singapore after this appointment." }, { "code": "limited_partner_role_conflict", "type": null, "when": "[requirement_error] The person is a limited partner of the same LP." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_manager_withdraw": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The departing manager." }, "manager_type": { "type": "string", "enum": [ "llp_manager", "lp_local_manager" ], "description": "The role ended." }, "effective_date": { "type": "string", "format": "date", "description": "Date the manager ceased.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "resignation", "removal", "death", "other" ], "description": "Why the manager ceased." }, "replacement_manager": { "type": "string", "pattern": "^per_", "description": "Required when the departing manager is the only resident manager or the LP's required local manager." } }, "required": [ "person", "manager_type", "effective_date", "reason" ], "description": "Withdraws an LLP manager or LP manager and files the change on Bizfile within 14 days. Entiva blocks a withdrawal that would leave an LLP without a manager ordinarily resident in Singapore, and asks for a replacement local manager where." }, "Create_sg_manager_withdraw": { "type": "object", "properties": { "type": { "const": "sg.manager.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_manager_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a manager of an LLP or limited partnership", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "llp", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Manager's resignation letter", "source": "uploaded", "required": false }, { "key": "partners_resolution", "title": "Partners' acknowledgement or removal resolution", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "manager", "verification_level": "none" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_resident_manager", "type": null, "when": "[requirement_error] The withdrawal would leave an LLP with no manager ordinarily resident in Singapore." }, { "code": "local_manager_required", "type": null, "when": "[requirement_error] The LP needs a local manager and no replacement is given (Limited Partnerships Act s28)." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_nominee_director_appoint": { "type": "object", "properties": { "nominee_type": { "type": "string", "enum": [ "partner_provided", "customer_nominated" ], "description": "partner_provided: Entiva CSP arranges an individual by way of business. customer_nominated: the customer supplies the individual." }, "person": { "type": "string", "pattern": "^per_", "description": "The nominee or resident director." }, "effective_date": { "type": "string", "format": "date", "description": "Appointment date.", "examples": [ "2026-10-19" ] }, "resident_director_purpose": { "type": "boolean", "description": "True when the appointment is made to satisfy the requirement for at least one director ordinarily resident in Singapore (s145)." }, "is_nominee": { "type": "boolean", "description": "True when the director acts on another person's behalf." }, "nominators": { "type": "array", "items": {}, "description": "person_ref ids of each nominator." }, "date_became_nominee": { "type": "string", "format": "date", "description": "Date the director became a nominee." }, "vcc_director_role": { "type": "string", "enum": [ "resident_director", "fund_manager_director", "qualified_representative", "independent_director" ], "description": "VCC only: the capacity in which the director sits." }, "replaces": { "type": "string", "pattern": "^per_", "description": "The outgoing director this appointment replaces." } }, "required": [ "nominee_type", "effective_date", "resident_director_purpose", "is_nominee" ], "description": "Appoints a director who satisfies the resident-director rule (s145) or who acts for a nominator. Entiva's Entiva CSP either supplies the individual or arranges the customer's own, runs the fit-and-proper assessment, collects the." }, "Create_sg_nominee_director_appoint": { "type": "object", "properties": { "type": { "const": "sg.nominee_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_nominee_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a locally resident or nominee director", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_45", "title": "Consent to act as director and statement of non-disqualification", "source": "generated", "required": true }, { "key": "nominee_disclosure", "title": "Nominee's disclosure of nominee status and nominator particulars to the company", "source": "generated", "required": false }, { "key": "nomination_agreement", "title": "Nomination agreement between nominee and nominator", "source": "uploaded", "required": false }, { "key": "fit_and_proper_assessment", "title": "Fit-and-proper assessment with bankruptcy and disqualification searches", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution appointing the director", "source": "generated", "required": true }, { "key": "rond_entry", "title": "Updated register of nominee directors entry", "source": "generated", "required": false }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction and Central ROND lodgement", "source": "generated", "required": true } ], "people": [ { "role": "nominee", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "form_45", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nominee_disclosure", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nomination_agreement", "signer_role": "nominator", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile appointment of director with Form 45 consent, then ROND update and Central ROND lo", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "fit_and_proper_failed", "type": null, "when": "[requirement_error] The partner's assessment finds the individual not fit and proper." }, { "code": "nominator_required", "type": null, "when": "[invalid_request_error] is_nominee is true and nominator_ids is empty." }, { "code": "csp_arrangement_required", "type": null, "when": "[requirement_error] A person acting as a nominee by way of business is not arranged through a registered CSP." }, { "code": "capacity_review_required", "type": null, "when": "[requirement_error] The individual already holds more than 50 nominee directorships, which triggers a capacity assessment." }, { "code": "vcc_director_role_missing", "type": null, "when": "[invalid_request_error] The entity is a VCC and vcc_director_role is missing." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] A screening alert on the nominee or a nominator is being reviewed." } ] } }, "Params_sg_partner_appoint": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "llp_partner", "general_partner", "general_partner_nominee_or_trustee", "limited_partner" ], "description": "The role being filled." }, "person": { "type": "string", "pattern": "^per_", "description": "The incoming partner: an individual, or a legal entity for an LLP partner." }, "effective_date": { "type": "string", "format": "date", "description": "Date the partner joins.", "examples": [ "2026-10-19" ] }, "medisave_cleared": { "type": "boolean", "description": "The incoming partner confirms any outstanding MediSave liability to the CPF Board is cleared." }, "beneficiary": { "type": "object", "description": "Required for general_partner_nominee_or_trustee: {type: individual | corporate | class_of_children, person_id, relationship}." }, "capital_contribution": { "$ref": "#/components/schemas/Money", "description": "Entiva records this for CDD and ownership." }, "profit_share_percentage": { "type": "number", "description": "Entiva records this for CDD." } }, "required": [ "position", "person", "effective_date", "medisave_cleared" ], "description": "Adds a partner to an LLP or a general partner, nominee or trustee general partner, or limited partner to a limited partnership. The LLP or the general partner must lodge the change within 14 days, and Entiva's CSP files it." }, "Create_sg_partner_appoint": { "type": "object", "properties": { "type": { "const": "sg.partner.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_partner_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a partner of an LLP or limited partnership", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "llp", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partner_consent", "title": "Incoming partner's consent and accession", "source": "generated", "required": true }, { "key": "partners_resolution", "title": "Partners' approval of the new partner", "source": "generated", "required": true }, { "key": "corporate_partner_documents", "title": "Corporate partner's certificate, register of directors and ownership chart", "source": "uploaded", "required": false }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partner_consent", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "partners_resolution", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "foreign_entity_cannot_be_general_partner", "type": null, "when": "[requirement_error] position is general_partner or general_partner_nominee_or_trustee and person_id is a foreign entity." }, { "code": "limited_partner_role_conflict", "type": null, "when": "[requirement_error] The incoming limited partner is already a general partner or manager of the same LP." }, { "code": "medisave_not_cleared", "type": null, "when": "[requirement_error] medisave_cleared is false." }, { "code": "beneficiary_required", "type": null, "when": "[invalid_request_error] position is general_partner_nominee_or_trustee and beneficiary is missing." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_partner_withdraw": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The departing partner." }, "position": { "type": "string", "enum": [ "llp_partner", "general_partner", "general_partner_nominee_or_trustee", "limited_partner" ], "description": "The role being ended." }, "effective_date": { "type": "string", "format": "date", "description": "Date the partner ceased.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "retirement", "expulsion", "death", "insolvency", "assignment_of_interest", "other" ], "description": "Why the partner left." }, "retirement_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "The partner's written notice, where one exists." }, "replacement_partner": { "type": "string", "pattern": "^per_", "description": "Needed when the withdrawal would take the entity below its minimum partners." } }, "required": [ "person", "position", "effective_date", "reason" ], "description": "Withdraws a partner who retires, is expelled, dies or becomes insolvent, and files the change on Bizfile within 14 days. Entiva checks the minimums first: an LLP keeps at least two partners and a limited partnership keeps at least one." }, "Create_sg_partner_withdraw": { "type": "object", "properties": { "type": { "const": "sg.partner.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_partner_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a partner of an LLP or limited partnership", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "llp", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "retirement_notice", "title": "Departing partner's notice or evidence of cessation", "source": "uploaded", "required": false }, { "key": "partners_resolution", "title": "Continuing partners' acknowledgement", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "none" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "retirement_notice", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "below_minimum_partners", "type": null, "when": "[requirement_error] An LLP would drop below 2 partners, or an LP would have no general partner or no limited partner." }, { "code": "last_resident_manager", "type": null, "when": "[requirement_error] The departing partner is also the only manager ordinarily resident in Singapore." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_position_holder_cease": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The departing individual, who is the person instructing this action." }, "position": { "type": "string", "enum": [ "director", "secretary" ], "description": "ACRA's page is written for directors and gives a company secretary as its only other example." }, "reason": { "type": "string", "enum": [ "resignation", "disqualification" ], "description": "resignation or disqualification." }, "effective_date": { "type": "string", "format": "date", "description": "Date of resignation or disqualification.", "examples": [ "2026-09-20" ] }, "company_failed_to_notify": { "type": "boolean", "description": "The individual declares the company did not withdraw them within 14 days, or that no other officer can file." }, "resignation_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for resignation: the resignation notice given to the company." }, "board_acknowledgement_document_id": { "type": "string", "pattern": "^doc_", "description": "For resignation: the board's acknowledgement, or the receipt of the registered article, as ACRA asks." }, "court_order_document_id": { "type": "string", "pattern": "^doc_", "description": "For disqualification: the court order or other supporting document." }, "bankruptcy_statement_document_id": { "type": "string", "pattern": "^doc_", "description": "For disqualification by bankruptcy, where applicable." }, "written_notice_to_company_date": { "type": "string", "format": "date", "description": "For disqualification: the date the director first gave the company written notice, which ACRA requires." } }, "required": [ "person", "position", "reason", "effective_date", "company_failed_to_notify" ], "description": "A director who has resigned or been disqualified files their own Notice of Cessation with ACRA when the company has not withdrawn them within 14 days. Entiva prepares the notice and evidence and files it through its CSP for the." }, "Create_sg_position_holder_cease": { "type": "object", "properties": { "type": { "const": "sg.position_holder.cease" }, "params": { "$ref": "#/components/schemas/Params_sg_position_holder_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Director files their own Notice of Cessation", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Resignation notice given to the company", "source": "uploaded", "required": false }, { "key": "board_acknowledgement", "title": "Board acknowledgement or receipt of the registered article", "source": "uploaded", "required": false }, { "key": "disqualification_evidence", "title": "Court order, bankruptcy statement or other supporting document", "source": "uploaded", "required": false }, { "key": "cessation_declaration", "title": "Individual's declaration that the company failed to notify", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile Notice of Cessation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "cessation_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile Notice of Cessation", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_already_notified", "type": null, "when": "[invalid_request_error] ACRA's record already shows the cessation." }, { "code": "evidence_missing", "type": null, "when": "[requirement_error] No resignation notice with board acknowledgement, or no court order, for the stated reason." }, { "code": "position_not_supported", "type": null, "when": "[invalid_request_error] The position is a CEO or auditor, which ACRA's page does not cover." }, { "code": "entity_not_in_account", "type": null, "when": "[invalid_request_error] The entity_id is not in the caller's account." } ] } }, "Params_sg_position_holder_change": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "secretary", "ceo", "llp_partner", "llp_manager", "general_partner", "limited_partner", "lp_manager", "owner", "authorised_representative", "foreign_company_director", "foreign_company_authorised_representative" ], "description": "The position held by the person." }, "person": { "type": "string", "pattern": "^per_", "description": "The position holder whose particulars changed." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect.", "examples": [ "2026-10-14" ] }, "changes": { "type": "object", "description": "The new values." }, "deed_poll_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when changes.name is present." }, "supporting_document_id": { "type": "string", "pattern": "^doc_", "description": "New passport or pass for an ID or nationality change." } }, "required": [ "position", "person", "effective_date", "changes" ], "description": "Updates the particulars of any position holder other than a director of a local company: secretary, CEO, LLP or LP partner or manager, sole proprietorship or partnership owner, authorised representative, and the directors and authorised." }, "Create_sg_position_holder_change": { "type": "object", "properties": { "type": { "const": "sg.position_holder.change" }, "params": { "$ref": "#/components/schemas/Params_sg_position_holder_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a position holder's particulars", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deed_poll", "title": "Deed poll for the name change", "source": "uploaded", "required": false }, { "key": "id_evidence", "title": "New passport or pass", "source": "uploaded", "required": false }, { "key": "particulars_confirmation", "title": "Position holder's confirmation of the new particulars", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile 'Update position holder information'", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "deed_poll", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "particulars_confirmation", "signer_role": "shareholder", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update position holder information'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deed_poll_required", "type": null, "when": "[requirement_error] changes.name is present with no deed poll." }, { "code": "no_filing_required", "type": null, "when": "[invalid_request_error] Only ICA-synced fields changed for a citizen or PR." }, { "code": "position_not_held", "type": null, "when": "[invalid_request_error] The person does not hold the stated position on this entity." }, { "code": "use_director_action", "type": null, "when": "[invalid_request_error] The person is a director of a local company or VCC." } ] } }, "Params_sg_qualified_secretary_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The incoming secretary." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-10-19" ] }, "appointment_reason": { "type": "string", "enum": [ "first_secretary", "replacement", "additional_secretary", "vacancy_fill" ], "description": "Why the appointment is made." }, "replaces": { "type": "string", "pattern": "^per_", "description": "The outgoing secretary." }, "qualification_basis": { "type": "string", "enum": [ "held_office_15_may_1987_to_15_may_2003", "prescribed_requirements" ], "description": "Which limb of s171 the secretary meets: in office on 15 May 1987 and still in office on 15 May 2003, or the prescribed experience, professional or academic." }, "qualification_summary": { "type": "string", "description": "Short statement of the experience, qualifications and professional memberships relied on." }, "secretary_source": { "type": "string", "enum": [ "customer_nominated", "entiva_partner_provided" ], "description": "customer_nominated or entiva_partner_provided." } }, "required": [ "person", "effective_date", "appointment_reason", "qualification_basis", "qualification_summary", "secretary_source" ], "description": "Appoints a secretary for a public company. On top of the ordinary secretary rules, the directors must take reasonable steps to ensure the secretary meets the s171 qualification test." }, "Create_sg_qualified_secretary_appoint": { "type": "object", "properties": { "type": { "const": "sg.qualified_secretary.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_qualified_secretary_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a qualified secretary for a public company", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_45b", "title": "Consent to act as secretary", "source": "generated", "required": true }, { "key": "secretary_qualification_evidence", "title": "Evidence of s171 qualification", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution appointing the secretary and recording the qualification check", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "form_45b", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "qualification_not_established", "type": null, "when": "[requirement_error] The partner reviewer finds the evidence does not meet s171." }, { "code": "sole_director_cannot_be_secretary", "type": null, "when": "[invalid_request_error] The person is the company's sole director (s171)." }, { "code": "secretary_not_eligible", "type": null, "when": "[requirement_error] Not resident in Singapore, debarred under s155B, or not a natural person." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity is not a public company." } ] } }, "Params_sg_secretary_appoint": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The incoming secretary, created with POST /v1/people." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-10-19" ] }, "appointment_reason": { "type": "string", "enum": [ "first_secretary", "replacement", "additional_secretary" ], "description": "Why the appointment is made." }, "replaces": { "type": "string", "pattern": "^per_", "description": "The outgoing secretary when appointment_reason is replacement." }, "secretary_source": { "type": "string", "enum": [ "customer_nominated", "entiva_partner_provided" ], "description": "customer_nominated: the person in person_id. entiva_partner_provided: an employee of Entiva's Entiva CSP is assigned." } }, "required": [ "person", "effective_date", "appointment_reason", "secretary_source" ], "description": "Appoints a company secretary for a Singapore private-type company or VCC. The secretary must be a natural person whose principal or only residence is in Singapore." }, "Create_sg_secretary_appoint": { "type": "object", "properties": { "type": { "const": "sg.secretary.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_secretary_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a company secretary", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_45b", "title": "Consent to act as secretary", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution appointing the secretary", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile position-holder transaction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_45b", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "sole_director_cannot_be_secretary", "type": null, "when": "[invalid_request_error] The person is the company's sole director (s171)." }, { "code": "secretary_not_eligible", "type": null, "when": "[requirement_error] The person is not resident in Singapore, is debarred under s155B or is a company, not a natural person." }, { "code": "public_company_requires_qualified_secretary", "type": null, "when": "[jurisdiction_error] The entity is a public company." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." }, { "code": "verification_required", "type": null, "when": "[requirement_error] The secretary has no identity_address verification." } ] } }, "Params_sg_secretary_withdraw": { "type": "object", "properties": { "person": { "type": "string", "pattern": "^per_", "description": "The departing secretary." }, "effective_date": { "type": "string", "format": "date", "description": "Date the secretary ceased to hold office.", "examples": [ "2026-10-16" ] }, "reason": { "type": "string", "enum": [ "resignation", "removal", "death", "other" ], "description": "Why the secretary ceased." }, "resignation_letter_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when reason is resignation." }, "replacement_secretary": { "type": "string", "pattern": "^per_", "description": "The incoming secretary." }, "vacancy_acknowledged": { "type": "boolean", "description": "Required true when no replacement is given: the caller accepts that the office is vacant until a replacement is appointed." } }, "required": [ "person", "effective_date", "reason" ], "description": "Records a secretary's resignation or removal and withdraws the secretary on Bizfile within 14 days. The secretary's office may not be vacant for more than 6 months (s171), so Entiva asks for a replacement in the same action or schedules." }, "Create_sg_secretary_withdraw": { "type": "object", "properties": { "type": { "const": "sg.secretary.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_secretary_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a company secretary", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Secretary's resignation letter", "source": "uploaded", "required": false }, { "key": "withdrawal_resolution", "title": "Directors' resolution accepting the resignation or removing the secretary", "source": "generated", "required": true }, { "key": "bizfile_filing", "title": "Bizfile withdrawal of position holder", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Bizfile transaction acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "withdrawal_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Appoint or withdraw position holders'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "vacancy_not_acknowledged", "type": null, "when": "[requirement_error] No replacement is given and vacancy_acknowledged is not true." }, { "code": "replacement_not_eligible", "type": null, "when": "[requirement_error] The replacement is the sole director (s171) or does not live in Singapore." }, { "code": "qualified_secretary_required", "type": null, "when": "[requirement_error] The entity is a public company and the replacement is not appointed through sg.qualified_secretary.appoint." }, { "code": "entity_type_not_supported", "type": null, "when": "[invalid_request_error] The entity type is not in applies_to." } ] } }, "Params_sg_society_committee_change": { "type": "object", "properties": { "society_type": { "type": "string", "enum": [ "standard", "religious" ], "description": "Decides how many office bearers must verify: 2 of 3 for standard, 3 of 3 for religious." }, "change_type": { "type": "string", "enum": [ "resignation", "death", "removal", "replacement", "additional_member" ], "description": "Kind of mid-term change." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect.", "examples": [ "2026-10-12" ] }, "outgoing": { "type": "string", "pattern": "^per_", "description": "The member leaving the committee." }, "incoming": { "type": "string", "pattern": "^per_", "description": "The member joining." }, "office_held": { "type": "string", "enum": [ "president", "secretary", "treasurer", "committee_member", "other" ], "description": "The office affected." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting that recorded the change." }, "minutes_document_id": { "type": "string", "pattern": "^doc_", "description": "Minutes signed by the President or Secretary." }, "resignation_letter_document_id": { "type": "string", "pattern": "^doc_", "description": "Resignation letter or other supporting document." }, "citizenship_criteria_confirmed": { "type": "boolean", "description": "Confirms the incoming member meets any citizenship criteria in the society's constitution." }, "annual_returns_up_to_date": { "type": "boolean", "description": "All outstanding annual returns have been filed." } }, "required": [ "society_type", "change_type", "effective_date", "office_held", "meeting_date", "minutes_document_id", "citizenship_criteria_confirmed", "annual_returns_up_to_date" ], "description": "Prepares the Registry of Societies submission for a mid-term change to a registered society's management committee, such as a resignation or death. The office bearers must verify and submit on ROS eServices with their own Singpass: any 2." }, "Create_sg_society_committee_change": { "type": "object", "properties": { "type": { "const": "sg.society_committee.change" }, "params": { "$ref": "#/components/schemas/Params_sg_society_committee_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Society: change management committee details", "x-entiva": { "jurisdiction": "sg", "stage": "officers_and_people", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "minutes", "title": "Minutes of the meeting, signed by the President or Secretary", "source": "uploaded", "required": true }, { "key": "supporting_documents", "title": "Resignation letters or other supporting documents", "source": "uploaded", "required": false }, { "key": "submission_pack", "title": "Prepared ROS submission data and checklist", "source": "generated", "required": true }, { "key": "registry_acknowledgement", "title": "ROS acknowledgement or approval", "source": "uploaded", "required": true } ], "people": [ { "role": "officer", "verification_level": "registry_idv" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "submission_pack", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "ROS eServices: Change of Management Committee Details", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "annual_returns_outstanding", "type": null, "when": "[requirement_error] annual_returns_up_to_date is false." }, { "code": "minimum_office_bearers_unmet", "type": null, "when": "[requirement_error] The change would leave the committee without a President, Secretary or Treasurer." }, { "code": "singpass_required", "type": null, "when": "[permission_error] A key office bearer has no Singpass." }, { "code": "ros_rejected", "type": null, "when": "[registry_error] ROS rejects the submission or asks for clarification." } ] } }, "Params_sg_charge_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "description": "Entity type; VCCs and sub-funds file through VCC eServices." }, "chargee": { "type": "string", "pattern": "^per_", "description": "A verified person" }, "charge_type": { "type": "string", "enum": [ "fixed_charge", "floating_charge", "fixed_and_floating_charge", "debenture_series", "charge_on_acquired_property" ], "description": "Nature of the security." }, "registrable_categories": { "type": "array", "items": {}, "description": "s131 categories: debenture_issue, uncalled_share_capital, shares_of_subsidiary, land_or_interest_in_land, book_debts, floating_charge, unpaid_calls." }, "created_on": { "type": "string", "format": "date", "description": "Creation date, or acquisition date if the charge existed on acquired property; starts the period." }, "instrument_executed_in": { "type": "string", "description": "ISO 3166 country of execution; not SG gives 37 days." }, "amount_secured": { "$ref": "#/components/schemas/Money", "description": "Amount secured." }, "property_description": { "type": "string", "description": "Description sufficient to identify the property." }, "instrument_document": { "type": "string", "pattern": "^doc_", "description": "Executed instrument; not lodged but kept at the registered office (s131, s138)." }, "sub_fund": { "type": "string", "description": "VCC sub-fund identifier." } }, "required": [ "entity_type", "chargee", "charge_type", "registrable_categories", "created_on", "instrument_executed_in", "amount_secured", "property_description", "instrument_document" ], "description": "Registers a charge the company has created, such as a debenture, fixed or floating charge, or a charge over land, book debts, subsidiary shares or IP. Entiva checks it is registrable, takes board approval, files on Bizfile within 30." }, "Create_sg_charge_register": { "type": "object", "properties": { "type": { "const": "sg.charge.register" }, "params": { "$ref": "#/components/schemas/Params_sg_charge_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charge with ACRA", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "charge_instrument", "title": "Executed charge instrument", "source": "uploaded", "required": true }, { "key": "board_resolution_charge", "title": "Directors' resolution approving the charge", "source": "generated", "required": true }, { "key": "register_of_charges_entry", "title": "Entry in the company's register of charges", "source": "generated", "required": true }, { "key": "registrar_notice_of_registration", "title": "Registrar's notice of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_charge", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_instrument", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registrar_notice_of_registration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Register new charge'", "channel": "online", "government_fee": { "amount": 60, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "registration_period_passed", "type": null, "when": "409 requirement_error: 30 days have passed; a court order or ACRA extension is needed first." }, { "code": "instrument_missing", "type": null, "when": "422 requirement_error: no executed instrument on file." }, { "code": "charge_not_in_registrable_category", "type": null, "when": "422 invalid_request_error: no s131 category matches; returned for Entiva review." }, { "code": "chargee_details_incomplete", "type": null, "when": "422 invalid_request_error: chargee name, address or number missing." }, { "code": "sub_fund_required", "type": null, "when": "422 invalid_request_error: a VCC sub-fund chargor is not identified." } ] } }, "Params_sg_financial_assistance_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "holding_company_status": { "type": "string", "enum": [ "none", "private_company", "public_company", "listed_corporation" ], "description": "Private companies with no or a private holding company are not caught (s76)." }, "assistance_route": { "type": "string", "enum": [ "s76_9A", "s76_9B", "s76_9BA", "s76_10" ], "description": "9A: within 10% of paid-up capital plus reserves. 9B: every member present and voting approves. 9BA: no material prejudice. 10: special resolution." }, "assistance_type": { "type": "string", "enum": [ "loan", "guarantee", "security", "other" ], "description": "Form of assistance." }, "assistance_amount": { "$ref": "#/components/schemas/Money", "description": "Amount of the assistance." }, "beneficiary": { "type": "string", "pattern": "^per_", "description": "Person buying the shares; verified and screened." }, "target_shares": { "type": "string", "enum": [ "own_shares", "holding_company_shares" ], "description": "Whose shares are bought." }, "board_resolution_date": { "type": "string", "format": "date", "description": "Date of the board resolution." }, "members_resolution_date": { "type": "string", "format": "date", "description": "Routes 9B, 9BA, 10." }, "notice_sent_on": { "type": "string", "format": "date", "description": "Date notice goes to members." }, "directors_making_statement": { "type": "array", "items": {}, "description": "person_ref for every director." }, "assistance_date": { "type": "string", "format": "date", "description": "9B: within 12 months of the members' resolution. 10: after the objection period." } }, "required": [ "entity_type", "holding_company_status", "assistance_route", "assistance_type", "assistance_amount", "beneficiary", "target_shares", "board_resolution_date", "assistance_date" ], "description": "Handles the s76 route for a company that lends, guarantees or otherwise helps someone buy its own or its holding company's shares. Entiva checks s76 applies, runs the board, solvency and members' steps for the chosen route, and files." }, "Create_sg_financial_assistance_file": { "type": "object", "properties": { "type": { "const": "sg.financial_assistance.file" }, "params": { "$ref": "#/components/schemas/Params_sg_financial_assistance_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give financial assistance for a share purchase and file the notice", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_financial_assistance", "title": "Board resolution with full grounds", "source": "generated", "required": true }, { "key": "directors_solvency_statement", "title": "Directors' solvency statement", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Members' resolution", "source": "generated", "required": false }, { "key": "notice_to_members", "title": "Notice to members", "source": "generated", "required": false }, { "key": "bizfile_notification", "title": "Bizfile confirmation of the S76 notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "beneficiary", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_financial_assistance", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_solvency_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_members", "signer_role": "company_secretary", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File Notice of Resolution' > S76", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "financial_assistance_not_restricted", "type": null, "when": "422 invalid_request_error: s76 does not apply; nothing to file." }, { "code": "assistance_cap_exceeded", "type": null, "when": "422 invalid_request_error: route 9A exceeds 10% of paid-up capital plus reserves." }, { "code": "members_not_unanimous", "type": null, "when": "409 requirement_error: route 9B needs every member present and voting." }, { "code": "notice_deadline_missed", "type": null, "when": "409 requirement_error: a statutory notice or lodgement day passed." }, { "code": "objection_period_running", "type": null, "when": "409 requirement_error: route 10 objection period or court case still open." } ] } }, "Params_sg_notice_of_compliance_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_shares" ], "description": "Public companies only; private companies cannot offer shares to the public." }, "prospectus_issued": { "type": "boolean", "description": "True if a prospectus registered with MAS was issued." }, "exemption_basis": { "type": "string", "enum": [ "not_applicable_prospectus_issued", "no_offer_to_public", "minimum_transaction_s200000", "small_offer_s5m_12_months", "private_placement_50_persons_12_months", "accredited_or_institutional_investors", "other_exemption" ], "description": "Why no prospectus: MAS exemptions are S$200,000 minimum transaction, S$5m small offers in 12 months, private placement to 50 persons, accredited or." }, "offer_description": { "type": "string", "description": "Securities, number, price and investors." }, "expected_allotment_date": { "type": "string", "format": "date", "description": "Planned allotment; the notice is filed before it." }, "related_allotment_action": { "type": "string", "description": "act_ id of the sg.share.allot for this offer." } }, "required": [ "entity_type", "prospectus_issued", "exemption_basis", "offer_description" ], "description": "A public company offering or allotting shares files ACRA's Notice of Compliance by Company that has/has not issued Prospectus through General lodgement. Entiva records whether a MAS-registered prospectus was issued or which exemption." }, "Create_sg_notice_of_compliance_file": { "type": "object", "properties": { "type": { "const": "sg.notice_of_compliance.file" }, "params": { "$ref": "#/components/schemas/Params_sg_notice_of_compliance_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a public company's Notice of Compliance", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_compliance", "title": "Directors' resolution approving the notice", "source": "generated", "required": true }, { "key": "exemption_assessment_memo", "title": "Exemption assessment", "source": "uploaded", "required": false }, { "key": "bizfile_notification", "title": "Bizfile confirmation of the notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_compliance", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'General lodgement' > Notice of Compliance", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_public", "type": null, "when": "422 jurisdiction_error: only public companies file this notice." }, { "code": "exemption_unsupported", "type": null, "when": "422 requirement_error: no prospectus and no exemption assessment on file." }, { "code": "offer_already_made", "type": null, "when": "409 requirement_error: the offer or allotment preceded the notice; counsel should advise." } ] } }, "Params_sg_preference_share_redeem": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The redeemable preference class." }, "currency": { "type": "string", "description": "ISO 4217 currency." }, "number_of_shares": { "type": "integer", "description": "Shares redeemed." }, "redemption_date": { "type": "string", "format": "date", "description": "Must follow the constitution's terms." }, "total_redemption_amount": { "$ref": "#/components/schemas/Money", "description": "Total paid to holders." }, "funding_source": { "type": "string", "enum": [ "distributable_profits", "company_capital", "proceeds_of_fresh_issue_for_redemption" ], "description": "From capital needs a solvency statement; fresh-issue proceeds are not 'out of capital' (s70)." }, "shares_fully_paid": { "type": "boolean", "description": "Must be true (s70)." }, "holders": { "type": "array", "items": {}, "description": "Array of {member, number_of_shares}." }, "solvency_statement_date": { "type": "string", "format": "date", "description": "Required if funding_source is company_capital." }, "directors_making_statement": { "type": "array", "items": {}, "description": "person_ref for every director; required if capital is used." } }, "required": [ "entity_type", "share_class", "currency", "number_of_shares", "redemption_date", "total_redemption_amount", "funding_source", "shares_fully_paid", "holders" ], "description": "Redeems redeemable preference shares on the constitution's terms. If paid from capital, every director makes a solvency statement lodged with ACRA." }, "Create_sg_preference_share_redeem": { "type": "object", "properties": { "type": { "const": "sg.preference_share.redeem" }, "params": { "$ref": "#/components/schemas/Params_sg_preference_share_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redeem redeemable preference shares", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_redemption", "title": "Directors' resolution approving the redemption", "source": "generated", "required": true }, { "key": "directors_solvency_statement", "title": "Directors' solvency statement", "source": "generated", "required": false }, { "key": "bizfile_notification", "title": "Bizfile confirmations", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_redemption", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_solvency_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > File notice of redemption of redeemable preference s", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "shares_not_redeemable", "type": null, "when": "422 requirement_error: not redeemable, or the constitution does not authorise these terms." }, { "code": "shares_not_fully_paid", "type": null, "when": "422 requirement_error: shares are not fully paid (s70)." }, { "code": "redemption_terms_not_met", "type": null, "when": "409 requirement_error: date or manner differs from the constitution." }, { "code": "solvency_statement_missing", "type": null, "when": "422 requirement_error: redemption from capital lacks every director's statement." } ] } }, "Params_sg_prospectus_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_shares" ], "description": "Public companies only." }, "securities_offered": { "type": "string", "enum": [ "ordinary_shares", "preference_shares", "other_shares" ], "description": "Securities offered." }, "number_of_shares_offered": { "type": "integer", "description": "Shares offered." }, "currency": { "type": "string", "description": "ISO 4217 currency." }, "offer_price_per_share": { "type": "number", "description": "Price per share, in major units." }, "maximum_proceeds": { "$ref": "#/components/schemas/Money", "description": "Maximum raised; tests the S$5 million small-offer exemption." }, "exemption_assessment": { "type": "string", "enum": [ "no_exemption_prospectus_required", "minimum_transaction_s200000", "small_offer_s5m_12_months", "private_placement_50_persons_12_months", "accredited_or_institutional_investors" ], "description": "If an exemption applies, no MAS filing is made and the basis is recorded." }, "target_offer_date": { "type": "string", "format": "date", "description": "Intended opening date; cannot precede registration." }, "counsel_choice": { "type": "string", "enum": [ "entiva_partner", "customer_appointed" ], "description": "Entiva's Entiva firm, or the customer's own counsel." }, "counsel": { "type": "string", "pattern": "^per_", "description": "Customer's own counsel; required if customer_appointed." } }, "required": [ "entity_type", "securities_offered", "number_of_shares_offered", "currency", "offer_price_per_share", "maximum_proceeds", "exemption_assessment", "target_offer_date", "counsel_choice" ], "description": "A public offer of shares needs a prospectus lodged with and registered by MAS before the offer, unless exempt. Entiva refers the work to partner Singapore counsel, coordinates the draft, board review and directors' signatures, then." }, "Create_sg_prospectus_register": { "type": "object", "properties": { "type": { "const": "sg.prospectus.register" }, "params": { "$ref": "#/components/schemas/Params_sg_prospectus_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a prospectus with MAS for a public offer of shares", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "counsel_engagement", "title": "Engagement of Singapore counsel", "source": "generated", "required": true }, { "key": "board_resolution_prospectus", "title": "Directors' resolution approving the offer", "source": "generated", "required": true }, { "key": "prospectus", "title": "Prospectus prepared by counsel", "source": "uploaded", "required": true }, { "key": "mas_registration_notice", "title": "Evidence of MAS registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "counsel_engagement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution_prospectus", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "prospectus", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "mas_registration_notice", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Monetary Authority of Singapore", "form": "Lodgement and registration of a prospectus under SFA s240", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_public", "type": null, "when": "422 jurisdiction_error: only public companies can make a public offer." }, { "code": "counsel_not_engaged", "type": null, "when": "409 requirement_error: no counsel has accepted the instruction." }, { "code": "offer_before_registration", "type": null, "when": "409 requirement_error: target_offer_date precedes MAS registration (s240)." }, { "code": "exemption_not_substantiated", "type": null, "when": "422 requirement_error: exemption claimed without counsel's assessment." }, { "code": "mas_registration_refused", "type": null, "when": "422 registry_error: MAS refused registration; reasons in requirements[]." } ] } }, "Params_sg_share_allot": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type; must match the entity." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class of the new shares; the constitution must allow it." }, "currency": { "type": "string", "description": "ISO 4217 currency of the shares." }, "number_of_shares": { "type": "integer", "description": "Total shares allotted; equals the sum over allottees." }, "amount_paid_per_share": { "type": "number", "description": "Paid or deemed paid per share, in major units." }, "amount_unpaid_per_share": { "type": "number", "description": "Unpaid per share, in major units; 0 if fully paid." }, "consideration_type": { "type": "string", "enum": [ "cash", "non_cash", "partly_cash_partly_non_cash" ], "description": "How the shares are paid for." }, "allotment_date": { "type": "string", "format": "date", "description": "Private-type: filing date, no backdating." }, "allottees": { "type": "array", "items": {}, "description": "Array of {person, number_of_shares, holds_as_nominee, nominator}." }, "members_approval": { "type": "object", "description": "s161 approval: mode, passed_on, method." }, "non_cash_method": { "type": "string", "enum": [ "written_contract", "oral_contract", "constitution_provision", "capitalisation", "court_order" ], "description": "Needed for non-cash: decides what is lodged with the return." } }, "required": [ "entity_type", "share_class", "currency", "number_of_shares", "amount_paid_per_share", "amount_unpaid_per_share", "consideration_type", "allotment_date", "allottees", "members_approval" ], "description": "Issues new shares once members approve in general meeting and directors fix the terms. Entiva verifies allottees, files the return on Bizfile and issues certificates." }, "Create_sg_share_allot": { "type": "object", "properties": { "type": { "const": "sg.share.allot" }, "params": { "$ref": "#/components/schemas/Params_sg_share_allot" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Allot new shares and file the return of allotment", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution_s161", "title": "Members' approval for the issue", "source": "generated", "required": true }, { "key": "directors_resolution_allotment", "title": "Directors' resolution to allot", "source": "generated", "required": true }, { "key": "non_cash_contract", "title": "Contract for non-cash consideration", "source": "uploaded", "required": false }, { "key": "share_certificates", "title": "Share certificates", "source": "generated", "required": true }, { "key": "bizfile_notification", "title": "Bizfile confirmation of the return", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution_s161", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_resolution_allotment", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "share_certificates", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > Return of allotment of shares", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "members_approval_missing", "type": null, "when": "422 requirement_error: no s161 approval covers the issue, or the mandate lapsed at the AGM." }, { "code": "backdating_not_allowed", "type": null, "when": "422 invalid_request_error: private-type allotment_date is in the past." }, { "code": "allottee_total_mismatch", "type": null, "when": "422 invalid_request_error: allottees do not add up to number_of_shares." }, { "code": "private_company_member_limit", "type": null, "when": "422 requirement_error: more than 50 members (s18)." }, { "code": "non_cash_evidence_missing", "type": null, "when": "422 requirement_error: non-cash consideration lacks its contract, order or record." } ] } }, "Params_sg_share_convert": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "from_class": { "type": "string", "description": "Class converted from." }, "to_class": { "type": "string", "description": "Class converted into; not redeemable preference unless the shares were redeemable when issued (s74A)." }, "currency": { "type": "string", "description": "ISO 4217 currency of the shares." }, "scope": { "type": "string", "enum": [ "all_shares_of_class", "selected_members" ], "description": "Every share of the class, or selected members' shares." }, "number_of_shares": { "type": "integer", "description": "Total shares converted." }, "conversions": { "type": "array", "items": {}, "description": "Array of {member, number_of_shares}; required for selected_members." }, "constitution_permits_conversion": { "type": "boolean", "description": "True if a clause already allows the conversion and the target class (s74A); if false, a special resolution amends the constitution." }, "class_rights_varied": { "type": "boolean", "description": "True if class rights are varied or abrogated; s74 class consent then applies." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "from_class", "to_class", "currency", "scope", "number_of_shares", "constitution_permits_conversion", "class_rights_varied" ], "description": "Converts shares into another class, for example ordinary into alphabet or preference shares. Entiva checks the constitution, collects the special resolution and any class consent, files 'Conversion of shares' on Bizfile and reissues." }, "Create_sg_share_convert": { "type": "object", "properties": { "type": { "const": "sg.share.convert" }, "params": { "$ref": "#/components/schemas/Params_sg_share_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert shares from one class to another", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_conversion", "title": "Directors' resolution approving the conversion", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution amending the constitution", "source": "generated", "required": false }, { "key": "class_consent", "title": "Class consent", "source": "uploaded", "required": false }, { "key": "share_certificates", "title": "Share certificates for the new class", "source": "generated", "required": true }, { "key": "bizfile_notification", "title": "Bizfile confirmations", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_conversion", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "class_consent", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "share_certificates", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > File conversion of shares", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "conversion_not_permitted_by_constitution", "type": null, "when": "422 requirement_error: no conversion clause or resolution amending it." }, { "code": "cannot_convert_to_redeemable", "type": null, "when": "422 invalid_request_error: shares were not redeemable when issued (s74A)." }, { "code": "class_consent_missing", "type": null, "when": "422 requirement_error: class rights are varied and no consent is on file." }, { "code": "conversion_exceeds_holding", "type": null, "when": "422 invalid_request_error: a member converts more than they hold." } ] } }, "Params_sg_share_repurchase": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "purchase_type": { "type": "string", "enum": [ "off_market_equal_access", "selective_off_market", "contingent_purchase", "market_purchase" ], "description": "Kind of buyback; market_purchase goes to Entiva review." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class bought back." }, "currency": { "type": "string", "description": "ISO 4217 currency." }, "number_of_shares": { "type": "integer", "description": "Shares bought back." }, "total_consideration": { "$ref": "#/components/schemas/Money", "description": "Total price including brokerage and expenses (s76F)." }, "sellers": { "type": "array", "items": {}, "description": "Array of {member, number_of_shares}; all types except market_purchase." }, "entire_class_acquired": { "type": "boolean", "description": "Selective: if false, 75% of the affected class must also consent." }, "funding_source": { "type": "string", "enum": [ "distributable_profits", "capital", "profits_and_capital" ], "description": "Source of payment." }, "post_purchase_treatment": { "type": "string", "enum": [ "cancel", "hold_as_treasury" ], "description": "Cancel, or hold ordinary shares as treasury shares." }, "purchase_date": { "type": "string", "format": "date", "description": "Private-type: effective on filing." }, "authority": { "type": "object", "description": "Members' authority: resolution_date, expires_on, max_price_per_share or formula." }, "solvency_confirmation_date": { "type": "string", "format": "date", "description": "Date directors confirm the s76F solvency test for the payment." } }, "required": [ "entity_type", "purchase_type", "share_class", "currency", "number_of_shares", "total_consideration", "funding_source", "post_purchase_treatment", "purchase_date", "authority", "solvency_confirmation_date" ], "description": "Buys back shares from members: equal-access, selective off-market, contingent contract, or an SGX market purchase. Entiva checks the 20% cap and solvency test, collects resolutions and class consent, and files the notice of purchase." }, "Create_sg_share_repurchase": { "type": "object", "properties": { "type": { "const": "sg.share.repurchase" }, "params": { "$ref": "#/components/schemas/Params_sg_share_repurchase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Buy back a company's own shares", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "authorising_resolution", "title": "Members' resolution authorising the buyback", "source": "generated", "required": true }, { "key": "buyback_agreement", "title": "Buyback agreement or offer terms", "source": "generated", "required": true }, { "key": "class_consent", "title": "Consent of 75% of the affected class", "source": "uploaded", "required": false }, { "key": "directors_solvency_confirmation", "title": "Directors' solvency confirmation", "source": "generated", "required": true }, { "key": "bizfile_notification", "title": "Bizfile confirmation of the notice of purchase", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "authorising_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "class_consent", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "directors_solvency_confirmation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "buyback_agreement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > Notice of purchase or acquisition", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "buyback_not_authorised_by_constitution", "type": null, "when": "422 requirement_error: the constitution does not expressly permit buybacks." }, { "code": "buyback_limit_exceeded", "type": null, "when": "422 invalid_request_error: purchases would exceed 20% of the class." }, { "code": "authority_expired", "type": null, "when": "409 requirement_error: the members' authority lapsed at the AGM." }, { "code": "class_consent_missing", "type": null, "when": "422 requirement_error: part of a class bought without 75% class consent." }, { "code": "solvency_not_satisfied", "type": null, "when": "409 requirement_error: a director cannot give the s76F confirmation." } ] } }, "Params_sg_share_transfer": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type; must match the entity." }, "transferor": { "type": "string", "pattern": "^per_", "description": "Member giving up the shares; must hold enough fully paid shares." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Incoming member, an individual or a legal entity." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class as named in the register of members." }, "currency": { "type": "string", "description": "ISO 4217 currency of the shares." }, "number_of_shares": { "type": "integer", "description": "Shares transferred." }, "paid_up_amount": { "$ref": "#/components/schemas/Money", "description": "Paid-up capital attached to those shares." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price paid; 0 for a gift." }, "instrument_signed_on": { "type": "string", "format": "date", "description": "Starts the 14-day stamping period." }, "instrument_executed_in_singapore": { "type": "boolean", "description": "False if signed abroad: 30 days from receipt in Singapore." }, "valuation": { "type": "object", "description": "nav_per_share, accounts_date, company_owns_property; taken from stored accounts if omitted." }, "nominator": { "type": "string", "pattern": "^per_", "description": "Person the transferee holds for, if a nominee." } }, "required": [ "entity_type", "transferor", "transferee", "share_class", "currency", "number_of_shares", "paid_up_amount", "consideration", "instrument_signed_on", "instrument_executed_in_singapore" ], "description": "Moves fully paid shares from one member to another. Entiva collects the instrument and board approval, e-Stamps it with IRAS, then lodges the transfer on Bizfile." }, "Create_sg_share_transfer": { "type": "object", "properties": { "type": { "const": "sg.share.transfer" }, "params": { "$ref": "#/components/schemas/Params_sg_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer shares, pay stamp duty and update ACRA's register", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "instrument_of_transfer", "title": "Instrument of transfer", "source": "generated", "required": true }, { "key": "transferee_acceptance", "title": "Transferee acceptance and KYC consent", "source": "generated", "required": true }, { "key": "board_resolution_transfer", "title": "Directors' resolution approving registration", "source": "generated", "required": true }, { "key": "stamp_certificate", "title": "IRAS stamp certificate", "source": "registry_issued", "required": true }, { "key": "share_certificate_transferee", "title": "Share certificate for the transferee", "source": "generated", "required": true }, { "key": "bizfile_notification", "title": "Bizfile confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "instrument_of_transfer", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "transferee_acceptance", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution_transfer", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "share_certificate_transferee", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stamp_certificate", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > Transfer of shares", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "shares_not_fully_paid", "type": null, "when": "422 requirement_error: ACRA's transfer covers fully paid shares only." }, { "code": "transfer_exceeds_holding", "type": null, "when": "422 invalid_request_error: more shares or paid-up capital than the transferor holds." }, { "code": "transfer_restricted_by_constitution", "type": null, "when": "422 requirement_error: consent or pre-emption is not evidenced." }, { "code": "backdating_not_allowed", "type": null, "when": "422 invalid_request_error: a private company's transfer takes effect on filing." }, { "code": "stamp_duty_unpaid", "type": null, "when": "409 requirement_error: Entiva lodges only after IRAS issues the stamp certificate." } ] } }, "Params_sg_share_capital_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "alteration_type": { "type": "string", "enum": [ "convert_shares_to_stock", "reconvert_stock_to_shares", "consolidate_shares", "subdivide_shares", "cancel_unissued_shares", "cancel_forfeited_shares" ], "description": "The s71 alteration." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class altered." }, "currency": { "type": "string", "description": "ISO 4217 currency." }, "ratio_from_shares": { "type": "integer", "description": "Old shares in the ratio; consolidation 10:1, split 1:10." }, "ratio_to_shares": { "type": "integer", "description": "New shares in the ratio." }, "cancelled_shares": { "type": "integer", "description": "Shares cancelled; for the two cancellation types." }, "constitution_authorises": { "type": "boolean", "description": "s71 needs authority in the constitution; if false, a special resolution amends it first." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the resolution in general meeting." } }, "required": [ "entity_type", "alteration_type", "share_class", "currency", "constitution_authorises", "resolution_date" ], "description": "Alters share capital under s71 without changing its total, or cancels unissued or forfeited shares. Entiva collects the general-meeting resolution and files the notice of alteration on Bizfile; a private company's alteration takes." }, "Create_sg_share_capital_change": { "type": "object", "properties": { "type": { "const": "sg.share_capital.change" }, "params": { "$ref": "#/components/schemas/Params_sg_share_capital_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter share capital: consolidate, split, stock conversion or cancel unissued shares", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_alteration", "title": "Members' resolution altering share capital", "source": "generated", "required": true }, { "key": "board_resolution_alteration", "title": "Directors' resolution approving the notice", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution amending the constitution", "source": "generated", "required": false }, { "key": "share_certificates", "title": "Replacement certificates", "source": "generated", "required": false }, { "key": "bizfile_notification", "title": "Bizfile confirmations", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution_alteration", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_alteration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "share_certificates", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > File notice of alteration in share capital", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "alteration_not_authorised", "type": null, "when": "422 requirement_error: the constitution lacks the power and no amending resolution exists." }, { "code": "capital_not_preserved", "type": null, "when": "422 invalid_request_error: a consolidation or split changes total capital." }, { "code": "shares_already_issued", "type": null, "when": "422 invalid_request_error: issued shares cannot be cancelled here; use sg.share_capital.reduce." } ] } }, "Params_sg_share_capital_redenominate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "scope": { "type": "string", "enum": [ "entire_share_capital", "single_class" ], "description": "Whole share capital or one class." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Required for single_class." }, "from_currency": { "type": "string", "description": "ISO 4217 current currency." }, "to_currency": { "type": "string", "description": "ISO 4217 new currency." }, "rate_method": { "type": "string", "enum": [ "spot_rate", "average_rate" ], "description": "Spot rate on a stated day, or average of daily rates over a stated period." }, "rate_date": { "type": "string", "format": "date", "description": "Spot day, within the 28 days ending the day before the resolution." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the ordinary resolution passes." }, "effective_date": { "type": "string", "format": "date", "description": "Resolution date or later; lapses if not effective within 28 days of passing (s73)." } }, "required": [ "entity_type", "scope", "from_currency", "to_currency", "rate_method", "resolution_date", "effective_date" ], "description": "Converts share capital, or one class, into another currency by ordinary resolution; members' rights are unchanged. Entiva computes the new amounts from the rate method and files the notice on Bizfile; ACRA takes about 7 working days." }, "Create_sg_share_capital_redenominate": { "type": "object", "properties": { "type": { "const": "sg.share_capital.redenominate" }, "params": { "$ref": "#/components/schemas/Params_sg_share_capital_redenominate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redenominate share capital into another currency", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ordinary_resolution_redenomination", "title": "Ordinary resolution to redenominate", "source": "generated", "required": true }, { "key": "board_resolution_redenomination", "title": "Directors' resolution approving the notice", "source": "generated", "required": true }, { "key": "redenomination_computation", "title": "Rate and recomputed share amounts", "source": "generated", "required": true }, { "key": "bizfile_notification", "title": "Bizfile confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ordinary_resolution_redenomination", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_redenomination", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > Redenomination of shares", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "redenomination_excluded_by_constitution", "type": null, "when": "422 requirement_error: the constitution excludes the power (s73)." }, { "code": "rate_date_out_of_window", "type": null, "when": "422 invalid_request_error: rate day or period is outside the 28 days before the resolution." }, { "code": "resolution_lapsed", "type": null, "when": "409 requirement_error: not effective within 28 days; pass a new resolution." } ] } }, "Params_sg_share_capital_reduce": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares" ], "description": "Company type; unlimited companies are not covered by the text read." }, "route": { "type": "string", "enum": [ "solvency_statement", "court_order" ], "description": "Members' approval with solvency statement, or Court order." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class reduced." }, "currency": { "type": "string", "description": "ISO 4217 currency." }, "reduction_method": { "type": "string", "enum": [ "cancel_shares_and_pay_members", "cancel_shares_without_payment", "reduce_paid_up_and_pay_members", "reduce_paid_up_without_payment", "release_unpaid_liability" ], "description": "How capital is reduced." }, "involves_distribution_or_release": { "type": "boolean", "description": "True if assets go to members or a debt to the company is released; if false, no solvency statement is needed (s78B)." }, "reduction_amount": { "$ref": "#/components/schemas/Money", "description": "Amount by which share capital falls." }, "share_capital_after": { "$ref": "#/components/schemas/Money", "description": "Share capital after the reduction; published and lodged." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution passes; all windows count from it." }, "solvency_statement_date": { "type": "string", "format": "date", "description": "Solvency route: within the 20 days or 30 days ending on the resolution date." }, "directors_making_statement": { "type": "array", "items": {}, "description": "Solvency route: person_ref for every director." }, "court_order_date": { "type": "string", "format": "date", "description": "Court route: date of the order; starts the 90 days." } }, "required": [ "entity_type", "route", "share_class", "currency", "reduction_method", "involves_distribution_or_release", "reduction_amount", "share_capital_after", "resolution_date" ], "description": "Reduces share capital by special resolution. Solvency route: every director makes a solvency statement and Entiva runs three Bizfile steps over 6 to 8 weeks." }, "Create_sg_share_capital_reduce": { "type": "object", "properties": { "type": { "const": "sg.share_capital.reduce" }, "params": { "$ref": "#/components/schemas/Params_sg_share_capital_reduce" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reduce share capital", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution to reduce share capital", "source": "generated", "required": true }, { "key": "directors_solvency_statement", "title": "Directors' solvency statement", "source": "generated", "required": false }, { "key": "directors_statement_s78e", "title": "Directors' statement of compliance", "source": "generated", "required": false }, { "key": "supporting_affidavit", "title": "Director's supporting affidavit", "source": "uploaded", "required": false }, { "key": "court_order", "title": "Order of Court approving the reduction", "source": "uploaded", "required": false }, { "key": "bizfile_notification", "title": "Bizfile confirmations", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_solvency_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_statement_s78e", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile: special resolution", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "solvency_statement_expired", "type": null, "when": "422 requirement_error: made outside the 20-day or 30-day window." }, { "code": "solvency_statement_incomplete", "type": null, "when": "422 requirement_error: a director has not signed." }, { "code": "resolution_not_special", "type": null, "when": "422 requirement_error: below 75%, or special notice resolution passed in writing." }, { "code": "lodgement_window_not_open", "type": null, "when": "409 requirement_error: s78E cannot be lodged before week 6 ends." }, { "code": "creditor_application_pending", "type": null, "when": "409 requirement_error: a creditor applied to cancel; wait for the Court." } ] } }, "Params_sg_share_capital_paid_up_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "paid_up_changed_on": { "type": "string", "format": "date", "description": "Date the paid-up amount changed." }, "payments": { "type": "array", "items": {}, "description": "Array of {member, share_class, currency, number_of_shares, additional_paid_per_share, remaining_unpaid_per_share}." }, "payment_evidence": { "type": "string", "pattern": "^doc_", "description": "Bank statement or receipt showing the amounts paid." } }, "required": [ "entity_type", "paid_up_changed_on", "payments", "payment_evidence" ], "description": "Records that members have paid up more of their partly paid shares. Entiva checks the payment evidence against the register and files the notice to update paid-up share capital on Bizfile; the number of shares does not change." }, "Create_sg_share_capital_paid_up_change": { "type": "object", "properties": { "type": { "const": "sg.share_capital_paid_up.change" }, "params": { "$ref": "#/components/schemas/Params_sg_share_capital_paid_up_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update paid-up share capital after a call on partly paid shares", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_call", "title": "Directors' resolution recording the call and payments", "source": "generated", "required": true }, { "key": "payment_evidence", "title": "Evidence of payment", "source": "uploaded", "required": true }, { "key": "bizfile_notification", "title": "Bizfile confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_call", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > Notice to update paid-up share capital", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_partly_paid_shares", "type": null, "when": "422 invalid_request_error: the member holds no partly paid shares in that class." }, { "code": "payment_exceeds_unpaid", "type": null, "when": "422 invalid_request_error: more than the unpaid amount on the register." }, { "code": "payment_evidence_missing", "type": null, "when": "422 requirement_error: no evidence matches the amounts paid." } ] } }, "Params_sg_treasury_share_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "description": "Company type." }, "dealing": { "type": "string", "enum": [ "cancel_all", "cancel_part", "sell_for_cash", "transfer_under_share_scheme", "transfer_as_consideration_for_acquisition", "other_prescribed_purpose" ], "description": "What the company does." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Treasury shares exist only under the Ordinary class." }, "number_of_shares": { "type": "integer", "description": "Treasury shares dealt with." }, "dealing_date": { "type": "string", "format": "date", "description": "Private-type: effective on filing." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Cash received, or value of shares or assets received." }, "recipient": { "type": "string", "pattern": "^per_", "description": "Buyer or recipient; required unless cancelling." }, "s215_notice_outstanding": { "type": "boolean", "description": "True if a s215 notice is outstanding; the shares cannot go to anyone else." } }, "required": [ "entity_type", "dealing", "share_class", "number_of_shares", "dealing_date" ], "description": "Cancels treasury shares or deals with them under s76K: sell for cash, transfer under a share scheme or for an acquisition, or another prescribed use. Entiva checks the 10% treasury cap, takes the board decision and files the Bizfile." }, "Create_sg_treasury_share_cancel": { "type": "object", "properties": { "type": { "const": "sg.treasury_share.cancel" }, "params": { "$ref": "#/components/schemas/Params_sg_treasury_share_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel or dispose of treasury shares", "x-entiva": { "jurisdiction": "sg", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_treasury", "title": "Directors' resolution to cancel or dispose", "source": "generated", "required": true }, { "key": "instrument_of_transfer", "title": "Instrument of transfer from the company", "source": "generated", "required": false }, { "key": "bizfile_notification", "title": "Bizfile confirmation of the s76K notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "recipient", "verification_level": "identity" }, { "role": "recipient", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_treasury", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "instrument_of_transfer", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Update shares information' > cancellation or disposal of treasury shares", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insufficient_treasury_shares", "type": null, "when": "422 invalid_request_error: more than the treasury shares on the register." }, { "code": "s215_notice_blocks_sale", "type": null, "when": "409 requirement_error: a s215 notice bars sale to anyone else." }, { "code": "recipient_required", "type": null, "when": "422 invalid_request_error: a disposal other than cancellation needs a recipient." }, { "code": "treasury_cap_breach_deadline", "type": null, "when": "409 requirement_error: over 10% of the class; fix within 6 months." } ] } }, "Params_sg_charge_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "description": "Entity type of the chargor.", "examples": [ "private_ltd_shares" ] }, "charge_number": { "type": "string", "description": "The original charge number, as Bizfile and the entity's register of charges show it.", "examples": [ "0012345" ] }, "variation_date": { "type": "string", "format": "date", "description": "The date the variation was made, normally the date of the variation instrument.", "examples": [ "2026-10-09" ] }, "variation_instrument_description": { "type": "string", "description": "What the variation instrument is, in the words of Bizfile's 'description of variation instrument' dropdown, for example 'Deed of variation'.", "examples": [ "Deed of variation" ] }, "type_of_change": { "type": "array", "items": {}, "description": "One or both of: chargee_details_and_amount_secured, variation_description.", "examples": [ "[\"chargee_details_and_amount_secured\"]" ] }, "chargee_changes": { "type": "array", "items": {}, "description": "Required when type_of_change includes chargee_details_and_amount_secured." }, "variation_description": { "type": "string", "description": "Required when type_of_change includes variation_description." }, "instructed_by": { "type": "string", "enum": [ "chargor", "chargee" ], "description": "Who is instructing Entiva.", "examples": [ "chargor" ] } }, "required": [ "entity_type", "charge_number", "variation_date", "variation_instrument_description", "type_of_change", "instructed_by" ], "description": "File a variation of a charge already on ACRA's register: a change to the chargees, the amount secured or the terms. Free at ACRA, filed by Entiva's CSP through Bizfile, no deadline stated." }, "Create_sg_charge_change": { "type": "object", "properties": { "type": { "const": "sg.charge.change" }, "params": { "$ref": "#/components/schemas/Params_sg_charge_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Vary a registered charge", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "variation_instrument", "title": "Instrument of variation", "source": "uploaded", "required": true }, { "key": "filing_authorisation", "title": "Filing authorisation", "source": "generated", "required": true }, { "key": "chargor_authorisation", "title": "Chargor's authority for a chargee-instructed filing", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile submission and declaration", "source": "generated", "required": true }, { "key": "bizfile_confirmation", "title": "Bizfile confirmation of the variation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "variation_instrument", "signer_role": "chargee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'File variation/satisfaction of charges', option 'Variation of charges'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "charge_not_found", "type": null, "when": "charge_number is not on the entity's register of charges." }, { "code": "charge_not_variable", "type": null, "when": "The charge is satisfied, discharged or removed from the register." }, { "code": "no_active_chargee", "type": null, "when": "The change would leave the charge with no active chargee." }, { "code": "use_satisfaction_filing", "type": null, "when": "The variation records a repayment." }, { "code": "variation_instrument_required", "type": null, "when": "The signed instrument of variation has not been uploaded." }, { "code": "chargor_authorisation_required", "type": null, "when": "instructed_by is chargee and the chargor's written authority is missing." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." }, { "code": "registry_rejected", "type": null, "when": "Bizfile refuses the submission, for example because the charge record changed after the draft." } ] } }, "Params_sg_charge_satisfy": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "description": "Entity type of the chargor.", "examples": [ "private_ltd_shares" ] }, "charge_number": { "type": "string", "description": "The original charge number, as Bizfile and the entity's register of charges show it.", "examples": [ "0012345" ] }, "satisfaction_type": { "type": "string", "enum": [ "full", "partial" ], "description": "Whether the secured debt was repaid in full or in part.", "examples": [ "full" ] }, "satisfaction_date": { "type": "string", "format": "date", "description": "The date the debt was repaid, in full or in part.", "examples": [ "2026-10-14" ] }, "amount_repaid": { "$ref": "#/components/schemas/Money", "description": "The amount repaid, in minor units." }, "instructed_by": { "type": "string", "enum": [ "chargor", "chargee" ], "description": "Who is instructing Entiva.", "examples": [ "chargor" ] } }, "required": [ "entity_type", "charge_number", "satisfaction_type", "satisfaction_date", "instructed_by" ], "description": "File a satisfaction of a charge on ACRA's register when the secured debt has been repaid in full or in part. Free at ACRA, filed by Entiva's CSP through Bizfile, processed immediately." }, "Create_sg_charge_satisfy": { "type": "object", "properties": { "type": { "const": "sg.charge.satisfy" }, "params": { "$ref": "#/components/schemas/Params_sg_charge_satisfy" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record full or partial satisfaction of a registered charge", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "satisfaction_evidence", "title": "Evidence of repayment", "source": "uploaded", "required": true }, { "key": "filing_authorisation", "title": "Filing authorisation", "source": "generated", "required": true }, { "key": "chargor_authorisation", "title": "Chargor's authority for a chargee-instructed filing", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile submission and declaration", "source": "generated", "required": true }, { "key": "bizfile_confirmation", "title": "Bizfile confirmation of the satisfaction", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "satisfaction_evidence", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile eService 'File variation/satisfaction of charges', option 'Satisfaction of Charges", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "charge_not_found", "type": null, "when": "charge_number is not on the entity's register of charges." }, { "code": "charge_already_satisfied", "type": null, "when": "The charge is already satisfied or removed from the register." }, { "code": "satisfaction_evidence_required", "type": null, "when": "The chargee's release or other proof of repayment has not been uploaded." }, { "code": "satisfaction_date_in_future", "type": null, "when": "satisfaction_date is after today." }, { "code": "use_variation_filing", "type": null, "when": "The terms changed but nothing was repaid." }, { "code": "chargor_authorisation_required", "type": null, "when": "instructed_by is chargee and the chargor's written authority is missing." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." }, { "code": "registry_rejected", "type": null, "when": "Bizfile refuses the submission." } ] } }, "Params_sg_company_name_change": { "type": "object", "properties": { "name": { "type": "string", "description": "Full name with legal suffix, e.g. 'Meridian Labs Pte." }, "reason": { "type": "string", "enum": [ "voluntary", "acra_directed" ], "description": "Default voluntary. acra_directed: the Registrar directed the change because the name is prohibited or too similar (ss27, 28); needs acra_direction." }, "acra_direction": { "type": "string", "pattern": "^doc_", "description": "The Registrar's direction; required when reason is acra_directed." }, "name_application_transaction_number": { "type": "string", "description": "Approved ACRA name application for this entity; Entiva skips the S$15 application if the reservation is still valid." }, "name_consent_letter": { "type": "string", "pattern": "^doc_", "description": "Consent from the owner of an existing business with an identical name; needed only if ACRA flags one." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution", "sole_member_resolution" ], "description": "How members pass the special resolution." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting; required for general_meeting." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "name", "resolution_method" ], "description": "Changes a Singapore company's name. Entiva applies to ACRA for the new name, collects the members' special resolution, then files the notice of resolution and the entity-name update." }, "Create_sg_company_name_change": { "type": "object", "properties": { "type": { "const": "sg.company_name.change" }, "params": { "$ref": "#/components/schemas/Params_sg_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a company's name", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the new name", "source": "generated", "required": true }, { "key": "notice_of_general_meeting", "title": "Notice of general meeting", "source": "generated", "required": false }, { "key": "special_resolution", "title": "Members' special resolution changing the name", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the general meeting", "source": "generated", "required": false }, { "key": "name_application_result", "title": "ACRA name approval notification", "source": "registry_issued", "required": true }, { "key": "name_consent_letter", "title": "Letter of consent for an identical name", "source": "uploaded", "required": false }, { "key": "acra_direction", "title": "Registrar's direction to change the name", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "notice_of_resolution_acknowledgement", "title": "ACRA acknowledgement of the notice of resolution", "source": "registry_issued", "required": true }, { "key": "updated_business_profile", "title": "Updated ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Three Bizfile steps. 1) Register > Apply for new business entity name", "channel": "online", "government_fee": { "amount": 15, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "name_unavailable", "type": "registry_error", "when": "ACRA refuses the name as undesirable or identical to an existing or reserved name; a consent letter or name review may help." }, { "code": "reservation_expired", "type": "requirement_error", "when": "The reserved name expired before the resolution or the name update; a new application is needed." }, { "code": "special_resolution_threshold_not_met", "type": "requirement_error", "when": "A written resolution is short of 75% of total voting rights." }, { "code": "late_penalty_acknowledgement_required", "type": "requirement_error", "when": "The resolution is over 14 days old and acknowledge_late_penalty is not true." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_company_name_waive_limited": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_guarantee" ], "description": "Only a public company limited by guarantee can take this action.", "examples": [ "public_ltd_guarantee" ] }, "current_name": { "type": "string", "description": "The registered name, including the word to be omitted.", "examples": [ "Lion City Makers Education Limited" ] }, "word_to_omit": { "type": "string", "enum": [ "Limited", "Berhad" ], "description": "The word to drop.", "examples": [ "Limited" ] }, "name": { "type": "string", "description": "The current name with only that word removed.", "examples": [ "Lion City Makers Education" ] }, "objects_summary": { "type": "string", "description": "How the company's objects promote commerce, art, science, religion, charity or another useful object." }, "profits_applied_to_objects": { "type": "boolean", "description": "Declaration that the company intends to apply its profits and other income only to promote its objects." }, "dividends_prohibited_in_constitution": { "type": "boolean", "description": "Declaration that the constitution prohibits paying dividends to members." }, "is_registered_charity": { "type": "boolean", "description": "Whether the company is a registered charity." }, "charity_registration_number": { "type": "string", "description": "Required when is_registered_charity is true." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How members pass the special resolution adopting the new name, conditional on ACRA's approval.", "examples": [ "general_meeting" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Required when resolution_method is general_meeting: the date of the meeting.", "examples": [ "2026-11-20" ] } }, "required": [ "entity_type", "current_name", "word_to_omit", "name", "objects_summary", "profits_applied_to_objects", "dividends_prohibited_in_constitution", "is_registered_charity", "resolution_method" ], "description": "Apply to ACRA to drop the word 'Limited' from the name of a public company limited by guarantee under Companies Act s29. Entiva prepares the objects statement and the special resolution, files through its CSP and passes on ACRA's S$200." }, "Create_sg_company_name_waive_limited": { "type": "object", "properties": { "type": { "const": "sg.company_name.waive_limited" }, "params": { "$ref": "#/components/schemas/Params_sg_company_name_waive_limited" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Omit 'Limited' from a guarantee company's name", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "public_ltd_guarantee" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "constitution", "title": "Current constitution", "source": "uploaded", "required": true }, { "key": "objects_statement", "title": "Statement of objects and licence undertakings", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the general meeting", "source": "uploaded", "required": false }, { "key": "charity_registration_evidence", "title": "Charity registration evidence", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile submission and declaration", "source": "generated", "required": true }, { "key": "acra_approval", "title": "ACRA's approval of the omission", "source": "registry_issued", "required": false }, { "key": "notice_of_resolution_receipt", "title": "Bizfile receipt for the notice of resolution", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile application 'Omission of the word Limited or Berhad from company name'. After appr", "channel": "online", "government_fee": { "amount": 200, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a public company limited by guarantee." }, { "code": "name_already_omits_word", "type": null, "when": "current_name does not contain the word to omit." }, { "code": "proposed_name_mismatch", "type": null, "when": "proposed_name differs from current_name by more than the omitted word." }, { "code": "licence_conditions_not_met", "type": null, "when": "The objects are not an eligible purpose, or the constitution does not prohibit dividends." }, { "code": "special_resolution_not_passed", "type": null, "when": "The members' special resolution is missing or did not reach three-quarters." }, { "code": "charity_details_missing", "type": null, "when": "is_registered_charity is true and the registration number or evidence is missing." }, { "code": "registry_rejected", "type": null, "when": "ACRA refuses the application." } ] } }, "Params_sg_constitution_amend": { "type": "object", "properties": { "amendment_scope": { "type": "string", "enum": [ "partial_amendment", "full_replacement", "adopt_model_constitution" ], "description": "partial_amendment changes named clauses; full_replacement replaces the constitution; adopt_model_constitution adopts the model by reference (s26)." }, "amended_constitution": { "type": "string", "pattern": "^doc_", "description": "The complete constitution as altered." }, "amendment_summary": { "type": "string", "description": "The description of the resolution, for Bizfile's 'description of resolution' field." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution", "sole_member_resolution", "court_order" ], "description": "How the alteration is approved. court_order is an alteration made by court order, which Entiva only lodges." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting; required for general_meeting." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the resolution passed or order was made; the 14 days run from it." }, "effective_date": { "type": "string", "format": "date", "description": "A later date the resolution specifies (s26)." }, "court_order": { "type": "object", "description": "{court, case_number, order_date, document}; required for court_order." }, "holding_company_minutes": { "type": "object", "description": "{document, signing_date}: minutes signed by a holding company's representative, only if one voted for a corporate member." }, "consent_reference": { "type": "string", "description": "ACRA's reference for Minister's consent under s29; required when the current constitution has the s29 lock." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "amendment_scope", "amended_constitution", "amendment_summary", "resolution_method" ], "description": "Alters a Singapore company's constitution by special resolution, or adopts the model constitution, and lodges the resolution and the altered constitution with ACRA within 14 days. Also lodges a court order that alters it." }, "Create_sg_constitution_amend": { "type": "object", "properties": { "type": { "const": "sg.constitution.amend" }, "params": { "$ref": "#/components/schemas/Params_sg_constitution_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter the constitution by special resolution", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amended_constitution", "title": "Constitution as altered", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution proposing the alteration", "source": "generated", "required": true }, { "key": "notice_of_general_meeting", "title": "Notice of general meeting", "source": "generated", "required": false }, { "key": "special_resolution", "title": "Members' special resolution altering the constitution", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the general meeting", "source": "generated", "required": false }, { "key": "court_order_copy", "title": "Court order altering the constitution", "source": "uploaded", "required": false }, { "key": "holding_company_minutes", "title": "Minutes signed by a holding company's representative", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "ACRA acknowledgement and Bizfile inbox notification", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Manage > File Alteration of Constitution > Alteration under s26", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "minister_consent_required", "type": "requirement_error", "when": "The current constitution has a s29 lock and no consent_reference is given; run sg.constitution.request_consent first." }, { "code": "special_resolution_threshold_not_met", "type": "requirement_error", "when": "A written resolution is short of 75% of total voting rights." }, { "code": "notice_period_too_short", "type": "requirement_error", "when": "Meeting notice is under 14 days or 21 days without 95% consent to short notice." }, { "code": "objects_alteration_detected", "type": "requirement_error", "when": "The amendment changes the company's objects; use sg.constitution.amend_objects." }, { "code": "court_order_details_required", "type": "invalid_request_error", "when": "resolution_method is court_order and court_order is missing or incomplete." }, { "code": "late_penalty_acknowledgement_required", "type": "requirement_error", "when": "The resolution is over 14 days old and acknowledge_late_penalty is not true." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_constitution_amend_objects": { "type": "object", "properties": { "amended_constitution": { "type": "string", "pattern": "^doc_", "description": "The complete constitution with the altered objects." }, "objects_summary": { "type": "string", "description": "The description of the resolution for Bizfile: what is added, removed or changed." }, "notice_sent_date": { "type": "string", "format": "date", "description": "Date written notice of the resolution went to all members and debenture holders or trustees; at least 21 days before the meeting (s33-)." }, "notice_dispensed_by_court": { "type": "string", "pattern": "^doc_", "description": "A court order dispensing with the notice (s33); skips the 21-day check." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution", "sole_member_resolution" ], "description": "How the resolution is passed." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting; required for general_meeting." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed; derived from the meeting or last signature if omitted." }, "court_challenge": { "type": "object", "description": "{status, determination_date, court_order}; status none, pending or determined." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "amended_constitution", "objects_summary", "notice_sent_date", "resolution_method" ], "description": "Alters the objects in a Singapore company's constitution. The company gives 21 days' notice and passes a special resolution; holders of at least 5% then have 21 days to ask the court to cancel it." }, "Create_sg_constitution_amend_objects": { "type": "object", "properties": { "type": { "const": "sg.constitution.amend_objects" }, "params": { "$ref": "#/components/schemas/Params_sg_constitution_amend_objects" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter the company's objects", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amended_constitution", "title": "Constitution with the altered objects", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution proposing the alteration", "source": "generated", "required": true }, { "key": "notice_of_proposed_resolution", "title": "Written notice of the proposed special resolution", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution altering the objects", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the general meeting", "source": "generated", "required": false }, { "key": "court_order_copy", "title": "Court order on any application to cancel", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "ACRA acknowledgement and Bizfile inbox notification", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Manage > File Alteration of Constitution > Alteration to alter objects under s33", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "notice_period_too_short", "type": "requirement_error", "when": "Fewer than 21 days passed between notice_sent_date and the meeting and no court dispensation is on file." }, { "code": "lodgement_window_not_open", "type": "requirement_error", "when": "The 21-day period or any court application has not ended; Entiva holds the filing and sets a deadline.upcoming event." }, { "code": "lodgement_window_missed", "type": "requirement_error", "when": "The 14-day lodgement period has passed; the customer must agree next steps with a partner." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_constitution_consent_request": { "type": "object", "properties": { "constitution_clauses": { "type": "array", "items": {}, "description": "List of {clause, proposed_alteration}: each clause to alter and the proposed alteration, as ACRA requires." }, "reason_for_alteration": { "type": "string", "description": "Why the company wants the alteration; ACRA requires the explanation." }, "current_constitution": { "type": "string", "pattern": "^doc_", "description": "The constitution as it stands, showing the s29 provision." }, "proposed_amended_constitution": { "type": "string", "pattern": "^doc_", "description": "The constitution as it would read after the alteration." }, "third_party_approvals": { "type": "array", "items": {}, "description": "List of document_ref: approvals the alteration needs from third parties, such as a regulator or funder." }, "is_registered_charity": { "type": "boolean", "description": "Whether the company is a registered charity under the Charities Act 1994; ACRA's eService asks." }, "previous_s29_approval_in_force": { "type": "boolean", "description": "Whether an earlier s29 approval is still in force; ACRA's eService asks." } }, "required": [ "constitution_clauses", "reason_for_alteration", "current_constitution", "proposed_amended_constitution", "is_registered_charity", "previous_s29_approval_in_force" ], "description": "For a company whose constitution cannot be altered without the Minister's consent (s29), which follows the Registrar's approval to drop 'Limited' from the name. Entiva files the application for consent." }, "Create_sg_constitution_consent_request": { "type": "object", "properties": { "type": { "const": "sg.constitution_consent.request" }, "params": { "$ref": "#/components/schemas/Params_sg_constitution_consent_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Ask for Minister's consent to alter the constitution", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "current_constitution", "title": "Current constitution", "source": "uploaded", "required": true }, { "key": "proposed_amended_constitution", "title": "Proposed altered constitution", "source": "uploaded", "required": true }, { "key": "consent_request_statement", "title": "Statement of clauses, proposed alterations and reasons", "source": "generated", "required": true }, { "key": "third_party_approvals", "title": "Third-party approvals", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Directors' resolution authorising the request", "source": "generated", "required": true }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "ACRA acknowledgement and Bizfile inbox notification", "source": "registry_issued", "required": true }, { "key": "consent_decision", "title": "ACRA decision on the Minister's consent", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Manage > File Alteration of Constitution > Alteration for Minister's consent und", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "no_s29_lock_found", "type": "requirement_error", "when": "The current constitution has no provision barring alteration without consent; use sg.constitution.amend." }, { "code": "consent_declined", "type": "registry_error", "when": "ACRA records that consent was declined; the action moves to rejected with ACRA's reasons." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_cooperative_by_laws_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cooperative_society" ], "description": "Only a co-operative society registered under the Co-operative Societies Act 1979 can take this action.", "examples": [ "cooperative_society" ] }, "cooperative_kind": { "type": "string", "enum": [ "credit", "non_credit" ], "description": "The Registry publishes separate model by-laws for credit and non-credit co-ops, last updated 4 February 2025.", "examples": [ "non_credit" ] }, "general_meeting_type": { "type": "string", "enum": [ "agm", "egm" ], "description": "The meeting that adopted the amendments.", "examples": [ "agm" ] }, "general_meeting_date": { "type": "string", "format": "date", "description": "The date of the meeting.", "examples": [ "2026-10-10" ] }, "meeting_notice_sent_date": { "type": "string", "format": "date", "description": "The date the notice, with the table of amendments appended, was made available to members.", "examples": [ "2026-09-22" ] }, "reduced_quorum_meeting": { "type": "boolean", "description": "True if the meeting went ahead on a reduced quorum after a postponement.", "examples": [ "false" ] }, "membership_counts": { "type": "object", "description": "The figures the Registry's application form asks for, as numbers and vote entitlement for founder_members, institutional_members and personal_members, in three." }, "amendments": { "type": "array", "items": {}, "description": "The proposed changes, in the Registry's table format." }, "registry_comments_requested_on": { "type": "string", "format": "date", "description": "The date the draft table was sent to the Registry for comments." }, "signatory_role": { "type": "string", "enum": [ "chairman", "secretary" ], "description": "Who signs the application, the resolution extract and every page of the table.", "examples": [ "secretary" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "The person who signs, in the role given by signatory_role." } }, "required": [ "entity_type", "cooperative_kind", "general_meeting_type", "general_meeting_date", "meeting_notice_sent_date", "reduced_quorum_meeting", "membership_counts", "amendments", "signatory_role", "signatory" ], "description": "Register amended by-laws with the Registry of Co-operative Societies. The co-op adopts the amendments by a three-quarters vote at a general meeting." }, "Create_sg_cooperative_by_laws_amend": { "type": "object", "properties": { "type": { "const": "sg.cooperative_by_laws.amend" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_by_laws_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a co-operative society's by-laws", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "table_of_amendments", "title": "Table of by-law amendments", "source": "generated", "required": true }, { "key": "application_for_registration", "title": "Application for registration of amended by-law", "source": "generated", "required": true }, { "key": "resolution_extract", "title": "Extract of the general meeting resolution", "source": "generated", "required": true }, { "key": "meeting_notice", "title": "Notice of the meeting with the table appended", "source": "uploaded", "required": false }, { "key": "registry_comments", "title": "Registry's comments on the draft table", "source": "uploaded", "required": false }, { "key": "registration_letter", "title": "Registrar's letter registering the amendments", "source": "registry_issued", "required": false }, { "key": "updated_by_laws", "title": "Updated by-laws incorporating the amendments", "source": "generated", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "application_for_registration", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resolution_extract", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "table_of_amendments", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Application for registration of amended by-law", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "reduced_quorum_cannot_amend", "type": null, "when": "reduced_quorum_meeting is true." }, { "code": "three_quarters_not_met", "type": null, "when": "The votes in favour are below three-quarters of members present and voting, on both the head-count and the vote-entitlement figures entered." }, { "code": "notice_period_too_short", "type": null, "when": "Fewer than 15 clear days or the by-laws' notice period between meeting_notice_sent_date and the meeting." }, { "code": "application_window_passed", "type": null, "when": "More than 14 days have passed since the meeting." }, { "code": "table_not_signed", "type": null, "when": "A page of the table of amendments is unsigned." }, { "code": "signatory_not_verified", "type": null, "when": "The Chairman or Secretary has not completed verification." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a co-operative society." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses to register the amendments, with written reasons, or rejects an incomplete application." } ] } }, "Params_sg_entity_particulars_change": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date of the change; ACRA's clock runs from it.", "examples": [ "2026-10-16" ] }, "entity_email": { "type": "string", "description": "The entity email ACRA holds." }, "primary_activity": { "type": "object", "description": "{ssic_code, description}." }, "secondary_activity": { "type": "object", "description": "{ssic_code, description}." }, "additional_activities": { "type": "array", "items": {}, "description": "List of {ssic_code, description}." }, "registers_location": { "type": "object", "description": "{registers, address}. registers: register_of_members_and_index, branch_register_of_members, register_of_debenture_holders." }, "office_hours": { "type": "object", "description": "{hours_per_business_day, working_hours_option}, only where Bizfile asks; the companies' minimum-hours rule ends 20 Oct 2026." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "effective_date" ], "description": "Updates entity details ACRA holds that are neither the name nor the address: entity email, primary and secondary business activities, where the register of members and similar registers are kept, and registered-office opening hours.." }, "Create_sg_entity_particulars_change": { "type": "object", "properties": { "type": { "const": "sg.entity_particulars.change" }, "params": { "$ref": "#/components/schemas/Params_sg_entity_particulars_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update other entity particulars", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "particulars_authorisation", "title": "Officer's authorisation of the change", "source": "generated", "required": true }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "updated_business_profile", "title": "Updated ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "particulars_authorisation", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Entity information > Edit", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_supplied", "type": "invalid_request_error", "when": "No field to change was given besides effective_date." }, { "code": "field_not_supported", "type": "invalid_request_error", "when": "The request changes the name, registered office, officers, shares or a mailing address." }, { "code": "late_penalty_acknowledgement_required", "type": "requirement_error", "when": "effective_date is past the filing window and acknowledge_late_penalty is not true." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_financial_year_end_change": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "The revised financial year end date.", "examples": [ "2027-03-31" ] }, "financial_year_affected": { "type": "string", "enum": [ "current", "immediately_previous" ], "description": "Which year changes." }, "reason": { "type": "string", "description": "Required when ACRA approval is needed: new year over 18 months, or a change within 5 years of an earlier one." }, "supporting_document": { "type": "string", "pattern": "^doc_", "description": "A PDF explaining the reason, for the same two cases." } }, "required": [ "financial_year_end" ], "description": "Changes a company's or VCC's financial year end. A local company may change the current or immediately previous year unless it has missed the AGM, annual return or financial statements deadline." }, "Create_sg_financial_year_end_change": { "type": "object", "properties": { "type": { "const": "sg.financial_year_end.change" }, "params": { "$ref": "#/components/schemas/Params_sg_financial_year_end_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the financial year end", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the new financial year end", "source": "generated", "required": true }, { "key": "approval_reason", "title": "Reason for the change", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "ACRA acknowledgement and Bizfile inbox notification", "source": "registry_issued", "required": true }, { "key": "acra_approval", "title": "ACRA approval of the change", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Local company: Bizfile > Manage > Local company > Update change of financial year end date", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "fye_change_blocked_overdue_filings", "type": "requirement_error", "when": "A local company has missed the AGM, annual return or financial statements deadline, so ACRA bars the change." }, { "code": "financial_year_not_eligible", "type": "invalid_request_error", "when": "The year is not the current or the immediately previous financial year." }, { "code": "approval_reason_required", "type": "requirement_error", "when": "ACRA approval is needed and reason or supporting_document is missing." }, { "code": "registry_approval_declined", "type": "registry_error", "when": "ACRA declines a change that needed its approval; the action moves to rejected with ACRA's reasons." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_foreign_company_constitution_change": { "type": "object", "properties": { "change_types": { "type": "array", "items": {}, "description": "What changed: any of constitutional_documents, business_activity, legal_structure." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect in the home jurisdiction; the 30 days run from it.", "examples": [ "2026-10-02" ] }, "document_type": { "type": "string", "enum": [ "charter", "statute", "memorandum", "articles_of_association", "memorandum_and_articles", "other_constitutional_instrument" ], "description": "Kind of instrument lodged; required for constitutional_documents." }, "amended_instrument": { "type": "string", "pattern": "^doc_", "description": "The amended instrument, notarised or certified as a true copy by a notary public; required for constitutional_documents." }, "certification_route": { "type": "string", "enum": [ "home_notary_public", "singapore_notary_public" ], "description": "Where the notary acted; ACRA accepts a notary public in the home jurisdiction or in Singapore." }, "translation": { "type": "string", "pattern": "^doc_", "description": "Certified English translation; required if the instrument is not in English." }, "translation_certifier": { "type": "string", "enum": [ "official_holding_original", "home_notary_or_sworn_translator", "singapore_consular_officer", "acra_approved_person_in_singapore" ], "description": "Who certified the translation." }, "home_approval_evidence": { "type": "string", "pattern": "^doc_", "description": "Proof the foreign company approved or registered the change at home." }, "nature_of_business": { "type": "string", "description": "{primary_activity, secondary_activity}, each {ssic_code, description}; required for business_activity." }, "legal_structure": { "type": "object", "description": "{new_legal_form, home_registration_number, description}; required for legal_structure." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "change_types", "effective_date" ], "description": "Lodges changes a foreign company made at home to its charter, statute or memorandum and articles, and any change to its business activity or legal structure, with ACRA within 30 days. Constitutional documents must be notarised or certified." }, "Create_sg_foreign_company_constitution_change": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_constitution.change" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_constitution_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Foreign company branch: lodge changes to its charter or constitution", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_amended_instrument", "title": "Amended charter, statute or memorandum and articles, notarised or certified as a true copy", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "home_approval_evidence", "title": "Evidence of the change at home", "source": "uploaded", "required": false }, { "key": "authorised_representative_instruction", "title": "Authorised representative's filing instruction", "source": "generated", "required": true }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "bizfile_acknowledgement", "title": "ACRA acknowledgement and Bizfile inbox notification", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "certified_amended_instrument", "signer_role": "notary", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "other", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "authorised_representative_instruction", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Entity information > Edit > charter, statute, memorandum, articles or other cons", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "certified_copy_required", "type": "requirement_error", "when": "The instrument is not notarised or certified by a notary public." }, { "code": "translation_required", "type": "requirement_error", "when": "The instrument is not in English and no certified translation is attached." }, { "code": "legal_structure_review_required", "type": "requirement_error", "when": "change_types includes legal_structure; ACRA's pages describe no Bizfile step for it, so a partner decides how to file." }, { "code": "late_penalty_acknowledgement_required", "type": "requirement_error", "when": "effective_date is over 30 days ago and acknowledge_late_penalty is not true." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_foreign_company_name_change": { "type": "object", "properties": { "name": { "type": "string", "description": "The foreign company's new name exactly as in its home registry." }, "head_office_change_date": { "type": "string", "format": "date", "description": "Date the head office's name change took effect; the 30 days run from it.", "examples": [ "2026-10-09" ] }, "home_name_change_evidence": { "type": "string", "pattern": "^doc_", "description": "Home registry certificate or other proof." }, "name_application_transaction_number": { "type": "string", "description": "An already-approved ACRA name application; Entiva then skips the application if the reservation has not expired." }, "name_consent_letter": { "type": "string", "pattern": "^doc_", "description": "Consent from the owner of an existing business with an identical name." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "name", "head_office_change_date", "home_name_change_evidence" ], "description": "Changes the Singapore registered name of a foreign company branch after the head office renames, within 30 days. Entiva applies to ACRA for the new name first, then updates the entity information once ACRA approves it." }, "Create_sg_foreign_company_name_change": { "type": "object", "properties": { "type": { "const": "sg.foreign_company_name.change" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Foreign company branch: change its registered name", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "home_name_change_evidence", "title": "Home registry proof of the name change", "source": "uploaded", "required": true }, { "key": "authorised_representative_instruction", "title": "Authorised representative's filing instruction", "source": "generated", "required": true }, { "key": "name_application_result", "title": "ACRA name approval notification", "source": "registry_issued", "required": true }, { "key": "name_consent_letter", "title": "Letter of consent for an identical name", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "updated_business_profile", "title": "Updated ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "authorised_representative_instruction", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile in two steps. 1) Apply for new business entity name", "channel": "online", "government_fee": { "amount": 15, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "home_evidence_required", "type": "requirement_error", "when": "home_name_change_evidence is missing or does not show the new name." }, { "code": "name_unavailable", "type": "registry_error", "when": "ACRA refuses the name in Singapore as undesirable or identical to an existing or reserved name; a consent letter or name review may help." }, { "code": "late_penalty_acknowledgement_required", "type": "requirement_error", "when": "head_office_change_date is over 30 days ago and acknowledge_late_penalty is not true." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_llp_name_change": { "type": "object", "properties": { "name": { "type": "string", "description": "Full proposed name with the LLP suffix, such as 'Orchard Advisory LLP'." }, "name_application_transaction_number": { "type": "string", "description": "Approved ACRA name application for this LLP; Entiva skips the S$15 application if the reservation is still valid." }, "name_consent_letter": { "type": "string", "pattern": "^doc_", "description": "Consent from the owner of an existing business with an identical name." } }, "required": [ "name" ], "description": "Changes a Singapore LLP's name. Entiva applies to ACRA for the new name, collects the partners' approval and updates the entity name in Bizfile with the approved application." }, "Create_sg_llp_name_change": { "type": "object", "properties": { "type": { "const": "sg.llp_name.change" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change an LLP's name", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_consent", "title": "Partners' written approval of the new name", "source": "generated", "required": true }, { "key": "name_application_result", "title": "ACRA name approval notification", "source": "registry_issued", "required": true }, { "key": "name_consent_letter", "title": "Letter of consent for an identical name", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "updated_business_profile", "title": "Updated ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "manager", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_consent", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile: Register > Apply for new business entity name", "channel": "online", "government_fee": { "amount": 15, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "name_unavailable", "type": "registry_error", "when": "ACRA refuses the name as undesirable or identical to an existing or reserved name." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_notice_of_error_file": { "type": "object", "properties": { "target_transaction_number": { "type": "string", "description": "Transaction number of the filing that contains the error; Entiva checks it against the entity's filing history." }, "error_category": { "type": "string", "enum": [ "clerical_typographical", "other_error" ], "description": "clerical_typographical: unintended slips that harm no one. other_error: larger mistakes such as a duplicate filing or wrong cessation, where ACRA wants it." }, "corrections": { "type": "array", "items": {}, "description": "List of {field, filed_value, correct_value}." }, "explanation": { "type": "string", "description": "How the error happened and why the corrected value is right; for other_error, also why no one is disadvantaged." }, "confirm_unintended_no_prejudice": { "type": "boolean", "description": "The officer confirms the error was unintended and no person is disadvantaged." }, "supporting_documents": { "type": "array", "items": {}, "description": "List of document_ref proving the correct information." }, "urgent": { "type": "boolean", "description": "True for an urgent notice on an annual return, financial statements or other data; ACRA then wants General Lodgement 'Others'." }, "acknowledge_non_refundable_fee": { "type": "boolean", "description": "Acknowledges the S$60 fee is non-refundable, even if the notice is withdrawn, rejected or appealed." } }, "required": [ "target_transaction_number", "error_category", "corrections", "explanation", "confirm_unintended_no_prejudice", "acknowledge_non_refundable_fee" ], "description": "Corrects a filing already made with ACRA: a clerical or typographical slip, or another error that was unintended and harms no one. Entiva's CSP files a Notice of Error through Bizfile General Lodgement." }, "Create_sg_notice_of_error_file": { "type": "object", "properties": { "type": { "const": "sg.notice_of_error.file" }, "params": { "$ref": "#/components/schemas/Params_sg_notice_of_error_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Notice of Error to correct a registry filing", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "error_correction_confirmation", "title": "Officer's confirmation of the error and correction", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Documents proving the correct information", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "noe_outcome", "title": "ACRA's emailed outcome of the Notice of Error", "source": "registry_issued", "required": true }, { "key": "corrected_business_profile", "title": "Business Profile showing the corrected information", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "error_correction_confirmation", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Manage > File Notice of Error", "channel": "online", "government_fee": { "amount": 60, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "transaction_not_found", "type": "invalid_request_error", "when": "target_transaction_number matches no filing in the entity's history." }, { "code": "use_revised_financial_statements", "type": "requirement_error", "when": "The error is in an annual return or XBRL financial statements; ACRA uses revised financial statements, which this action does not cover." }, { "code": "share_error_not_supported", "type": "requirement_error", "when": "" }, { "code": "unintended_error_not_shown", "type": "requirement_error", "when": "For other_error, the explanation or confirmation does not show the error was unintended and harms no one." }, { "code": "noe_rejected", "type": "registry_error", "when": "ACRA rejects the notice; a new notice costs S$60 again." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_registered_address_change": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address", "description": "The new registered office or principal place of business: a Singapore address with a postal code that Bizfile validates." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change takes effect; ACRA's clock runs from it.", "examples": [ "2026-11-02" ] }, "address_service": { "type": "string", "enum": [ "customer_provided", "entiva_provided" ], "description": "Who supplies the address. entiva_provided is a CSP registered-office service and needs completed due diligence." }, "office_hours": { "type": "object", "description": "{hours_per_business_day, working_hours_option}." }, "move_registers": { "type": "boolean", "description": "Companies only; default true." }, "premises_evidence": { "type": "string", "pattern": "^doc_", "description": "Lease or occupier consent." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Set true to acknowledge ACRA's late lodgement penalty when the filing window has passed." } }, "required": [ "address", "effective_date", "address_service" ], "description": "Moves a Singapore entity to a new registered office or principal place of business and reports it to ACRA within 14 days. Entiva's CSP files it, keeps the statutory registers with the new address, and starts the address service when." }, "Create_sg_registered_address_change": { "type": "object", "properties": { "type": { "const": "sg.registered_address.change" }, "params": { "$ref": "#/components/schemas/Params_sg_registered_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered office or business address", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_approval", "title": "Written approval of the change", "source": "generated", "required": true }, { "key": "premises_evidence", "title": "Proof of right to use the new address", "source": "uploaded", "required": false }, { "key": "address_service_agreement", "title": "Entiva registered-office service terms", "source": "generated", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "updated_business_profile", "title": "Updated ACRA Business Profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "change_approval", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "address_service_agreement", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile > Update entity information > Registered office address and office hours", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "invalid_postal_code", "type": "invalid_request_error", "when": "The postal code does not match a Singapore address, or the country is not SG." }, { "code": "office_hours_required", "type": "invalid_request_error", "when": "A company's effective_date is before 2026-10-20 and office_hours is missing." }, { "code": "cdd_incomplete", "type": "requirement_error", "when": "address_service is entiva_provided but due diligence is incomplete (CSP Act s17)." }, { "code": "late_penalty_acknowledgement_required", "type": "requirement_error", "when": "effective_date is past the filing window and acknowledge_late_penalty is not true." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_society_address_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_society" ], "description": "Only a society registered under the Societies Act can take this action.", "examples": [ "registered_society" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "The new registered address." }, "address_kind": { "type": "string", "enum": [ "physical_premises", "virtual_office" ], "description": "ROS accepts a physical location or a virtual office.", "examples": [ "physical_premises" ] }, "premises_owner_category": { "type": "string", "enum": [ "community_centre", "government_agency_or_statutory_board", "school", "hospital", "other" ], "description": "Who runs the premises.", "examples": [ "other" ] }, "address_not_prohibited_confirmed": { "type": "boolean", "description": "Confirms the address is none of ROS's prohibited types: an HDB flat, a PO Box, an undeveloped site, mobile premises such as a container, an unofficial address.", "examples": [ "true" ] }, "annual_returns_up_to_date": { "type": "boolean", "description": "Confirms the society's latest annual return is filed.", "examples": [ "true" ] }, "president": { "type": "string", "pattern": "^per_", "description": "The society's President, who verifies and submits in ROS eServices." }, "secretary": { "type": "string", "pattern": "^per_", "description": "The society's Secretary, who verifies and submits in ROS eServices." } }, "required": [ "entity_type", "registered_office", "address_kind", "premises_owner_category", "address_not_prohibited_confirmed", "annual_returns_up_to_date", "president", "secretary" ], "description": "Apply to the Registry of Societies for permission to change a registered society's address. ROS publishes a Gazette notice and updates the constitution." }, "Create_sg_society_address_change": { "type": "object", "properties": { "type": { "const": "sg.society_address.change" }, "params": { "$ref": "#/components/schemas/Params_sg_society_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a society's registered address", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "authority_consent_letter", "title": "Letter of consent from the premises authority", "source": "uploaded", "required": false }, { "key": "ros_application", "title": "ROS eServices application pack", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of the change of address", "source": "registry_issued", "required": false }, { "key": "ros_outcome_notice", "title": "ROS outcome email", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ros_application", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "ROS eServices: Change of Registered Address application", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "annual_return_outstanding", "type": null, "when": "The latest annual return has not been filed, so ROS will not process the application." }, { "code": "prohibited_address_type", "type": null, "when": "The address is an HDB flat, PO Box, undeveloped site, mobile premises, unofficial address, public place, embassy or High Commission." }, { "code": "authority_consent_required", "type": null, "when": "The premises are a community centre, government agency or statutory board, school or hospital and no letter of consent is uploaded." }, { "code": "attachment_too_large", "type": null, "when": "An attachment is over ROS's 5MB limit." }, { "code": "office_bearer_not_verified", "type": null, "when": "The President or Secretary has not completed verification." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered society." }, { "code": "registry_rejected", "type": null, "when": "ROS refuses permission or the office bearers report a refusal." } ] } }, "Params_sg_society_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_society" ], "description": "Only a society registered under the Societies Act can take this action.", "examples": [ "registered_society" ] }, "current_name": { "type": "string", "description": "The society's registered name." }, "name": { "type": "string", "description": "The new name." }, "annual_returns_up_to_date": { "type": "boolean", "description": "Confirms the society's latest annual return is filed.", "examples": [ "true" ] }, "is_registered_charity": { "type": "boolean", "description": "Whether the society is a registered charity." }, "is_ipc": { "type": "boolean", "description": "Whether the society is an Institution of a Public Character." }, "support_letter_issuer": { "type": "string", "description": "Required when is_registered_charity or is_ipc is true: the Commissioner of Charities or the named Sector Administrator." }, "agency_support_required": { "type": "boolean", "description": "True when the proposed name uses a word that needs a government agency's or an international parent organisation's support." }, "general_meeting_date": { "type": "string", "format": "date", "description": "The date the members passed the name-change resolution." }, "president": { "type": "string", "pattern": "^per_", "description": "The society's President, who verifies and submits in ROS eServices." }, "secretary": { "type": "string", "pattern": "^per_", "description": "The society's Secretary, who verifies and submits in ROS eServices." } }, "required": [ "entity_type", "current_name", "name", "annual_returns_up_to_date", "is_registered_charity", "is_ipc", "agency_support_required", "president", "secretary" ], "description": "Apply to the Registry of Societies for permission to change a registered society's name. ROS publishes a Gazette notice and updates the constitution." }, "Create_sg_society_name_change": { "type": "object", "properties": { "type": { "const": "sg.society_name.change" }, "params": { "$ref": "#/components/schemas/Params_sg_society_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a society's name", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_meeting_minutes", "title": "General meeting minutes or resolution extract", "source": "uploaded", "required": false }, { "key": "charity_support_letter", "title": "Letter of support", "source": "uploaded", "required": false }, { "key": "agency_support_letter", "title": "Agency or parent organisation's letter of support", "source": "uploaded", "required": false }, { "key": "ros_application", "title": "ROS eServices application pack", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of the name change", "source": "registry_issued", "required": false }, { "key": "ros_outcome_notice", "title": "ROS outcome email", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "ROS eServices: Change of Name application", "channel": "online", "government_fee": { "amount": 70, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "annual_return_outstanding", "type": null, "when": "The latest annual return has not been filed, so ROS will not process the application." }, { "code": "name_too_similar", "type": null, "when": "proposed_name is the same as, or so close to, an existing registered society or entity name that it could mislead." }, { "code": "agency_support_letter_required", "type": null, "when": "agency_support_required is true and no letter of support is uploaded." }, { "code": "charity_support_letter_required", "type": null, "when": "is_registered_charity or is_ipc is true and the letter of support or the general meeting resolution is missing." }, { "code": "attachment_too_large", "type": null, "when": "An attachment is over ROS's 5MB limit." }, { "code": "office_bearer_not_verified", "type": null, "when": "The President or Secretary has not completed verification." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered society." }, { "code": "registry_rejected", "type": null, "when": "ROS refuses permission or the office bearers report a refusal." } ] } }, "Params_sg_society_rules_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_society" ], "description": "Only a society registered under the Societies Act can take this action.", "examples": [ "registered_society" ] }, "annual_returns_up_to_date": { "type": "boolean", "description": "Confirms the society's latest annual return is filed.", "examples": [ "true" ] }, "amendments": { "type": "array", "items": {}, "description": "The proposed changes." }, "general_meeting_date": { "type": "string", "format": "date", "description": "The date of the general meeting where members approve the amendments, past or planned." }, "is_registered_charity": { "type": "boolean", "description": "Whether the society is a registered charity." }, "is_ipc": { "type": "boolean", "description": "Whether the society is an Institution of a Public Character." }, "support_letter_issuer": { "type": "string", "description": "Required when is_registered_charity or is_ipc is true: the Commissioner of Charities or the named Sector Administrator who issued the letter of support." }, "president": { "type": "string", "pattern": "^per_", "description": "The society's President, who verifies and submits in ROS eServices." }, "secretary": { "type": "string", "pattern": "^per_", "description": "The society's Secretary, who verifies and submits in ROS eServices." } }, "required": [ "entity_type", "annual_returns_up_to_date", "amendments", "is_registered_charity", "is_ipc", "president", "secretary" ], "description": "Apply to the Registry of Societies for approval to amend a registered society's rules. Entiva prepares the Word amendments and the pack." }, "Create_sg_society_rules_amend": { "type": "object", "properties": { "type": { "const": "sg.society_rules.amend" }, "params": { "$ref": "#/components/schemas/Params_sg_society_rules_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a society's rules", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "proposed_amendments", "title": "Proposed amendments", "source": "generated", "required": true }, { "key": "general_meeting_minutes", "title": "General meeting minutes or resolution extract", "source": "uploaded", "required": true }, { "key": "charity_support_letter", "title": "Letter of support", "source": "uploaded", "required": false }, { "key": "ros_application", "title": "ROS eServices application pack", "source": "generated", "required": true }, { "key": "ros_outcome_notice", "title": "ROS outcome email", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_application", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "ROS eServices: Amendment of Rules application, with the proposed amendments as a .docx on ", "channel": "online", "government_fee": { "amount": 130, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "annual_return_outstanding", "type": null, "when": "The latest annual return has not been filed, so ROS will not process the application." }, { "code": "use_name_or_address_action", "type": null, "when": "The amendments change only the society's name or registered address." }, { "code": "charity_support_letter_required", "type": null, "when": "is_registered_charity or is_ipc is true and no letter of support is uploaded." }, { "code": "amendments_not_docx", "type": null, "when": "The proposed amendments are not a Word file." }, { "code": "attachment_too_large", "type": null, "when": "An attachment is over ROS's 5MB limit." }, { "code": "office_bearer_not_verified", "type": null, "when": "The President or Secretary has not completed verification." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered society." }, { "code": "registry_rejected", "type": null, "when": "ROS refuses the amendments or the office bearers report a refusal." } ] } }, "Params_sg_vcc_name_change": { "type": "object", "properties": { "target": { "type": "string", "enum": [ "vcc", "sub_fund" ], "description": "What is renamed." }, "sub_fund_name": { "type": "string", "description": "Current name of the sub-fund; required when target is sub_fund." }, "name": { "type": "string", "description": "Full proposed name with any legal suffix." }, "reason": { "type": "string", "enum": [ "voluntary", "acra_directed" ], "description": "Default voluntary. acra_directed is a change directed under VCC Act s21, which ACRA charges at S$200." }, "name_application_transaction_number": { "type": "string", "description": "An already-approved ACRA name application; Entiva then skips the S$15 application if the reservation has not expired." }, "name_consent_letter": { "type": "string", "pattern": "^doc_", "description": "Consent from the owner of an existing business with an identical name." }, "members_resolution": { "type": "string", "pattern": "^doc_", "description": "A members' resolution approving the name, if Entiva review finds one is required." } }, "required": [ "target", "name" ], "description": "Changes the name of a variable capital company or one of its sub-funds. Entiva's CSP applies for the name and updates it in VCC eServices; ACRA may refer the name to other agencies." }, "Create_sg_vcc_name_change": { "type": "object", "properties": { "type": { "const": "sg.vcc_name.change" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a VCC or sub-fund name", "x-entiva": { "jurisdiction": "sg", "stage": "changes", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the new name", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution approving the new name", "source": "generated", "required": false }, { "key": "name_application_result", "title": "ACRA name approval notification", "source": "registry_issued", "required": true }, { "key": "name_consent_letter", "title": "Letter of consent for an identical name", "source": "uploaded", "required": false }, { "key": "bizfile_submission", "title": "Bizfile transaction prepared by Entiva and submitted by its CSP", "source": "generated", "required": true }, { "key": "updated_vcc_profile", "title": "Updated VCC profile under the new name", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bizfile_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC eServices: name application for the VCC or sub-fund, then update of VCC information. A", "channel": "online", "government_fee": { "amount": 15, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": "jurisdiction_error", "when": "The entity type is not covered by this action." }, { "code": "name_unavailable", "type": "registry_error", "when": "ACRA or a referral authority refuses the name." }, { "code": "registry_rejected", "type": "registry_error", "when": "ACRA rejects the filing; the action moves to rejected with ACRA's reasons." } ] } }, "Params_sg_company_continue_in": { "type": "object", "properties": { "target_entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares" ], "description": "Singapore company type after transfer." }, "name": { "type": "string", "description": "Name of the Singapore company.", "examples": [ "Meridian Robotics Holdings Pte. Ltd." ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "foreign_entity": { "type": "object", "description": "{ name, legal_form, jurisdiction, registration_number, date_of_registration, registered_office_address, last_financial_year_end }." }, "registered_foreign_company_uen": { "type": "string", "description": "UEN if the entity is already registered as a foreign company in Singapore." }, "registration_history": { "type": "array", "items": {}, "description": "Earlier transfers of registration or re-domiciliations, in order: [{ name, jurisdiction, date_registered, date_deregistered? }]." }, "singapore_registered_office": { "$ref": "#/components/schemas/Address", "description": "Proposed registered office in Singapore." }, "first_financial_year_end": { "type": "string", "format": "date", "description": "First financial year end after transfer." }, "share_capital": { "type": "object", "description": "{ currency, issued_shares, paid_up_amount, classes: [{ name, rights, issued }] }." }, "directors": { "type": "array", "items": {}, "description": "person_ids of the proposed Singapore directors." }, "secretary": { "type": "string", "pattern": "^per_", "description": "Proposed secretary, ordinarily resident in Singapore." }, "members": { "type": "array", "items": {}, "description": "[{ person_id | entity_id, shares, share_class }]." }, "size_test": { "type": "object", "description": "{ total_assets: money, annual_revenue: money, employees: integer, basis: standalone | consolidated | through_parent, parent_ref? }." }, "solvency_basis": { "type": "string", "enum": [ "directors_opinion", "restructuring_after_registration" ], "description": "directors_opinion: all directors form the solvency opinions ACRA requires. restructuring_after_registration: the entity will be in restructuring or judicial." }, "home_law_authorised": { "type": "boolean", "description": "The entity is authorised by the law of its place of incorporation to transfer its incorporation, and has complied with that law." }, "existing_charges": { "type": "array", "items": {}, "description": "Charges that would need registration under the Companies Act: [{ chargee, description, date_created, amount }]." } }, "required": [ "target_entity_type", "name", "foreign_entity", "singapore_registered_office", "first_financial_year_end", "share_capital", "directors", "secretary", "members", "size_test", "solvency_basis", "home_law_authorised" ], "description": "Moves a foreign body corporate's registration to Singapore so it becomes a Singapore company limited by shares, keeping its identity, assets, liabilities and contracts. Needs a size test, solvency opinions, home-law permission, certified." }, "Create_sg_company_continue_in": { "type": "object", "properties": { "type": { "const": "sg.company.continue_in" }, "params": { "$ref": "#/components/schemas/Params_sg_company_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-domicile a foreign company into Singapore", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "public_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_certificate_of_incorporation", "title": "Certificate of incorporation, certified as a true copy by the home registry official who holds the.", "source": "uploaded", "required": true }, { "key": "certified_home_constitution", "title": "Home-jurisdiction constitution, certified as a true copy", "source": "uploaded", "required": true }, { "key": "certified_translations", "title": "Certified English translations of non-English documents", "source": "uploaded", "required": false }, { "key": "home_authorisation_evidence", "title": "Evidence that home law permits the transfer and that its requirements are met", "source": "uploaded", "required": true }, { "key": "audited_financial_statements", "title": "Audited financial statements for the last financial year in the application", "source": "uploaded", "required": true }, { "key": "proposed_constitution", "title": "Proposed Singapore constitution", "source": "generated", "required": true }, { "key": "foreign_directors_declaration", "title": "Declaration by all directors of the foreign entity", "source": "generated", "required": true }, { "key": "csp_declaration", "title": "Declaration by the corporate service provider", "source": "generated", "required": true }, { "key": "secretary_declaration", "title": "Declaration by the proposed secretary", "source": "generated", "required": true }, { "key": "director_declaration", "title": "Declaration by each proposed Singapore director", "source": "generated", "required": true }, { "key": "lodger_declaration", "title": "Declaration by the lodger", "source": "generated", "required": true }, { "key": "opening_registers", "title": "Opening register of registrable controllers, nominee director register and nominee shareholder.", "source": "generated", "required": true }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Transfer of registration'", "source": "generated", "required": true }, { "key": "name_approval", "title": "ACRA name approval", "source": "registry_issued", "required": true }, { "key": "charges_statement", "title": "Statement of pre-existing charges with prescribed particulars", "source": "generated", "required": false }, { "key": "proof_of_deregistration", "title": "Document showing the entity is deregistered in its place of incorporation", "source": "uploaded", "required": true }, { "key": "share_and_debenture_certificates", "title": "New share and debenture certificates for every holder on the registration date", "source": "generated", "required": true }, { "key": "notice_of_transfer_of_registration", "title": "Notice of transfer of registration", "source": "registry_issued", "required": true }, { "key": "certificate_of_confirmation_of_registration", "title": "Certificate of confirmation of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "foreign_directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "director_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "secretary_declaration", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "csp_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "lodger_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "certified_home_constitution", "signer_role": "company_secretary", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "share_and_debenture_certificates", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "charges_statement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "proof_of_deregistration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Transfer of registration'", "channel": "online", "government_fee": { "amount": 985, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "size_test_not_met", "type": null, "when": "[requirement_error] Fewer than two of: assets over S$10m, revenue over S$10m, more than 50 employees." }, { "code": "solvency_requirement_not_met", "type": null, "when": "[requirement_error] A director cannot give the solvency opinions, or the entity is in liquidation, being wound up, or under judicial management, and solvency_basis does not apply." }, { "code": "home_law_not_permitted", "type": null, "when": "[jurisdiction_error] The law of the place of incorporation does not allow the transfer, or its steps were not completed." }, { "code": "first_financial_year_not_ended", "type": null, "when": "[requirement_error] The entity has not passed its first financial year end in its place of incorporation." }, { "code": "documents_not_certified", "type": null, "when": "[requirement_error] A home document is uncertified, certified by an unaccepted person, outside ACRA's four-month certification timing without approval, or lacks a certified." }, { "code": "name_not_reserved", "type": null, "when": "[registry_error] The name is not reserved, the reservation lapsed, or the company-type choice differs from the application (s 357)." }, { "code": "unsupported_target_type", "type": null, "when": "[invalid_request_error] target_entity_type is unlimited_company or a company limited by guarantee." }, { "code": "resident_director_missing", "type": null, "when": "[requirement_error] No proposed director is ordinarily resident in Singapore (s 145)." }, { "code": "registration_refused", "type": null, "when": "[registry_error] The Registrar refused registration under s 359 or s 360." }, { "code": "deregistration_deadline_missed", "type": null, "when": "[registry_error] Proof of deregistration was not filed within 60 days or an extension; ACRA may revoke the registration after at least 30 days' notice." } ] } }, "Params_sg_company_continue_out": { "type": "object", "properties": { "desired_outcome": { "type": "string", "enum": [ "exit_plan", "transfer_of_registration" ], "description": "exit_plan opens the assisted case. transfer_of_registration asks for a registry transfer out of Singapore and is always refused with." }, "destination_jurisdiction": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the jurisdiction the business is moving to.", "examples": [ "KY" ] }, "destination_entity": { "type": "object", "description": "Existing or intended foreign holding vehicle: { entity_id | name, legal_form }." }, "preferred_route": { "type": "string", "enum": [ "share_swap_into_foreign_holdco", "other", "undecided" ] }, "route_notes": { "type": "string", "description": "Free text for any other route or constraint." }, "singapore_entity_after_exit": { "type": "string", "enum": [ "strike_off", "members_voluntary_winding_up", "keep_as_subsidiary", "undecided" ], "description": "What happens to the Singapore company after the business has moved." }, "target_date": { "type": "string", "format": "date", "description": "Date the customer would like the exit completed." }, "asset_profile": { "type": "object", "description": "{ real_property: boolean, licences_or_permits: boolean, employees: boolean, registered_charges: boolean, intellectual_property: boolean, listed: boolean }." }, "members_consent_in_principle": { "type": "boolean", "description": "All members support the exit in principle." } }, "required": [ "desired_outcome", "destination_jurisdiction", "preferred_route", "singapore_entity_after_exit", "asset_profile", "members_consent_in_principle" ], "description": "No registry procedure for transferring a Singapore company's registration out of Singapore was found, so this action does not file anything. It opens an assisted case in which Entiva and partner Singapore counsel assess the customer's." }, "Create_sg_company_continue_out": { "type": "object", "properties": { "type": { "const": "sg.company.continue_out" }, "params": { "$ref": "#/components/schemas/Params_sg_company_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Plan an exit of a Singapore company to another jurisdiction", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution authorising the assessment and sharing company records with partner counsel", "source": "generated", "required": true }, { "key": "engagement_terms", "title": "Fixed-fee engagement terms for the exit assessment", "source": "generated", "required": true }, { "key": "register_of_members", "title": "Register of members and cap table", "source": "generated", "required": true }, { "key": "latest_financial_statements", "title": "Latest financial statements", "source": "uploaded", "required": true }, { "key": "charges_and_contracts_schedule", "title": "Schedule of charges, key contracts, licences and permits", "source": "uploaded", "required": false }, { "key": "exit_assessment_memo", "title": "Exit assessment memo from partner Singapore counsel", "source": "generated", "required": true }, { "key": "exit_step_plan", "title": "Ordered plan of follow-on Entiva actions with dates", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "engagement_terms", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exit_assessment_memo", "signer_role": "lawyer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. No outward transfer-of-registration procedure was identified in the Companies Act or", "form": "None", "channel": "none", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "outward_redomiciliation_not_available", "type": null, "when": "[jurisdiction_error] desired_outcome is transfer_of_registration." }, { "code": "cdd_not_current", "type": null, "when": "[requirement_error] Customer due diligence on a director, controller or agent has expired or an ID document has lapsed." }, { "code": "listed_company_review_required", "type": null, "when": "[requirement_error] asset_profile.listed is true." }, { "code": "members_consent_missing", "type": null, "when": "[requirement_error] members_consent_in_principle is false and no plan for obtaining consent is on file." } ] } }, "Params_sg_company_convert_to_limited": { "type": "object", "properties": { "target_entity_type": { "type": "string", "enum": [ "private_ltd_shares", "public_ltd_shares" ], "description": "Company type after conversion." }, "name": { "type": "string", "description": "Proposed name of the limited company.", "examples": [ "Cedar Row Holdings Pte. Ltd." ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting that will vote on the special resolution." }, "notice_sent_date": { "type": "string", "format": "date", "description": "Date written notice of the intention to propose the special resolution went to all members and debenture trustees or holders." }, "has_debentures": { "type": "boolean", "description": "True if debentures are outstanding." }, "constitution_option": { "type": "string", "enum": [ "model_constitution", "amend_existing", "custom_upload" ], "description": "Constitution to adopt." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_option is custom_upload." }, "share_capital": { "type": "object", "description": "Issued shares and paid-up capital after conversion: { currency, issued_shares, paid_up_amount }." }, "member_count": { "type": "integer", "description": "Number of members." } }, "required": [ "target_entity_type", "name", "meeting_date", "notice_sent_date", "has_debentures", "constitution_option", "member_count" ], "description": "Converts a Singapore unlimited company to a limited company limited by shares. Needs a special resolution that changes the name and alters the constitution, and a Bizfile 'Convert company type' lodgement (Companies Act s 30)." }, "Create_sg_company_convert_to_limited": { "type": "object", "properties": { "type": { "const": "sg.company.convert_to_limited" }, "params": { "$ref": "#/components/schemas/Params_sg_company_convert_to_limited" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an unlimited company to a limited company", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution proposing the conversion and calling the meeting", "source": "generated", "required": true }, { "key": "s33_notice", "title": "Written notice of intention to propose the special resolution", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution to change status to limited, alter the constitution and change the name", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of the general meeting", "source": "generated", "required": true }, { "key": "altered_constitution", "title": "Altered constitution", "source": "generated", "required": true }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Convert company type'", "source": "generated", "required": true }, { "key": "notice_of_incorporation", "title": "Notice of incorporation showing limited status, stating it is issued under s 30", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate confirming incorporation with the new status (s 30)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Convert company type'", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "conversion_barred", "type": null, "when": "[jurisdiction_error] The company was previously limited and became unlimited under s 30; it cannot convert back (s 30)." }, { "code": "notice_period_too_short", "type": null, "when": "[requirement_error] Less than 21 days between notice_sent_date and meeting_date." }, { "code": "lodgement_window_not_open", "type": null, "when": "[requirement_error] Fewer than 21 days have passed since the resolution, so the copy cannot be lodged yet (s 33)." }, { "code": "court_application_pending", "type": null, "when": "[requirement_error] Holders of at least 5% of shares or debentures applied to the court to cancel the resolution (s 33); the action pauses until the court decides." }, { "code": "member_limit_exceeded", "type": null, "when": "[requirement_error] target_entity_type is private_ltd_shares and more than 50 members are counted under s 18." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] The proposed name is unavailable or refused, or the name application has expired." } ] } }, "Params_sg_company_convert_to_private": { "type": "object", "properties": { "name": { "type": "string", "description": "Proposed name of the private company.", "examples": [ "Northgate Trading Pte. Ltd." ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution is passed, or the scheduled meeting date." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How members pass the special resolution." }, "constitution_option": { "type": "string", "enum": [ "model_constitution", "amend_existing", "custom_upload" ], "description": "Constitution to adopt." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_option is custom_upload." }, "member_count": { "type": "integer", "description": "Number of members counted under s 18: joint holders count as one, and certain current and former employees are not counted." }, "is_listed": { "type": "boolean", "description": "True if the company is listed on an exchange." }, "court_permission_document_id": { "type": "string", "pattern": "^doc_", "description": "Court order allowing reconversion." } }, "required": [ "name", "resolution_date", "resolution_method", "constitution_option", "member_count", "is_listed" ], "description": "Converts a Singapore public company with share capital to a private company by members' special resolution that changes the name and restores the s 18 restrictions, plus a Bizfile 'Convert company type' lodgement (Companies Act s 31)." }, "Create_sg_company_convert_to_private": { "type": "object", "properties": { "type": { "const": "sg.company.convert_to_private" }, "params": { "$ref": "#/components/schemas/Params_sg_company_convert_to_private" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a public company to a private company", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "public_ltd_shares", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution proposing the conversion and calling the meeting", "source": "generated", "required": true }, { "key": "meeting_notice", "title": "Notice of general meeting stating the intention to propose a special resolution", "source": "generated", "required": false }, { "key": "special_resolution", "title": "Special resolution to convert to a private company, change the name and alter the constitution", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of the general meeting", "source": "generated", "required": false }, { "key": "altered_constitution", "title": "Constitution imposing the s 18 restrictions", "source": "generated", "required": true }, { "key": "list_of_shareholders", "title": "List of shareholders in the prescribed form", "source": "generated", "required": true }, { "key": "prescribed_company_information", "title": "Other prescribed information about the company, its members and its officers", "source": "generated", "required": true }, { "key": "court_permission_order", "title": "Court order permitting reconversion to a private company", "source": "uploaded", "required": false }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Convert company type'", "source": "generated", "required": true }, { "key": "notice_of_incorporation", "title": "Notice of incorporation showing private company status", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate confirming incorporation with the new status", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 95, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Convert company type'", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "already_private", "type": null, "when": "[invalid_request_error] The entity is already a private company." }, { "code": "no_share_capital", "type": null, "when": "[jurisdiction_error] The company has no share capital. s 31 covers public companies with a share capital, and a private company must have share capital (s 18)." }, { "code": "member_limit_exceeded", "type": null, "when": "[requirement_error] More than 50 members counted under s 18; the company must reduce its membership before converting." }, { "code": "court_permission_required", "type": null, "when": "[requirement_error] The company became public by a determination under s 32 and no court permission is on file (s 32)." }, { "code": "listed_company_review_required", "type": null, "when": "[requirement_error] is_listed is true; an Entiva review is opened and delisting is handled outside this action." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] The proposed name is unavailable or refused, or the name application has expired." }, { "code": "resolution_threshold_not_met", "type": null, "when": "[requirement_error] Votes cast for the special resolution are below 75%, or notice was shorter than s 184 allows." } ] } }, "Params_sg_company_convert_to_public": { "type": "object", "properties": { "name": { "type": "string", "description": "Proposed name of the public company.", "examples": [ "Harbourline Holdings Limited" ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution is passed, or the scheduled meeting date." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How members pass the special resolution." }, "constitution_option": { "type": "string", "enum": [ "model_constitution", "amend_existing", "custom_upload" ], "description": "Constitution to adopt." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_option is custom_upload." }, "secretary": { "type": "string", "pattern": "^per_", "description": "Company secretary of the public company." }, "intends_public_offer": { "type": "boolean", "description": "True if shares or debentures will be offered to the public after conversion." }, "request_certificate": { "type": "boolean", "description": "Order ACRA's certificate confirming incorporation with the new status (s 31)." } }, "required": [ "name", "resolution_date", "resolution_method", "constitution_option", "secretary", "intends_public_offer" ], "description": "Converts a Singapore private company to a public company by members' special resolution, a statement in lieu of prospectus and a Bizfile 'Convert company type' lodgement (Companies Act s 31). The company keeps its identity and only its." }, "Create_sg_company_convert_to_public": { "type": "object", "properties": { "type": { "const": "sg.company.convert_to_public" }, "params": { "$ref": "#/components/schemas/Params_sg_company_convert_to_public" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a private company to a public company", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "exempt_private_company", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution proposing the conversion and calling the meeting", "source": "generated", "required": true }, { "key": "meeting_notice", "title": "Notice of general meeting stating the intention to propose a special resolution", "source": "generated", "required": false }, { "key": "special_resolution", "title": "Special resolution to convert to a public company and change the name", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of the general meeting", "source": "generated", "required": false }, { "key": "altered_constitution", "title": "Constitution as adopted or altered", "source": "generated", "required": true }, { "key": "statement_in_lieu_of_prospectus", "title": "Statement in lieu of prospectus", "source": "generated", "required": true }, { "key": "s61_2b_declaration", "title": "Declaration verifying compliance with s 61", "source": "generated", "required": true }, { "key": "secretary_qualification_evidence", "title": "Evidence that the secretary meets s 171", "source": "uploaded", "required": true }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Convert company type'", "source": "generated", "required": true }, { "key": "list_of_shareholders", "title": "List of shareholders in the prescribed form", "source": "generated", "required": true }, { "key": "notice_of_incorporation", "title": "Notice of incorporation showing public company status", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate confirming incorporation with the new status", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 95, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_in_lieu_of_prospectus", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "s61_2b_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Convert company type'", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "already_public", "type": null, "when": "[invalid_request_error] The entity is already a public company, or has no share capital." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] The proposed name is unavailable, is refused by ACRA or a referral authority, or the name application has expired." }, { "code": "secretary_not_qualified", "type": null, "when": "[requirement_error] No evidence that the secretary meets s 171." }, { "code": "constitution_prohibits_conversion", "type": null, "when": "[requirement_error] The existing constitution blocks the conversion (s 31 is subject to the constitution) and the resolution does not amend it first." }, { "code": "resolution_threshold_not_met", "type": null, "when": "[requirement_error] Votes cast for the special resolution are below 75%, or notice was shorter than s 184 allows." }, { "code": "public_offer_review_required", "type": null, "when": "[requirement_error] intends_public_offer is true; an Entiva review is opened and the action will not be submitted until it clears." }, { "code": "lodgement_deadline_exceeded", "type": null, "when": "[requirement_error] The resolution is more than 14 days old; late lodgement is an offence with a fine of up to S$1,000 plus a default penalty (s 186), so the customer must confirm." } ] } }, "Params_sg_company_convert_to_unlimited": { "type": "object", "properties": { "name": { "type": "string", "description": "Proposed name of the unlimited company.", "examples": [ "Cedar Row Holdings" ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting that will vote on the special resolution." }, "notice_sent_date": { "type": "string", "format": "date", "description": "Date written notice of the intention to propose the special resolution went to all members and debenture trustees or holders." }, "has_debentures": { "type": "boolean", "description": "True if debentures are outstanding." }, "constitution_option": { "type": "string", "enum": [ "model_constitution", "amend_existing", "custom_upload" ], "description": "Constitution to adopt." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_option is custom_upload." }, "members": { "type": "array", "items": {}, "description": "One entry per member: person_id or entity_id, plus assent_signed_by." }, "unlimited_liability_acknowledged": { "type": "boolean", "description": "Entiva policy: the customer confirms every member understands that liability will no longer be limited." } }, "required": [ "name", "meeting_date", "notice_sent_date", "has_debentures", "constitution_option", "members", "unlimited_liability_acknowledged" ], "description": "Converts a Singapore limited company to an unlimited company. Needs a special resolution that changes the name and constitution, a form of assent signed by or for every member, a declaration that the assenting persons are the whole." }, "Create_sg_company_convert_to_unlimited": { "type": "object", "properties": { "type": { "const": "sg.company.convert_to_unlimited" }, "params": { "$ref": "#/components/schemas/Params_sg_company_convert_to_unlimited" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a limited company to an unlimited company", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution proposing the conversion and calling the meeting", "source": "generated", "required": true }, { "key": "s33_notice", "title": "Written notice of intention to propose the special resolution", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution to change status to unlimited, alter the constitution and change the name", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of the general meeting", "source": "generated", "required": true }, { "key": "altered_constitution", "title": "Altered constitution", "source": "generated", "required": true }, { "key": "form_of_assent", "title": "Form of assent signed by or for all members", "source": "generated", "required": true }, { "key": "whole_membership_declaration", "title": "Declaration that the assenting persons are the whole membership", "source": "generated", "required": true }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Convert company type'", "source": "generated", "required": true }, { "key": "notice_of_incorporation", "title": "Notice of incorporation showing unlimited status, stating it is issued under s 30", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate confirming incorporation with the new status (s 30)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "form_of_assent", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "whole_membership_declaration", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Convert company type'", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "conversion_barred", "type": null, "when": "[jurisdiction_error] The company was previously unlimited and became limited under s 30; it cannot convert back (s 30)." }, { "code": "assent_incomplete", "type": null, "when": "[requirement_error] A member has not assented, or the member list differs from the register of members." }, { "code": "notice_period_too_short", "type": null, "when": "[requirement_error] Less than 21 days between notice_sent_date and meeting_date." }, { "code": "lodgement_window_not_open", "type": null, "when": "[requirement_error] Fewer than 21 days have passed since the resolution, so the copy cannot be lodged yet (s 33)." }, { "code": "court_application_pending", "type": null, "when": "[requirement_error] Holders of at least 5% of shares or debentures applied to the court to cancel the resolution (s 33); the action pauses until the court decides." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] The proposed name is unavailable or refused, or the name application has expired." }, { "code": "guarantee_company_review_required", "type": null, "when": "[requirement_error] The company is limited by guarantee." } ] } }, "Params_sg_company_merge": { "type": "object", "properties": { "route": { "type": "string", "enum": [ "long_form", "short_form_vertical", "short_form_horizontal" ], "description": "long_form: ss 215B-215C. short_form_vertical: a holding company with one or more wholly-owned subsidiaries (s 215D). short_form_horizontal: two or more." }, "merging_companies": { "type": "array", "items": {}, "description": "The other amalgamating companies: [{ entity_id | uen }]." }, "effective_date": { "type": "string", "format": "date", "description": "Intended effective date." }, "amalgamated_company_name": { "type": "string", "description": "Name of the amalgamated company: the continuing company's name or a new name reserved with ACRA (s 215B)." }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "share_conversion_terms": { "type": "object", "description": "Required for long_form (s 215B-): { share_structure, conversions: [{ from_entity, from_class, to_class, ratio }], consideration_in_lieu?: money." }, "amalgamated_company_directors": { "type": "array", "items": {}, "description": "person_ids of the directors of the amalgamated company." }, "constitution_option": { "type": "string", "enum": [ "continuing_company_constitution", "new_constitution" ], "description": "Short-form must use the constitution of the company whose shares are not cancelled (s 215D)." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required for new_constitution." }, "meetings": { "type": "array", "items": {}, "description": "One entry per amalgamating company: { entity_id | uen, meeting_date, member_notice_sent_date, secured_creditor_notice_sent_date, meeting_mode: physical |." }, "secured_creditors": { "type": "array", "items": {}, "description": "Every secured creditor of each amalgamating company: [{ entity_id | uen, name, email, address }]." }, "newspaper_notice": { "type": "object", "description": "Required for long_form: { newspaper, publication_date } for a daily English-language newspaper circulating generally in Singapore (s 215C)." } }, "required": [ "route", "merging_companies", "amalgamated_company_directors", "constitution_option", "meetings", "secured_creditors" ], "description": "Merges two or more Singapore companies so that one of them continues as the amalgamated company and the others are removed from the register. Supports the long-form route and the two short-form routes for a holding company and its." }, "Create_sg_company_merge": { "type": "object", "properties": { "type": { "const": "sg.company.merge" }, "params": { "$ref": "#/components/schemas/Params_sg_company_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amalgamate Singapore companies into one of them", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amalgamation_proposal", "title": "Amalgamation proposal", "source": "generated", "required": false }, { "key": "board_best_interest_resolution", "title": "Board resolution of each amalgamating company that the amalgamation is in its best interest", "source": "generated", "required": false }, { "key": "solvency_statement_amalgamating", "title": "Solvency statement for each amalgamating company", "source": "generated", "required": false }, { "key": "auditor_report", "title": "Auditor's report supporting the solvency statement", "source": "uploaded", "required": false }, { "key": "solvency_statement_amalgamated", "title": "Solvency statement for the amalgamated company", "source": "generated", "required": true }, { "key": "directors_grounds_declaration", "title": "Declaration of each voting director that the conditions are met, with grounds", "source": "generated", "required": true }, { "key": "member_information_pack", "title": "Information pack for members", "source": "generated", "required": false }, { "key": "secured_creditor_notice", "title": "Notice of the proposed amalgamation to secured creditors", "source": "generated", "required": true }, { "key": "newspaper_notice", "title": "Newspaper notice of the proposed amalgamation", "source": "generated", "required": false }, { "key": "meeting_notice", "title": "Notice of general meeting of each amalgamating company", "source": "generated", "required": true }, { "key": "proxy_appointments", "title": "Proxy and corporate representative authorisations", "source": "uploaded", "required": false }, { "key": "members_special_resolution", "title": "Special resolution of each amalgamating company approving the amalgamation", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of each general meeting", "source": "generated", "required": true }, { "key": "approval_compliance_declaration", "title": "Declaration of the directors of each amalgamating company that the amalgamation was approved in.", "source": "generated", "required": true }, { "key": "creditor_prejudice_declaration", "title": "Declaration of the directors of the amalgamated company that no creditor will be prejudiced", "source": "generated", "required": true }, { "key": "amalgamated_constitution", "title": "Constitution of the amalgamated company", "source": "generated", "required": true }, { "key": "director_consents", "title": "Form 45 consents for directors newly appointed, and Form 45B for a new secretary", "source": "generated", "required": false }, { "key": "name_approval", "title": "ACRA name approval", "source": "registry_issued", "required": false }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Register for amalgamation of business entities'", "source": "generated", "required": true }, { "key": "notice_of_amalgamation", "title": "Notice of amalgamation stating the effective date", "source": "registry_issued", "required": true }, { "key": "certificate_of_confirmation_of_amalgamation", "title": "Certificate of confirmation of amalgamation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_best_interest_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_statement_amalgamating", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_statement_amalgamated", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_grounds_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "proxy_appointments", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "approval_compliance_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "creditor_prejudice_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "director_consents", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Register for amalgamation of business entities'", "channel": "online", "government_fee": { "amount": 400, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_wholly_owned", "type": null, "when": "[requirement_error] A short-form route was chosen but the register of members shows a subsidiary that is not wholly owned, or the companies are not holding company and subsidiary." }, { "code": "meeting_required", "type": null, "when": "[requirement_error] A members' written resolution was proposed. ss 215C and 215D require a special resolution at a general meeting." }, { "code": "notice_period_too_short", "type": null, "when": "[requirement_error] Member, secured-creditor or newspaper notice went out less than 21 days before a meeting." }, { "code": "solvency_opinion_unsupported", "type": null, "when": "[requirement_error] A director cannot sign the solvency statement because the financial statements or valuations do not support it." }, { "code": "cross_holdings_not_cancelled", "type": null, "when": "[requirement_error] A long-form proposal converts shares that one amalgamating company holds in another instead of cancelling them for no consideration (s 215B)." }, { "code": "audit_report_required", "type": null, "when": "[requirement_error] An amalgamating company is not audit-exempt and no auditor's report supports its s 215I statement." }, { "code": "court_order_restraining", "type": null, "when": "[registry_error] A member, creditor or other affected person obtained a court order under s 215H stopping, modifying or sending back the proposal." }, { "code": "company_not_singapore", "type": null, "when": "[jurisdiction_error] A merging company is not a Singapore-registered company." } ] } }, "Params_sg_company_merge_into_new": { "type": "object", "properties": { "route": { "type": "string", "enum": [ "long_form" ], "description": "Only the long-form route is offered when the amalgamated company is new." }, "amalgamating_companies": { "type": "array", "items": {}, "description": "At least two Singapore companies: [{ entity_id | uen }]." }, "company": { "type": "object", "description": "The amalgamated company: { name, entity_type, registered_office_address, financial_year_end, directors, secretary_person_id, constitution_option." }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "effective_date": { "type": "string", "format": "date", "description": "Intended effective date, the same as or later than the date ACRA receives the documents (s 215F)." }, "share_conversion_terms": { "type": "object", "description": "{ share_structure, conversions: [{ from_entity, from_class, to_class, ratio }], consideration_in_lieu?: money, other_payments?: [{ payee_person_id, amount }] }." }, "meetings": { "type": "array", "items": {}, "description": "One entry per amalgamating company: { entity_id | uen, meeting_date, member_notice_sent_date, secured_creditor_notice_sent_date, meeting_mode: physical |." }, "secured_creditors": { "type": "array", "items": {}, "description": "Every secured creditor of each amalgamating company: [{ entity_id | uen, name, email, address }]." }, "newspaper_notice": { "type": "object", "description": "{ newspaper, publication_date } for a daily English-language newspaper circulating generally in Singapore (s 215C)." }, "beneficial_owners": { "type": "array", "items": {}, "description": "person_ids or entity_ids expected to hold more than 25% of the new company." } }, "required": [ "route", "amalgamating_companies", "company", "share_conversion_terms", "meetings", "secured_creditors", "newspaper_notice" ], "description": "Merges two or more Singapore companies into a newly registered company, which takes over all their property and liabilities. ACRA registers the new company and removes every amalgamating company." }, "Create_sg_company_merge_into_new": { "type": "object", "properties": { "type": { "const": "sg.company.merge_into_new" }, "params": { "$ref": "#/components/schemas/Params_sg_company_merge_into_new" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amalgamate Singapore companies into a new company", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amalgamation_proposal", "title": "Amalgamation proposal", "source": "generated", "required": true }, { "key": "board_best_interest_resolution", "title": "Board resolution of each amalgamating company that the amalgamation is in its best interest", "source": "generated", "required": true }, { "key": "solvency_statement_amalgamating", "title": "Solvency statement for each amalgamating company", "source": "generated", "required": true }, { "key": "auditor_report", "title": "Auditor's report supporting the solvency statement", "source": "uploaded", "required": false }, { "key": "solvency_statement_amalgamated", "title": "Solvency statement for the amalgamated company", "source": "generated", "required": true }, { "key": "directors_grounds_declaration", "title": "Declaration of each voting director that the conditions are met, with grounds", "source": "generated", "required": true }, { "key": "member_information_pack", "title": "Information pack for members", "source": "generated", "required": true }, { "key": "secured_creditor_notice", "title": "Notice and copy of the proposal to secured creditors", "source": "generated", "required": true }, { "key": "newspaper_notice", "title": "Newspaper notice of the proposed amalgamation", "source": "generated", "required": true }, { "key": "meeting_notice", "title": "Notice of general meeting of each amalgamating company", "source": "generated", "required": true }, { "key": "proxy_appointments", "title": "Proxy and corporate representative authorisations", "source": "uploaded", "required": false }, { "key": "members_special_resolution", "title": "Special resolution of each amalgamating company approving the proposal", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of each general meeting", "source": "generated", "required": true }, { "key": "approval_compliance_declaration", "title": "Declaration of the directors of each amalgamating company that the amalgamation was approved in.", "source": "generated", "required": true }, { "key": "creditor_prejudice_declaration", "title": "Declaration of the proposed directors of the new company that no creditor will be prejudiced", "source": "generated", "required": true }, { "key": "new_company_constitution", "title": "Constitution of the new company", "source": "generated", "required": true }, { "key": "director_consents", "title": "Form 45 for each proposed director and Form 45B for the proposed secretary", "source": "generated", "required": true }, { "key": "name_approval", "title": "ACRA name approval", "source": "registry_issued", "required": true }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Register for amalgamation of business entities' with registration of the.", "source": "generated", "required": true }, { "key": "notice_of_amalgamation", "title": "Notice of amalgamation and notice of incorporation of the new company", "source": "registry_issued", "required": true }, { "key": "certificate_of_confirmation_of_amalgamation", "title": "Certificate of confirmation of amalgamation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_best_interest_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_statement_amalgamating", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_statement_amalgamated", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_grounds_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "proxy_appointments", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "approval_compliance_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "creditor_prejudice_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "director_consents", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Register for amalgamation of business entities'", "channel": "online", "government_fee": { "amount": 715, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "route_not_supported", "type": null, "when": "[invalid_request_error] A short-form route was requested with a new amalgamated company." }, { "code": "meeting_required", "type": null, "when": "[requirement_error] A members' written resolution was proposed. s 215C requires a special resolution at a general meeting." }, { "code": "notice_period_too_short", "type": null, "when": "[requirement_error] Member, secured-creditor or newspaper notice went out less than 21 days before a meeting." }, { "code": "solvency_opinion_unsupported", "type": null, "when": "[requirement_error] A director cannot sign the solvency statement because the financial statements or valuations do not support it." }, { "code": "cross_holdings_not_cancelled", "type": null, "when": "[requirement_error] The proposal converts shares that one amalgamating company holds in another instead of cancelling them for no consideration (s 215B)." }, { "code": "name_not_reserved", "type": null, "when": "[registry_error] The new company's name is not reserved with ACRA, or the reservation has lapsed (s 215E)." }, { "code": "resident_director_missing", "type": null, "when": "[requirement_error] No proposed director is ordinarily resident in Singapore (s 145)." }, { "code": "court_order_restraining", "type": null, "when": "[registry_error] A member, creditor or other affected person obtained a court order under s 215H stopping, modifying or sending back the proposal." } ] } }, "Params_sg_cooperative_society_merge": { "type": "object", "properties": { "amalgamating_societies": { "type": "array", "items": {}, "description": "At least two registered societies: [{ entity_id | registration_number }]." }, "amalgamated_society_name": { "type": "string", "description": "Name of the amalgamated society.", "examples": [ "Harmony Credit Co-operative Ltd" ] }, "society_type": { "type": "string", "enum": [ "credit", "non_credit" ], "description": "Credit societies provide a financial service, which triggers the extra tests in s 9." }, "by_laws_document_id": { "type": "string", "pattern": "^doc_", "description": "Proposed by-laws of the amalgamated society." }, "amalgamation_date": { "type": "string", "format": "date", "description": "Intended amalgamation date." }, "egm_meetings": { "type": "array", "items": {}, "description": "One entry per society: { entity_id | registration_number, meeting_date, notice_sent_date }." }, "liabilities_transfer": { "type": "boolean", "description": "True if the amalgamation moves liabilities from one society to another." }, "creditor_notice_date": { "type": "string", "format": "date", "description": "Date of the creditor notice." }, "creditors": { "type": "array", "items": {}, "description": "[{ name, email, address, society, amount_owed? }]." }, "committee_of_management": { "type": "array", "items": {}, "description": "[{ person_id, office }] for the amalgamated society." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered address of the amalgamated society." }, "members_opting_out": { "type": "array", "items": {}, "description": "Members who gave written notice at least 1 month before the amalgamation date that they will not join the new society (s 74): [{ society, member_name." } }, "required": [ "amalgamating_societies", "amalgamated_society_name", "society_type", "by_laws_document_id", "amalgamation_date", "egm_meetings", "liabilities_transfer", "committee_of_management", "registered_office" ], "description": "Combines two or more registered co-operative societies into a new amalgamated society under Co-operative Societies Act 1979 s 74. Each society's extraordinary general meeting approves by at least 75% of members present and voting; the." }, "Create_sg_cooperative_society_merge": { "type": "object", "properties": { "type": { "const": "sg.cooperative_society.merge" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_society_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amalgamate co-operative societies into one society", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "committee_resolution", "title": "Committee of management resolution of each society proposing the amalgamation and calling the EGM", "source": "generated", "required": true }, { "key": "egm_notice", "title": "Notice of extraordinary general meeting of each society", "source": "generated", "required": true }, { "key": "egm_resolution", "title": "EGM resolution of each society to combine into one society", "source": "generated", "required": true }, { "key": "egm_minutes", "title": "Minutes of each EGM with attendance and vote count", "source": "generated", "required": true }, { "key": "amalgamation_terms", "title": "Amalgamation terms approved by the EGMs", "source": "generated", "required": true }, { "key": "creditor_notice", "title": "Notice of the amalgamation to every creditor", "source": "generated", "required": false }, { "key": "creditor_agreement", "title": "Written agreement of at least 75% in value of creditors not to demand refunds", "source": "uploaded", "required": false }, { "key": "member_optout_notices", "title": "Members' written opt-out notices", "source": "uploaded", "required": false }, { "key": "amalgamated_by_laws", "title": "By-laws of the amalgamated society", "source": "generated", "required": true }, { "key": "financial_service_evidence", "title": "Evidence for the s 9 tests", "source": "uploaded", "required": false }, { "key": "registrar_application", "title": "Application to the Registrar to register the amalgamated society and its by-laws", "source": "generated", "required": true }, { "key": "registration_decision", "title": "Registrar's registration of the amalgamated society and cancellation of the old registrations", "source": "registry_issued", "required": true }, { "key": "com_key_officers_update", "title": "COM Members and Key Officers Update for the amalgamated society", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "each", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "committee_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "egm_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "egm_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "amalgamated_by_laws", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registrar_application", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "creditor_notice", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "creditor_agreement", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Application to the Registrar to register the amalgamated society and its by-laws, with eac", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "insufficient_majority", "type": null, "when": "[requirement_error] Fewer than 75% of members present and voting at an EGM approved the resolution (s 74)." }, { "code": "creditor_notice_too_short", "type": null, "when": "[requirement_error] liabilities_transfer is true and fewer than 3 months separate the creditor notice from the amalgamation date (s 74)." }, { "code": "by_laws_not_compliant", "type": null, "when": "[registry_error] The Registrar is not satisfied the by-laws meet s 9-, or the s 9 tests for a financial service are not met." }, { "code": "registrar_not_satisfied", "type": null, "when": "[registry_error] The Registrar considers the amalgamation against the members' interests (s 74)." }, { "code": "society_not_registered", "type": null, "when": "[jurisdiction_error] A listed society is not a registered co-operative society." }, { "code": "submission_channel_unconfirmed", "type": null, "when": "[requirement_error] The committee has not confirmed how the Registry accepts the submission and whether e-signatures are accepted; the action waits for that confirmation." } ] } }, "Params_sg_cooperative_society_transfer": { "type": "object", "properties": { "receiving_society": { "type": "object", "description": "The society that accepts the assets and liabilities: { entity_id | registration_number }." }, "transfer_date": { "type": "string", "format": "date", "description": "Intended transfer date." }, "egm_meeting": { "type": "object", "description": "{ meeting_date, notice_sent_date } of the transferring society's EGM, called specially for the transfer with due notice." }, "liabilities_transfer": { "type": "boolean", "description": "True if liabilities pass to the receiving society." }, "creditor_notice_date": { "type": "string", "format": "date", "description": "Date of the creditor notice." }, "creditors": { "type": "array", "items": {}, "description": "[{ name, email, address, amount_owed? }]." }, "receiving_society_acceptance_document_id": { "type": "string", "pattern": "^doc_", "description": "Committee resolution of the receiving society accepting the transfer." }, "members_opting_out": { "type": "array", "items": {}, "description": "Members who gave written notice at least 1 month before the transfer date that they will not join the receiving society (s 75): [{ member_name, notice_date }]." }, "receiving_society_committee_changes": { "type": "array", "items": {}, "description": "[{ person_id, office, change: appointed | ceased }] if the receiving society's committee or key officers change as a result." } }, "required": [ "receiving_society", "transfer_date", "egm_meeting", "liabilities_transfer", "receiving_society_acceptance_document_id" ], "description": "A registered co-operative society transfers all its assets and liabilities to a willing receiving society under Co-operative Societies Act 1979 s 75. The transferring society's EGM approves by at least 75% of members present and voting; on." }, "Create_sg_cooperative_society_transfer": { "type": "object", "properties": { "type": { "const": "sg.cooperative_society.transfer" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_society_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a co-operative society's assets and liabilities to another society", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "committee_resolution", "title": "Committee of management resolution of the transferring society proposing the transfer and calling.", "source": "generated", "required": true }, { "key": "egm_notice", "title": "Notice of extraordinary general meeting called specially for the transfer", "source": "generated", "required": true }, { "key": "egm_resolution", "title": "EGM resolution to transfer assets and liabilities to the receiving society", "source": "generated", "required": true }, { "key": "egm_minutes", "title": "Minutes of the EGM with attendance and vote count", "source": "generated", "required": true }, { "key": "receiving_society_acceptance", "title": "Receiving society's committee resolution accepting the transfer", "source": "uploaded", "required": true }, { "key": "creditor_notice", "title": "Notice of the transfer to every creditor of the transferring society", "source": "generated", "required": false }, { "key": "member_optout_notices", "title": "Members' written opt-out notices", "source": "uploaded", "required": false }, { "key": "registrar_application", "title": "Application to the Registrar to approve the transfer", "source": "generated", "required": true }, { "key": "registrar_approval", "title": "Registrar's approval of the transfer, cancellation of the registration and dissolution", "source": "registry_issued", "required": true }, { "key": "com_key_officers_update", "title": "COM Members and Key Officers Update for the receiving society", "source": "generated", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "committee_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "egm_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "egm_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "receiving_society_acceptance", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registrar_application", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "creditor_notice", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Application to the Registrar to approve the transfer of a society, with the EGM resolution", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "insufficient_majority", "type": null, "when": "[requirement_error] Fewer than 75% of members present and voting at the EGM approved the resolution (s 75)." }, { "code": "creditor_notice_too_short", "type": null, "when": "[requirement_error] liabilities_transfer is true and fewer than 3 months separate the creditor notice from the transfer date (s 75)." }, { "code": "receiving_society_not_willing", "type": null, "when": "[requirement_error] No acceptance resolution from the receiving society is on file (s 75)." }, { "code": "registrar_not_satisfied", "type": null, "when": "[registry_error] The Registrar considers the transfer against the interests of the transferring society's members (s 75)." }, { "code": "society_not_registered", "type": null, "when": "[jurisdiction_error] The entity or the receiving society is not a registered co-operative society." }, { "code": "submission_channel_unconfirmed", "type": null, "when": "[requirement_error] The committee has not confirmed how the Registry accepts the submission and whether e-signatures are accepted; the action waits for that confirmation." } ] } }, "Params_sg_llp_convert_from_company": { "type": "object", "properties": { "source_entity_id": { "type": "string", "pattern": "^ent_", "description": "Entiva entity being converted." }, "llp_name": { "type": "string", "description": "Name of the new LLP.", "examples": [ "Quayside Advisory LLP" ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "partners": { "type": "array", "items": {}, "description": "Every partner of the LLP: [{ person_id | entity_id, capital_contribution? }]." }, "managers": { "type": "array", "items": {}, "description": "person_ids of the LLP's managers." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Singapore registered office of the LLP." }, "licences_resolved": { "type": "boolean", "description": "The customer confirms that approvals, permits and licences issued to the company have been resolved with the issuing authorities." }, "security_interests_cleared": { "type": "boolean", "description": "The customer confirms that no charge or other security interest over the company's assets is subsisting." }, "claim_stamp_duty_relief": { "type": "boolean", "description": "Ask Entiva to prepare the IRAS 'Section 15 Relief' application for buyer's and seller's stamp duty on chargeable property moving to the LLP." } }, "required": [ "source_entity_id", "llp_name", "partners", "managers", "registered_office", "licences_resolved", "security_interests_cleared" ], "description": "Converts a Singapore private company into a new LLP under LLP Act s 27 and the Third Schedule. All shareholders must become the LLP's partners and no one else." }, "Create_sg_llp_convert_from_company": { "type": "object", "properties": { "type": { "const": "sg.llp.convert_from_company" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_convert_from_company" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a private company into a limited liability partnership", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "exempt_private_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the conversion", "source": "generated", "required": true }, { "key": "shareholders_consent", "title": "Written consent of every shareholder to the conversion and to becoming an LLP partner", "source": "generated", "required": true }, { "key": "shareholders_statement", "title": "Statement of the shareholders giving the company's name, registration number and date of.", "source": "generated", "required": false }, { "key": "charges_discharge_evidence", "title": "Evidence that charges are discharged and satisfaction is registered with ACRA", "source": "uploaded", "required": false }, { "key": "llp_agreement", "title": "LLP partnership agreement", "source": "generated", "required": false }, { "key": "medisave_clearance", "title": "Confirmation that outstanding MediSave liabilities are cleared", "source": "uploaded", "required": true }, { "key": "stamp_duty_relief_declaration", "title": "Statutory declaration supporting IRAS Section 15 relief", "source": "generated", "required": false }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Convert to an LLP'", "source": "generated", "required": true }, { "key": "name_approval", "title": "ACRA name approval", "source": "registry_issued", "required": true }, { "key": "notice_of_registration", "title": "Notice of registration of the LLP with its new UEN and registration date", "source": "registry_issued", "required": true }, { "key": "conversion_statement", "title": "Conversion statement for the LLP to display", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "shareholders_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "llp_agreement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stamp_duty_relief_declaration", "signer_role": "lawyer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Convert to an LLP'", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "partners_mismatch", "type": null, "when": "[requirement_error] The partners list is not exactly the company's shareholders." }, { "code": "fewer_than_two_partners", "type": null, "when": "[requirement_error] An LLP needs at least 2 partners; a one-shareholder company cannot convert on its own." }, { "code": "security_interest_subsisting", "type": null, "when": "[requirement_error] A charge over the company's assets is registered and not discharged." }, { "code": "no_resident_manager", "type": null, "when": "[requirement_error] No manager is ordinarily resident in Singapore." }, { "code": "licences_unresolved", "type": null, "when": "[requirement_error] licences_resolved is false." }, { "code": "not_a_private_company", "type": null, "when": "[jurisdiction_error] The entity is a public company." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] The LLP name is unavailable or refused, or the name application has expired." } ] } }, "Params_sg_llp_convert_from_partnership": { "type": "object", "properties": { "source_entity_type": { "type": "string", "enum": [ "general_partnership", "sole_proprietorship" ], "description": "Type of the business being converted. sole_proprietorship triggers a partner eligibility review." }, "source_entity_id": { "type": "string", "pattern": "^ent_", "description": "Entiva entity being converted." }, "source_uen": { "type": "string", "description": "UEN of the business being converted, when it is not yet an Entiva entity." }, "llp_name": { "type": "string", "description": "Name of the new LLP.", "examples": [ "Marlow & Tan LLP" ] }, "name_application_id": { "type": "string", "description": "Transaction ID of an approved ACRA name application." }, "partners": { "type": "array", "items": {}, "description": "Every partner of the LLP: [{ person_id | entity_id }]." }, "managers": { "type": "array", "items": {}, "description": "person_ids of the LLP's managers." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Singapore registered office of the LLP." }, "licences_resolved": { "type": "boolean", "description": "The customer confirms that approvals, permits and licences issued to the old business have been resolved with the issuing authorities." }, "partnership_agreement_document_id": { "type": "string", "pattern": "^doc_", "description": "The existing partnership agreement or a draft LLP agreement." } }, "required": [ "source_entity_type", "llp_name", "partners", "managers", "registered_office", "licences_resolved" ], "description": "Converts a registered general partnership into a new Singapore LLP under LLP Act s 26 and the Second Schedule. Every existing partner must become an LLP partner." }, "Create_sg_llp_convert_from_partnership": { "type": "object", "properties": { "type": { "const": "sg.llp.convert_from_partnership" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_convert_from_partnership" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a partnership into a limited liability partnership", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "general_partnership", "sole_proprietorship", "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_consent", "title": "Written consent of every existing partner to convert and become an LLP partner", "source": "generated", "required": true }, { "key": "llp_agreement", "title": "LLP partnership agreement", "source": "generated", "required": false }, { "key": "medisave_clearance", "title": "Confirmation that outstanding MediSave liabilities are cleared", "source": "uploaded", "required": true }, { "key": "licence_status_evidence", "title": "Evidence that licences and permits have been resolved with issuing authorities", "source": "uploaded", "required": false }, { "key": "bizfile_lodgement", "title": "Bizfile General Lodgement 'Convert to an LLP'", "source": "generated", "required": true }, { "key": "name_approval", "title": "ACRA name approval", "source": "registry_issued", "required": true }, { "key": "notice_of_registration", "title": "Notice of registration of the LLP with its new UEN and registration date", "source": "registry_issued", "required": true }, { "key": "conversion_statement", "title": "Conversion statement for the LLP to display", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_consent", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "llp_agreement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Convert to an LLP'", "channel": "online", "government_fee": { "amount": 40, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "partners_mismatch", "type": null, "when": "[requirement_error] The partners list is not exactly the existing partners." }, { "code": "fewer_than_two_partners", "type": null, "when": "[requirement_error] An LLP needs at least 2 partners; a one-owner business cannot convert on its own." }, { "code": "sole_proprietor_eligibility_review", "type": null, "when": "[requirement_error] source_entity_type is sole_proprietorship." }, { "code": "no_resident_manager", "type": null, "when": "[requirement_error] No manager is ordinarily resident in Singapore." }, { "code": "licences_unresolved", "type": null, "when": "[requirement_error] licences_resolved is false." }, { "code": "name_unavailable", "type": null, "when": "[registry_error] The LLP name is unavailable or refused, or the name application has expired." } ] } }, "Params_sg_vcc_continue_in": { "type": "object", "properties": { "vcc_name": { "type": "string", "description": "Name of the VCC.", "examples": [ "Merlion Opportunities Fund VCC" ] }, "vcc_name_application_id": { "type": "string", "description": "Reference of an approved VCC name application." }, "vcc_type": { "type": "string", "enum": [ "single_fund", "umbrella" ], "description": "A single fund, or an umbrella with sub-funds." }, "sub_funds": { "type": "array", "items": {}, "description": "Required for umbrella: [{ name, cis_registration_ref }]." }, "foreign_entity": { "type": "object", "description": "{ name, structure_type, legislation, jurisdiction, registration_number, date_of_registration, registered_office_address, last_financial_year_end }." }, "registered_foreign_company_uen": { "type": "string", "description": "UEN if the entity is already registered as a foreign company under the Companies Act." }, "registration_history": { "type": "array", "items": {}, "description": "Earlier transfers of registration or re-domiciliations, in order: [{ name, jurisdiction, date_registered, date_deregistered? }]." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Singapore registered office of the VCC." }, "working_hours": { "type": "string", "description": "Office working hours shown on the form, for example 09:00-18:00 Mon-Fri." }, "first_financial_year_end": { "type": "string", "format": "date", "description": "The VCC's first financial year end after transfer." }, "fund_manager": { "type": "object", "description": "{ uen_or_name, principal_place_of_business_address, representative_director_person_id }." }, "auditors": { "type": "array", "items": {}, "description": "[{ uen, name }]." }, "officers": { "type": "array", "items": {}, "description": "[{ person_id, position, is_fund_manager_director_or_qualified_representative }]." }, "has_authorised_schemes": { "type": "boolean", "description": "True if the VCC will have authorised schemes." }, "home_law_authorised": { "type": "boolean", "description": "The entity is authorised by the law of its place of incorporation to transfer its incorporation, and has complied with that law." }, "solvency_confirmed": { "type": "boolean", "description": "Every director of the foreign entity confirms the financial requirements in regulation 9 and of the VCC Regulations, and the application is made in good faith." }, "eligible_financial_institution": { "type": "string", "description": "Name of the MAS-regulated institution engaged for the VCC's AML/CFT duties." } }, "required": [ "vcc_name", "vcc_type", "foreign_entity", "registered_office", "working_hours", "first_financial_year_end", "fund_manager", "auditors", "officers", "has_authorised_schemes", "home_law_authorised", "solvency_confirmed" ], "description": "Moves the registration of a foreign investment fund entity to Singapore as a VCC under the Variable Capital Companies Act 2018, keeping its obligations, liabilities, property and rights. Lodged on ACRA's VCC eServices with a declaration." }, "Create_sg_vcc_continue_in": { "type": "object", "properties": { "type": { "const": "sg.vcc.continue_in" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-domicile a foreign fund into Singapore as a variable capital company", "x-entiva": { "jurisdiction": "sg", "stage": "restructuring", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_home_constitution", "title": "Certified copy of the home charter, statute, constitution, memorandum or articles", "source": "uploaded", "required": true }, { "key": "certified_certificate_of_incorporation", "title": "Certified copy of the certificate of incorporation, or a document of similar effect", "source": "uploaded", "required": true }, { "key": "cis_registration_documents", "title": "Certified copy of the registration document of each collective investment scheme in the place of.", "source": "uploaded", "required": true }, { "key": "proposed_vcc_constitution", "title": "Proposed Singapore constitution of the VCC", "source": "uploaded", "required": true }, { "key": "director_compliance_statement", "title": "Statement by the foreign entity on each proposed director's compliance with the factors prescribed.", "source": "generated", "required": true }, { "key": "foreign_directors_declaration", "title": "Declaration by all directors of the foreign corporate entity", "source": "generated", "required": true }, { "key": "csp_declaration", "title": "Declaration by the corporate service provider", "source": "generated", "required": true }, { "key": "secretary_declaration", "title": "Declaration by the proposed secretary", "source": "generated", "required": true }, { "key": "director_declaration", "title": "Declaration by each proposed VCC director", "source": "generated", "required": true }, { "key": "lodger_declaration", "title": "Declaration by the lodger", "source": "generated", "required": true }, { "key": "fund_manager_declaration", "title": "Fund manager's signed declaration of consent and qualifications", "source": "uploaded", "required": true }, { "key": "fund_manager_licence_evidence", "title": "Evidence that the fund manager is MAS-licensed, registered or exempt", "source": "uploaded", "required": true }, { "key": "home_authorisation_evidence", "title": "Evidence that home law permits the transfer and that its requirements are met", "source": "uploaded", "required": true }, { "key": "bizfile_lodgement", "title": "VCC eServices 'Application for Transfer of Registration'", "source": "generated", "required": true }, { "key": "name_approval", "title": "ACRA VCC name approval", "source": "registry_issued", "required": true }, { "key": "proof_of_deregistration", "title": "Document showing the foreign entity is deregistered in its place of incorporation", "source": "uploaded", "required": true }, { "key": "certificate_of_transfer_of_registration", "title": "Certificate confirming transfer by registration, with UEN and business profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "foreign_directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "director_compliance_statement", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fund_manager_declaration", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "director_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "secretary_declaration", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "csp_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "lodger_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "bizfile_lodgement", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_lodgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_home_constitution", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "proof_of_deregistration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Application for Transfer of Registration", "channel": "online", "government_fee": { "amount": 9000, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "structure_not_similar", "type": null, "when": "[jurisdiction_error] ACRA allows only overseas funds with a corporate structure similar to a VCC to re-domicile." }, { "code": "fund_manager_not_permissible", "type": null, "when": "[requirement_error] The fund manager is not MAS-licensed, registered or exempt, or has not signed its declaration." }, { "code": "director_requirements_unmet", "type": null, "when": "[requirement_error] No resident director, no director or qualified representative of the fund manager, or a VCC with authorised schemes lacks 3 directors including an independent." }, { "code": "solvency_requirement_not_met", "type": null, "when": "[requirement_error] A director cannot confirm regulation 9 and, the entity is in liquidation, judicial management or winding up, or good faith cannot be shown." }, { "code": "home_law_not_permitted", "type": null, "when": "[jurisdiction_error] The law of the place of incorporation does not allow the transfer, or its steps were not completed." }, { "code": "sub_fund_mismatch", "type": null, "when": "[invalid_request_error] vcc_type is umbrella with no sub_funds, or the sub-fund count does not match the CIS registration documents." }, { "code": "name_not_reserved", "type": null, "when": "[registry_error] The VCC name is not reserved or the reservation has lapsed." }, { "code": "registration_refused", "type": null, "when": "[registry_error] ACRA refused the transfer or a referral authority objected." }, { "code": "deregistration_deadline_missed", "type": null, "when": "[registry_error] Proof of deregistration was not filed within 60 days or an extension; ACRA may cancel the Singapore registration." } ] } }, "Params_sg_business_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership", "lp" ], "description": "Entity type key." }, "transaction_type": { "type": "string", "enum": [ "cessation", "dissolution" ], "description": "Dissolution is available to limited partnerships only." }, "effective_date": { "type": "string", "format": "date", "description": "Cessation or dissolution date." }, "reason": { "type": "string", "description": "Reason." }, "dissolution_reason": { "type": "string", "enum": [ "cessation_of_partnership", "partner_death", "partner_bankruptcy", "court_order", "other" ], "description": "LP dissolution only." }, "court_order_date": { "type": "string", "format": "date", "description": "Required when dissolution_reason is court_order." }, "court_order_number": { "type": "string", "description": "Required when dissolution_reason is court_order." }, "gst_cancelled": { "type": "boolean", "description": "True once GST is cancelled with IRAS, or if never registered." }, "admin_matters_settled": { "type": "boolean", "description": "Contracts, vehicle transfers and business loans or grants are settled." }, "registration_current": { "type": "boolean", "description": "The registration has not expired." } }, "required": [ "entity_type", "transaction_type", "effective_date", "reason", "gst_cancelled", "admin_matters_settled", "registration_current" ], "description": "Files the cessation, or for an LP the dissolution, on Bizfile. It takes effect at once for a past or current date and a cessation cannot be reversed once approved." }, "Create_sg_business_cease": { "type": "object", "properties": { "type": { "const": "sg.business.cease" }, "params": { "$ref": "#/components/schemas/Params_sg_business_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cease a sole proprietorship, partnership or limited partnership", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "sole_proprietorship", "general_partnership", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "closure_instruction", "title": "Signed instruction from the owner or all partners", "source": "generated", "required": true }, { "key": "court_order", "title": "Court order", "source": "uploaded", "required": false }, { "key": "acra_confirmation", "title": "ACRA cessation or dissolution confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "closure_instruction", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "acra_confirmation", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File cessation or dissolution of business entity'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "registration_expired", "type": null, "when": "The registration expired and must be renewed first." }, { "code": "gst_registration_active", "type": null, "when": "GST is not cancelled." }, { "code": "transaction_not_supported", "type": null, "when": "Dissolution was requested for a sole proprietorship or general partnership." }, { "code": "court_order_details_missing", "type": null, "when": "Dissolution by court order lacks the order date or number." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_sg_business_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "sole_proprietorship", "general_partnership" ], "description": "Business type." }, "cancellation_date": { "type": "string", "format": "date", "description": "Date ACRA cancelled the registration." }, "cancellation_reason": { "type": "string", "enum": [ "not_renewed", "medisave_outstanding", "other" ], "description": "Why ACRA cancelled. not_renewed: the registration lapsed. medisave_outstanding: cancelled because MediSave contributions were outstanding or no instalment." }, "applicant": { "type": "string", "pattern": "^per_", "description": "An owner or partner who was previously an active position holder." }, "reasons_for_restoration": { "type": "string", "description": "Appeal reasons as entered in Bizfile, for example ongoing contracts, a tenancy or obligations that cannot be met without restoration." }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref IDs supporting the reasons." }, "medisave_status": { "type": "array", "items": {}, "description": "One entry per owner or partner: {person: person_ref, status: paid_in_full | instalment_arrangement | outstanding}." }, "renew_after_restoration": { "type": "boolean", "description": "When true Entiva starts the renewal of the business registration as soon as ACRA approves, because a restored business may come back as 'registration." }, "renewal_term": { "type": "string", "enum": [ "1_year", "3_year" ], "description": "Renewal period to apply for after restoration." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Locally resident authorised representative, needed when no owner or partner is resident in Singapore." } }, "required": [ "entity_type", "cancellation_date", "cancellation_reason", "applicant", "reasons_for_restoration", "supporting_documents", "medisave_status" ], "description": "Applies on Bizfile to restore a sole proprietorship or general partnership whose registration ACRA cancelled, usually because it expired and was not renewed." }, "Create_sg_business_restore": { "type": "object", "properties": { "type": { "const": "sg.business.restore" }, "params": { "$ref": "#/components/schemas/Params_sg_business_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a cancelled sole proprietorship or general partnership", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "sole_proprietorship", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "supporting_documents", "title": "Supporting documents", "source": "uploaded", "required": true }, { "key": "medisave_evidence", "title": "Evidence of MediSave position for every owner or partner", "source": "uploaded", "required": true }, { "key": "applicant_authorisation", "title": "Authority to file and applicant's declarations", "source": "generated", "required": true }, { "key": "letter_of_undertaking", "title": "Letters of undertaking", "source": "generated", "required": true }, { "key": "bizfile_application", "title": "Bizfile 'Apply to restore business entity' submission", "source": "generated", "required": true }, { "key": "restoration_notice", "title": "ACRA outcome notice", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "applicant_authorisation", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "letter_of_undertaking", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply to restore business entity' eService, restoration after cancellation route", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "applicant_not_position_holder", "type": null, "when": "The applicant was not an active position holder of the business." }, { "code": "medisave_outstanding", "type": null, "when": "Any medisave_status entry is 'outstanding'." }, { "code": "three_year_renewal_unavailable", "type": null, "when": "renewal_term is 3_year but the MediSave position does not meet the 3-year condition." }, { "code": "restoration_refused", "type": null, "when": "ACRA declines the application." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_charity_deregister": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "public_ltd_guarantee", "registered_society" ], "description": "Entity type of the charity." }, "charity_registration_number": { "type": "string", "description": "Registration number on the Commissioner of Charities' register of charities." }, "notify_party": { "type": "string", "enum": [ "commissioner_of_charities", "sector_administrator" ], "description": "Whom to notify." }, "sector_administrator": { "type": "string", "description": "Name of the Sector Administrator." }, "is_ipc": { "type": "boolean", "description": "Whether the charity also holds Institution of a Public Character status." }, "resolution_type": { "type": "string", "enum": [ "wind_up", "dissolve" ], "description": "Whether the resolution is to wind up or to dissolve the charity." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the resolution to wind up or dissolve was passed." }, "winding_up_or_dissolution_date": { "type": "string", "format": "date", "description": "The winding-up or dissolution date up to which the final financial statements are prepared." }, "remaining_funds_disposal": { "type": "object", "description": "How remaining funds were distributed: {total_remaining: money, governing_instrument_clause: string, recipients: array of {name, registration_number, amount." }, "records_custodian": { "type": "string", "pattern": "^per_", "description": "The last governing board member who keeps the charity's accounting records, financial statements and annual reports until the retention period ends, if the." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator, if the charity is a company in winding up." }, "extension_granted_until": { "type": "string", "format": "date", "description": "If the Commissioner has allowed a longer period than 7 days, the date it allows." } }, "required": [ "entity_type", "charity_registration_number", "notify_party", "is_ipc", "resolution_type", "resolution_date", "winding_up_or_dissolution_date", "remaining_funds_disposal", "records_custodian" ], "description": "Prepares the notification to the Commissioner of Charities, or to the charity's Sector Administrator, that a registered charity has resolved to wind up or dissolve, so it can be taken off the charity register." }, "Create_sg_charity_deregister": { "type": "object", "properties": { "type": { "const": "sg.charity.deregister" }, "params": { "$ref": "#/components/schemas/Params_sg_charity_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Commissioner of Charities that a charity is winding up or dissolving", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "public_ltd_guarantee", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notification_letter", "title": "Notification of winding up or dissolution", "source": "generated", "required": true }, { "key": "final_financial_statements", "title": "Final financial statements to the winding-up or dissolution date", "source": "uploaded", "required": true }, { "key": "final_annual_report", "title": "Final annual report", "source": "uploaded", "required": true }, { "key": "general_meeting_minutes", "title": "Minutes of the general meeting that passed the resolution", "source": "uploaded", "required": true }, { "key": "fund_distribution_evidence", "title": "Proof that remaining funds were distributed under the governing instrument", "source": "uploaded", "required": true }, { "key": "coc_submission", "title": "Submission package", "source": "generated", "required": true }, { "key": "coc_acknowledgement", "title": "Commissioner's or Sector Administrator's acknowledgement", "source": "registry_issued", "required": false }, { "key": "coc_no_objection_letter", "title": "Letter of no objection from the Commissioner of Charities", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "custodian", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notification_letter", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "general_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_financial_statements", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "coc_submission", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Commissioner of Charities", "form": "Notification of winding up or dissolution with final financial statements, final annual re", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notification_overdue", "type": null, "when": "More than 7 days have passed since resolution_date and no extension_granted_until is set." }, { "code": "not_a_registered_charity", "type": null, "when": "The charity registration number is not on the Commissioner's register." }, { "code": "final_accounts_missing", "type": null, "when": "The final financial statements or final annual report are missing." }, { "code": "fund_disposal_evidence_missing", "type": null, "when": "No proof that the remaining funds were distributed, or a recipient has no receipt." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_company_strike_off": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "description": "Entity type key." }, "reason": { "type": "string", "description": "Reason for striking off, as entered in Bizfile." }, "effective_date": { "type": "string", "format": "date", "description": "Date the company ceased trading, if it ever traded." }, "confirmations": { "type": "object", "description": "All must be true: ceased_trading_or_never_traded, no_unpaid_debts_or_government_issues, no_registered_charges, no_legal_or_regulatory_proceedings." }, "consenting_directors": { "type": "array", "items": {}, "description": "person_ref list of the directors who consent." }, "registered_office_and_email_current": { "type": "boolean", "description": "The registered office address and company email are current, because ACRA sends its notices there." }, "gst_cancelled": { "type": "boolean", "description": "True once GST registration is cancelled, if the company was GST-registered." }, "submit_not_before": { "type": "string", "format": "date", "description": "Earliest submission date.", "examples": [ "2026-10-20" ] } }, "required": [ "entity_type", "reason", "confirmations", "consenting_directors", "registered_office_and_email_current" ], "description": "Applies on Bizfile to strike a company off the register. The company must have ceased trading, have no debts, government issues, charges, proceedings, assets or liabilities, and all or a majority of directors must agree." }, "Create_sg_company_strike_off": { "type": "object", "properties": { "type": { "const": "sg.company.strike_off" }, "params": { "$ref": "#/components/schemas/Params_sg_company_strike_off" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Strike off a local company", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_consent_resolution", "title": "Directors' resolution consenting to strike-off", "source": "generated", "required": true }, { "key": "iras_evidence", "title": "IRAS Notice of Assessment and Statement of Accounts showing no outstanding tax", "source": "uploaded", "required": false }, { "key": "bizfile_application", "title": "Bizfile application", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_consent_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply to strike off business entity'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "striking_off_criteria_not_met", "type": null, "when": "A confirmation is false." }, { "code": "outstanding_government_matters", "type": null, "when": "IRAS or another agency has unresolved matters, so it would object." }, { "code": "registered_charge_exists", "type": null, "when": "The charge register shows an unsatisfied charge." }, { "code": "pending_proceedings", "type": null, "when": "A court, regulatory or disciplinary matter is open." }, { "code": "majority_consent_missing", "type": null, "when": "Fewer than a majority of directors consented." }, { "code": "objection_accepted", "type": null, "when": "ACRA accepted an objection and the 2-month window to resolve it lapsed." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_sg_cooperative_society_wind_up": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cooperative_society" ], "description": "Entity type." }, "cooperative_class": { "type": "string", "enum": [ "primary", "secondary_or_apex" ], "description": "primary: net liquidation proceeds go to the Co-operative Societies Liquidation Account unless the Registrar approves a donation. secondary_or_apex: net." }, "egm_date": { "type": "string", "format": "date", "description": "Date of the EGM that passed the resolution to wind up." }, "egm_convened_for_winding_up": { "type": "boolean", "description": "Whether the EGM was convened for the purpose of winding up." }, "members_present_and_voting": { "type": "integer", "description": "Members present and voting at the EGM." }, "votes_for": { "type": "integer", "description": "Votes for the resolution." }, "votes_against": { "type": "integer", "description": "Votes against the resolution." }, "latest_audited_year_end": { "type": "string", "format": "date", "description": "Financial year end of the audited financial statements for the last year of active operations." }, "proposed_liquidator": { "type": "object", "description": "The liquidator the committee recommends: {name, firm, person: person_ref, is_licensed_insolvency_practitioner: boolean, quoted_fee: money, relevant_experience." }, "liquidator_quotations": { "type": "array", "items": {}, "description": "At least 3 quotations: array of {provider, quoted_fee: money, document: document_ref}." }, "recommendation_basis": { "type": "string", "description": "Why the committee recommends this liquidator." }, "donation_proposal": { "type": "object", "description": "If the committee wants to donate net proceeds to charitable purposes: {proposed: boolean, recipients: array of {name, registration_number, share_percent}." }, "signatory": { "type": "string", "pattern": "^per_", "description": "The Chairman or Secretary who signs the application form and the EGM minutes." } }, "required": [ "entity_type", "cooperative_class", "egm_date", "egm_convened_for_winding_up", "members_present_and_voting", "votes_for", "votes_against", "latest_audited_year_end", "proposed_liquidator", "liquidator_quotations", "recommendation_basis", "signatory" ], "description": "Prepares the application to the Registry of Co-operative Societies to wind up a co-op voluntarily. At least 75% of the members present and voting at an EGM convened for the purpose must back the resolution." }, "Create_sg_cooperative_society_wind_up": { "type": "object", "properties": { "type": { "const": "sg.cooperative_society.wind_up" }, "params": { "$ref": "#/components/schemas/Params_sg_cooperative_society_wind_up" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to wind up a co-operative society voluntarily", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "latest_financial_statements", "title": "Latest audited financial statements", "source": "uploaded", "required": true }, { "key": "application_form", "title": "RCS Application for voluntary liquidation", "source": "generated", "required": true }, { "key": "egm_minutes", "title": "EGM resolution or minutes", "source": "uploaded", "required": true }, { "key": "liquidator_quotations", "title": "Liquidator quotations", "source": "uploaded", "required": true }, { "key": "liquidator_recommendation", "title": "Basis for recommending the proposed liquidator", "source": "generated", "required": true }, { "key": "rcs_submission", "title": "Submission package", "source": "generated", "required": true }, { "key": "gazette_winding_up_order", "title": "Winding-up order and liquidator appointment notice", "source": "registry_issued", "required": false }, { "key": "cancellation_order", "title": "Order cancelling the registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "egm_minutes", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Co-operative Societies", "form": "Application for voluntary liquidation", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "egm_threshold_not_met", "type": null, "when": "votes_for is below 75% of members present and voting." }, { "code": "fewer_than_three_quotations", "type": null, "when": "Fewer than 3 liquidator quotations are attached." }, { "code": "financial_statements_missing", "type": null, "when": "The latest audited financial statements are missing." }, { "code": "registry_application_incomplete", "type": null, "when": "The Registry asks for missing information and does not receive it, and rejects the application." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_court_restoration_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "description": "Entity type being restored." }, "court_route": { "type": "string", "enum": [ "restoration_on_application", "appeal_registrar_refusal", "dissolution_declared_void" ], "description": "restoration_on_application: application to restore a struck-off entity (Companies Act s344 for companies; ACRA cites LLP Act s68 and Companies Act s377B for." }, "struck_off_date": { "type": "string", "format": "date", "description": "Date the name was struck off." }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution." }, "registrar_refusal_date": { "type": "string", "format": "date", "description": "Date of the Registrar's refusal." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The person applying: for restoration, a person aggrieved by the removal; for dissolution_declared_void, the liquidator or any other person with an interest." }, "applicant_interest": { "type": "string", "enum": [ "former_director", "former_member", "former_partner", "creditor", "liquidator", "other_aggrieved_person", "other_interested_person" ], "description": "The applicant's standing." }, "was_carrying_on_business_at_strike_off": { "type": "boolean", "description": "Whether the entity was carrying on business or in operation when struck off." }, "grounds_summary": { "type": "string", "description": "Plain-language account of why the entity should be restored or the dissolution declared void, including any liabilities, assets or claims that depend on it." }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref IDs: evidence of trading at strike-off, contracts, correspondence, ACRA's refusal letter for an appeal." }, "counsel_costs_authorised_up_to": { "$ref": "#/components/schemas/Money", "description": "Ceiling the applicant authorises for partner counsel's fees and court disbursements before counsel must come back for approval." } }, "required": [ "entity_type", "court_route", "applicant", "applicant_interest", "grounds_summary", "counsel_costs_authorised_up_to" ], "description": "Opens a court-route restoration matter. Entiva collects the facts, verifies the applicant and refers the case to partner Singapore counsel, who file the application and supporting affidavit at the High Court and appear." }, "Create_sg_court_restoration_apply": { "type": "object", "properties": { "type": { "const": "sg.court_restoration.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_court_restoration_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Refer a High Court application to restore a struck-off or dissolved entity to partner counsel", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Engagement letter with partner counsel", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Evidence supporting the application", "source": "uploaded", "required": false }, { "key": "affidavit", "title": "Supporting affidavit", "source": "generated", "required": true }, { "key": "originating_application", "title": "Originating application", "source": "generated", "required": true }, { "key": "court_order", "title": "Sealed court order", "source": "registry_issued", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "affidavit", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "originating_application", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Supreme Court of Singapore", "form": "Originating application with supporting affidavit, in the form counsel selects", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "court_window_expired", "type": null, "when": "The 6-year window from striking off or the 2-year window from dissolution (IRDA s208) has passed on the dates given." }, { "code": "refusal_details_missing", "type": null, "when": "court_route is appeal_registrar_refusal and the refusal date or reference is missing." }, { "code": "counsel_conflict", "type": null, "when": "Partner counsel decline the matter after the conflicts check." }, { "code": "application_dismissed", "type": null, "when": "The court dismisses the application." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_creditors_meeting_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "prior_action_id": { "type": "string", "description": "act_ id of the declare_inability action." }, "meeting_date": { "type": "string", "format": "date", "description": "Creditors' meeting date." }, "meeting_venue_or_link": { "type": "string", "description": "Venue or video link." }, "notice_sent_date": { "type": "string", "format": "date", "description": "Date the notice goes to creditors." }, "statement_of_affairs_document_id": { "type": "string", "pattern": "^doc_", "description": "Statement of affairs as at the latest practicable date." }, "creditors_list_document_id": { "type": "string", "pattern": "^doc_", "description": "Creditors with amounts and securities." }, "total_liabilities": { "$ref": "#/components/schemas/Money", "description": "Total liabilities including contingent." } }, "required": [ "entity_type", "prior_action_id", "meeting_date", "meeting_venue_or_link", "notice_sent_date", "statement_of_affairs_document_id", "creditors_list_document_id", "total_liabilities" ], "description": "Lodges the statement of affairs and the notice of holding the creditors' meeting through Bizfile General Lodgement, and publishes the meeting notice." }, "Create_sg_creditors_meeting_notify": { "type": "object", "properties": { "type": { "const": "sg.creditors_meeting.notify" }, "params": { "$ref": "#/components/schemas/Params_sg_creditors_meeting_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Creditors' winding up: lodge the statement of affairs and notice of the creditors' meeting", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_of_affairs", "title": "Statement of affairs", "source": "generated", "required": true }, { "key": "creditors_list", "title": "List of creditors", "source": "generated", "required": true }, { "key": "creditors_meeting_notice", "title": "Notice of the creditors' meeting", "source": "generated", "required": true }, { "key": "general_lodgement_receipt", "title": "ACRA General Lodgement receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_affairs", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "general_lodgement_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Statement of Affairs' and 'Notice of Holding of Creditor's Mee", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "meeting_outside_30_days", "type": null, "when": "meeting_date is more than 30 days after the declaration." }, { "code": "statement_of_affairs_incomplete", "type": null, "when": "The statement lacks creditors, securities or estimated expenses." }, { "code": "declaration_not_filed", "type": null, "when": "The declaration of inability has not completed." } ] } }, "Params_sg_creditors_winding_up_declare_inability": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "declaration_applicable": { "type": "boolean", "description": "Default true." }, "declaration_date": { "type": "string", "format": "date", "description": "Date the statutory declaration was made." }, "declarants": { "type": "array", "items": {}, "description": "person_ref list of directors who swear the declaration." }, "or_lodgement_date": { "type": "string", "format": "date", "description": "Date the declaration was lodged with the Official Receiver." }, "company_meeting_date": { "type": "string", "format": "date", "description": "Proposed date of the members' meeting." }, "creditors_meeting_date": { "type": "string", "format": "date", "description": "Proposed date of the creditors' meeting." }, "cause_of_inability": { "type": "string", "description": "Why the company cannot continue business because of its liabilities." }, "insolvency_practitioner": { "type": "string", "pattern": "^per_", "description": "Licensed insolvency practitioner appointed as provisional liquidator." } }, "required": [ "entity_type", "declaration_date", "declarants", "or_lodgement_date", "company_meeting_date", "creditors_meeting_date", "cause_of_inability", "insolvency_practitioner" ], "description": "Starts a creditors' winding up. The directors swear a statutory declaration before a commissioner for oaths or notary, lodge it with the Official Receiver, then Entiva lodges the declaration of inability to continue business on Bizfile." }, "Create_sg_creditors_winding_up_declare_inability": { "type": "object", "properties": { "type": { "const": "sg.creditors_winding_up.declare_inability" }, "params": { "$ref": "#/components/schemas/Params_sg_creditors_winding_up_declare_inability" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Creditors' voluntary winding up: declare inability to continue business", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "form_65a_statutory_declaration", "title": "Form 65A statutory declaration of inability to continue business", "source": "generated", "required": true }, { "key": "or_lodgement_receipt", "title": "Official Receiver lodgement receipt", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "ACRA acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_65a_statutory_declaration", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registry_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Form 65A to the Official Receiver", "channel": "both", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "form_65a_not_sworn", "type": null, "when": "No sworn Form 65A has been uploaded." }, { "code": "or_lodgement_missing", "type": null, "when": "There is no proof of lodgement with the Official Receiver." }, { "code": "meeting_dates_out_of_window", "type": null, "when": "A meeting is more than 30 days after the declaration." }, { "code": "licensed_ip_not_engaged", "type": null, "when": "No licensed insolvency practitioner is named." }, { "code": "company_appears_solvent", "type": null, "when": "Directors can declare solvency, so a members' winding up fits." } ] } }, "Params_sg_dormant_status_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "description": "Entity type key." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the financial year the claim covers.", "examples": [ "2026-12-31" ] }, "dormant_since": { "type": "string", "format": "date", "description": "Incorporation date, or the end of the previous financial year." }, "no_significant_accounting_transactions": { "type": "boolean", "description": "Directors confirm no significant accounting transaction in the year." }, "max_total_assets": { "$ref": "#/components/schemas/Money", "description": "Highest total assets at any time in the year." }, "listed_or_subsidiary_of_listed": { "type": "boolean", "description": "True if the company is listed or a subsidiary of a listed company." }, "exemptions_claimed": { "type": "array", "items": {}, "description": "Any of audit_exemption_s205B, financial_statements_exemption_s201A, agm_exemption." }, "iras_route": { "type": "string", "enum": [ "dormant_form", "waiver", "none" ], "description": "IRAS tax treatment to chain." } }, "required": [ "entity_type", "financial_year_end", "dormant_since", "no_significant_accounting_transactions", "max_total_assets", "listed_or_subsidiary_of_listed", "exemptions_claimed" ], "description": "Records the directors' dormancy determination for one financial year and claims what it unlocks: the audit exemption, exemption from preparing and filing financial statements and the AGM exemption. ACRA has no dormant-status filing, so the." }, "Create_sg_dormant_status_apply": { "type": "object", "properties": { "type": { "const": "sg.dormant_status.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_dormant_status_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record dormant status and claim the dormant-company exemptions", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dormancy_declaration", "title": "Directors' dormancy declaration and resolution", "source": "generated", "required": true }, { "key": "ledger_evidence", "title": "Bank statements and trial balance showing no transactions", "source": "uploaded", "required": true }, { "key": "unaudited_branch_accounts", "title": "Unaudited head-office and branch financial statements", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dormancy_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "ACRA", "form": "No standalone dormant-status filing. The exemptions are declared inside the Bizfile annual", "channel": "none", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_dormant", "type": null, "when": "The company recorded a significant accounting transaction in the year." }, { "code": "assets_above_threshold", "type": null, "when": "Total assets exceeded S$500,000, so the s201A and AGM exemptions are refused." }, { "code": "listed_company_not_eligible", "type": null, "when": "The company is listed or a subsidiary of a listed company." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_sg_dormant_tax_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "description": "Entity type key." }, "year_of_assessment": { "type": "integer", "description": "Year of Assessment being filed.", "examples": [ "2026" ] }, "basis_period_end": { "type": "string", "format": "date", "description": "End of the basis period." }, "no_business_and_no_income": { "type": "boolean", "description": "Directors confirm the company carried on no business and had no income for the whole basis period." }, "claim_donations": { "type": "boolean", "description": "True if the company wants to claim donations." } }, "required": [ "entity_type", "year_of_assessment", "basis_period_end", "no_business_and_no_income" ], "description": "Files IRAS's 'Form for dormant company' on myTax Portal for a Year of Assessment when no waiver has been granted. It takes about 5 minutes and no financial statements go to IRAS." }, "Create_sg_dormant_tax_return_file": { "type": "object", "properties": { "type": { "const": "sg.dormant_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_dormant_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the simplified IRAS tax return for a dormant company", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_confirmation", "title": "Directors' confirmation of dormancy for the Year of Assessment", "source": "generated", "required": true }, { "key": "iras_filing_acknowledgement", "title": "IRAS filing acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "director_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "iras_filing_acknowledgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "'Form for dormant company' on myTax Portal", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_dormant_for_tax", "type": null, "when": "The company had income or carried on business in the basis period." }, { "code": "donations_require_full_return", "type": null, "when": "claim_donations is true." }, { "code": "waiver_already_granted", "type": null, "when": "IRAS already granted a waiver, so no return is due." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_sg_dormant_tax_waiver_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "description": "Entity type key." }, "dormant_from": { "type": "string", "format": "date", "description": "Cessation date: the day the company stopped business and income." }, "last_filed_year_of_assessment": { "type": "integer", "description": "Latest Year of Assessment for which Form C-S, C-S or C, financial statements and tax computation were filed." }, "outstanding_years_of_assessment": { "type": "array", "items": {}, "description": "Years of Assessment up to the cessation date still to be filed." }, "owns_investments": { "type": "boolean", "description": "True if the company owns investments." }, "derives_investment_income": { "type": "boolean", "description": "True if any owned investment produces income." }, "gst_registered": { "type": "boolean", "description": "True if the company is or was GST-registered." }, "intends_recommence_within_2_years": { "type": "boolean", "description": "True if the company intends to restart business within 2 years." }, "sole_director_deceased_or_bankrupt": { "type": "boolean", "description": "True if the sole director has died or is bankrupt." } }, "required": [ "entity_type", "dormant_from", "last_filed_year_of_assessment", "owns_investments", "derives_investment_income", "gst_registered", "intends_recommence_within_2_years" ], "description": "Applies on myTax Portal for a waiver of corporate income tax filing for a dormant company. Once granted, no yearly reapplication is needed and no Form C-S, Form C or ECI is required from that date." }, "Create_sg_dormant_tax_waiver_apply": { "type": "object", "properties": { "type": { "const": "sg.dormant_tax_waiver.apply" }, "params": { "$ref": "#/components/schemas/Params_sg_dormant_tax_waiver_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to IRAS for the dormant-company tax return waiver", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dormancy_declaration", "title": "Directors' declaration of dormancy for tax", "source": "generated", "required": true }, { "key": "final_returns_package", "title": "Financial statements and tax computations for outstanding Years of Assessment", "source": "uploaded", "required": false }, { "key": "gst_cancellation_confirmation", "title": "IRAS GST cancellation confirmation", "source": "registry_issued", "required": false }, { "key": "iras_waiver_decision", "title": "IRAS waiver decision notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dormancy_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "iras_waiver_decision", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "myTax Portal e-service 'Apply for Waiver/ File last Form C-S/ C", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_dormant_for_tax", "type": null, "when": "The company carried on business or had income in the period." }, { "code": "investment_income_present", "type": null, "when": "An owned investment produces income." }, { "code": "gst_registration_active", "type": null, "when": "GST is not yet cancelled." }, { "code": "recommencement_intended", "type": null, "when": "The company plans to restart within 2 years." }, { "code": "foreign_company_not_eligible", "type": null, "when": "The entity is a foreign company or Singapore branch." }, { "code": "outstanding_returns_not_filed", "type": null, "when": "Outstanding returns were not filed within 21 days." } ] } }, "Params_sg_early_dissolution_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "liquidator_type": { "type": "string", "enum": [ "official_receiver", "other_liquidator" ], "description": "Official Receiver or any other liquidator." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator." }, "notice_date": { "type": "string", "format": "date", "description": "Date the notice was given." }, "or_written_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "Official Receiver's written consent." }, "newspaper_advertisement_date": { "type": "string", "format": "date", "description": "Date of the English-daily advertisement." }, "assets_insufficient_confirmed": { "type": "boolean", "description": "The liquidator has reasonable cause to believe realisable assets cannot cover winding-up expenses and that no further investigation is needed." }, "replacement_liquidator_appointed": { "type": "boolean", "description": "True if a creditor, contributory or receiver appointed a replacement within the 30 days." }, "s211_4_order_made": { "type": "boolean", "description": "True if a court order under s211 stops the strike-off." } }, "required": [ "entity_type", "liquidator_type", "notice_date", "newspaper_advertisement_date", "assets_insufficient_confirmed" ], "description": "Lodges the Notice of Early Dissolution through Bizfile General Lodgement. A liquidator who believes realisable assets cannot cover winding-up expenses and that no further investigation is needed gives notice, waits 30 days, then lodges the." }, "Create_sg_early_dissolution_notify": { "type": "object", "properties": { "type": { "const": "sg.early_dissolution.notify" }, "params": { "$ref": "#/components/schemas/Params_sg_early_dissolution_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify early dissolution where assets cannot cover winding-up costs", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "early_dissolution_notice", "title": "Notice of early dissolution", "source": "generated", "required": true }, { "key": "or_consent_letter", "title": "Official Receiver's written consent", "source": "uploaded", "required": false }, { "key": "general_lodgement_receipt", "title": "ACRA General Lodgement receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "early_dissolution_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "general_lodgement_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile General Lodgement: 'Notice of Early Dissolution under section 209 or 210 of IRDA'", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "or_consent_missing", "type": null, "when": "A non-Official Receiver liquidator has no written consent." }, { "code": "notice_period_not_elapsed", "type": null, "when": "Fewer than 30 days passed since the notice." }, { "code": "replacement_liquidator_appointed", "type": null, "when": "A replacement was appointed or a s211 order was made, so the route stops." }, { "code": "assets_sufficient", "type": null, "when": "Realisable assets may cover winding-up expenses." } ] } }, "Params_sg_entity_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "description": "Entity type being restored." }, "struck_off_date": { "type": "string", "format": "date", "description": "Date the name was struck off, from the Gazette notice or ACRA's history." }, "strike_off_initiator": { "type": "string", "enum": [ "registrar", "voluntary_application", "unknown" ], "description": "Who started the strike-off." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The former director or former member who applies." }, "applicant_capacity": { "type": "string", "enum": [ "former_director", "former_member", "former_partner" ], "description": "Capacity in which the applicant applies." }, "reasons_for_restoration": { "type": "string", "description": "Reasons for the application as entered in Bizfile, for example contracts, tenancies or liabilities that cannot be met without restoration." }, "intended_use": { "type": "string", "description": "The business the entity will carry on after restoration." }, "lawful_purpose_confirmed": { "type": "boolean", "description": "Must be true: the applicant confirms the entity will not be used for an unlawful purpose or one prejudicial to public peace, or contrary to national security." }, "court_application_made": { "type": "boolean", "description": "Must be false: a High Court application to restore the same entity, made or pending, bars the administrative route (Companies Act s344D; LLP Act s67)." }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref IDs for supporting documents, for example ongoing contracts, tenancy agreements or obligations that cannot be met without restoration." }, "property_of_struck_off_entity": { "type": "object", "description": "Answers for ACRA's 'Property of the Struck-off Company' declarations: {has_property: boolean, description: string, vested_in_official_receiver: boolean." }, "outstanding_filings": { "type": "object", "description": "How outstanding statutory filings are handled, for ACRA's 'Lodgement of Company Documents' and 'Payment of Outstanding Fees' declarations: {handling." } }, "required": [ "entity_type", "struck_off_date", "strike_off_initiator", "applicant", "applicant_capacity", "reasons_for_restoration", "intended_use", "lawful_purpose_confirmed", "court_application_made", "supporting_documents", "property_of_struck_off_entity", "outstanding_filings" ], "description": "Applies to ACRA on Bizfile, through Entiva's registered CSP, to restore the name of a company, LLP or registered foreign company that ACRA struck off, so its status returns to Live." }, "Create_sg_entity_restore": { "type": "object", "properties": { "type": { "const": "sg.entity.restore" }, "params": { "$ref": "#/components/schemas/Params_sg_entity_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off company, LLP or foreign company branch", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "supporting_documents", "title": "Supporting documents", "source": "uploaded", "required": true }, { "key": "official_receiver_consent", "title": "Official Receiver's written consent", "source": "uploaded", "required": false }, { "key": "outstanding_filings_package", "title": "Outstanding annual returns and financial statements", "source": "generated", "required": false }, { "key": "applicant_authorisation", "title": "Authority to file and applicant's declarations", "source": "generated", "required": true }, { "key": "letter_of_undertaking", "title": "Letters of undertaking", "source": "generated", "required": true }, { "key": "bizfile_application", "title": "Bizfile 'Apply to restore business entity' submission", "source": "generated", "required": true }, { "key": "restoration_notice", "title": "ACRA approval or rejection notice", "source": "registry_issued", "required": false }, { "key": "gazette_notice", "title": "Government Gazette notice of restoration", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "applicant_authorisation", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "letter_of_undertaking", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply to restore business entity' eService, administrative restoration route", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_window_expired", "type": null, "when": "More than 6 years have passed since dissolution or since the name was struck off." }, { "code": "applicant_not_eligible", "type": null, "when": "The applicant is not recorded as a former director or member of the entity." }, { "code": "court_application_pending", "type": null, "when": "court_application_made is true, which bars an administrative application under s344D and s67." }, { "code": "restoration_refused", "type": null, "when": "ACRA refuses the application, including on the mandatory unlawful-purpose and national-security grounds from 20 Oct 2026; the action moves to rejected." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_final_meeting_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "winding_up_type": { "type": "string", "enum": [ "members", "creditors" ], "description": "A creditors' winding up holds a joint meeting of members and creditors." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The appointed liquidator." }, "advertisement_date": { "type": "string", "format": "date", "description": "Date the meeting notice was published in the Gazette and an English daily." }, "final_meeting_date": { "type": "string", "format": "date", "description": "Date of the final meeting." }, "meeting_outcome": { "type": "string", "enum": [ "held", "no_quorum" ], "description": "If no quorum attends, the return says the meeting was duly summoned and no quorum was present." }, "final_account_document_id": { "type": "string", "pattern": "^doc_", "description": "The liquidator's final account." }, "or_lodgement_date": { "type": "string", "format": "date", "description": "Date the return was lodged with the Official Receiver." } }, "required": [ "entity_type", "winding_up_type", "liquidator", "advertisement_date", "final_meeting_date", "meeting_outcome", "final_account_document_id", "or_lodgement_date" ], "description": "Files the return relating to the final meeting on Bizfile. The liquidator advertises the final meeting at least 30 days ahead, holds it, and lodges the return within 7 days." }, "Create_sg_final_meeting_return_file": { "type": "object", "properties": { "type": { "const": "sg.final_meeting_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_final_meeting_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the liquidator's return of the final meeting", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "final_account", "title": "Liquidator's final account", "source": "uploaded", "required": true }, { "key": "final_meeting_notice", "title": "Gazette and English-daily notice of the final meeting", "source": "generated", "required": true }, { "key": "final_meeting_minutes", "title": "Minutes or no-quorum record of the final meeting", "source": "uploaded", "required": true }, { "key": "acra_receipt", "title": "ACRA receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "final_account", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_meeting_minutes", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "acra_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Manage winding up': 'Return", "channel": "online", "government_fee": { "amount": 20, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "advertisement_too_late", "type": null, "when": "The meeting is less than 30 days after the advertisement." }, { "code": "return_deadline_missed", "type": null, "when": "More than 7 days have passed since the meeting." }, { "code": "iras_matters_unresolved", "type": null, "when": "IRAS declarations or tax matters are open." }, { "code": "liquidator_accounts_missing", "type": null, "when": "The final account is not filed." } ] } }, "Params_sg_foreign_company_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Entity type key." }, "effective_date": { "type": "string", "format": "date", "description": "Date the branch ceased its place of business or business in Singapore." }, "reason": { "type": "string", "description": "Reason for ceasing." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The branch's authorised representative." }, "gst_registered": { "type": "boolean", "description": "True if GST is registered." }, "outstanding_form_c_years": { "type": "array", "items": {}, "description": "Years of Assessment of Form C, financial statements and tax computation still to be filed up to the last day of business." }, "iras_contact_person": { "type": "string", "description": "Contact person named in the IRAS cessation letter." } }, "required": [ "entity_type", "effective_date", "reason", "gst_registered", "iras_contact_person" ], "description": "Files the cessation notice on Bizfile when the branch stops business in Singapore, and gives IRAS the written notice of cessation with all outstanding Form C returns. Filed by the branch's authorised representative." }, "Create_sg_foreign_company_cease": { "type": "object", "properties": { "type": { "const": "sg.foreign_company.cease" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify cessation of a foreign company's Singapore branch", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "head_office_resolution", "title": "Head-office board resolution approving the cessation", "source": "generated", "required": true }, { "key": "iras_cessation_notice", "title": "IRAS letter 'Cessation of Business in Singapore'", "source": "generated", "required": true }, { "key": "final_form_c_package", "title": "Outstanding Form C returns, financial statements and tax computations", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "ACRA acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "head_office_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File cessation or dissolution of business entity', plus IRAS written notice 'Cess", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cessation_notice_late", "type": null, "when": "The 7-day period after cessation has passed." }, { "code": "gst_registration_active", "type": null, "when": "GST is not yet cancelled." }, { "code": "no_authorised_representative", "type": null, "when": "The branch has none, so use sg.foreign_company.strike_off." }, { "code": "outstanding_returns_missing", "type": null, "when": "A Form C package is missing for an outstanding year." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a foreign company branch." } ] } }, "Params_sg_foreign_company_strike_off": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Entity type key." }, "ground": { "type": "string", "enum": [ "sole_representative_cannot_resign", "head_office_unresponsive_12_months", "no_authorised_representative" ], "description": "The ACRA ground relied on." }, "ground_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Evidence of the ground: the failed resignation, or the 12-month inquiry to the head office." }, "confirmations": { "type": "object", "description": "All must be true: no_unpaid_debts_or_government_issues, no_legal_cases, no_regulatory_or_disciplinary_action, owns_nothing_owes_nothing." }, "gst_cancelled": { "type": "boolean", "description": "GST registration of the foreign company or its branch is cancelled, or never existed." }, "tax_credits_checked": { "type": "boolean", "description": "Outstanding tax credits were checked." }, "effective_date": { "type": "string", "format": "date", "description": "Cessation date, if applicable." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The branch's representative, if there is one." } }, "required": [ "entity_type", "ground", "ground_evidence_document_id", "confirmations", "gst_cancelled", "tax_credits_checked" ], "description": "Applies on Bizfile to remove a foreign company branch from the register when it is not carrying on business and meets ACRA's grounds: the sole representative cannot resign, the head office has not replied for 12 months, or the branch has." }, "Create_sg_foreign_company_strike_off": { "type": "object", "properties": { "type": { "const": "sg.foreign_company.strike_off" }, "params": { "$ref": "#/components/schemas/Params_sg_foreign_company_strike_off" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Strike off a foreign company branch", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ground_evidence", "title": "Evidence for the ground relied on", "source": "uploaded", "required": true }, { "key": "acra_approval_notice", "title": "ACRA approval notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "acra_approval_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply to strike off business entity'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ground_not_established", "type": null, "when": "The evidence does not support the ground." }, { "code": "outstanding_government_matters", "type": null, "when": "IRAS or another agency has open matters." }, { "code": "gst_registration_active", "type": null, "when": "GST is not cancelled." }, { "code": "csp_not_permitted", "type": null, "when": "The branch has an authorised representative, so Entiva cannot file as CSP." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a foreign company branch." } ] } }, "Params_sg_gst_final_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "description": "Entity type of the GST-registered entity." }, "gst_registration_number": { "type": "string", "description": "GST registration number." }, "cancellation_action": { "type": "string", "description": "ID of the sg.gst_registration.cancel action." }, "cancellation_effective_date": { "type": "string", "format": "date", "description": "Effective date of cancellation in IRAS's approval notice." }, "return_period_start": { "type": "string", "format": "date", "description": "Start of the F8 period as stated on the return IRAS issued." }, "return_period_end": { "type": "string", "format": "date", "description": "End of the F8 period." }, "return_figures": { "type": "object", "description": "Figures for the return as money objects: {total_standard_rated_supplies, total_zero_rated_supplies, total_exempt_supplies, total_taxable_purchases." }, "assets_on_hand": { "type": "array", "items": {}, "description": "Business assets held on the last day of registration: array of {description, category, input_tax_claimed: boolean, obtained_as_going_concern: boolean." }, "assets_exemption": { "type": "string", "enum": [ "none", "total_omv_10000_or_less", "whole_business_transferred_as_going_concern" ], "description": "Why no output tax is due on assets. none: tax is due. total_omv_10000_or_less: the qualifying assets total S$10,000 or less.." }, "spanning_supplies": { "type": "array", "items": {}, "description": "Supplies delivered or performed before cancellation but invoiced or paid after it: array of {description, value: money, output_tax_already_accounted: money}." }, "outstanding_returns_status": { "type": "string", "enum": [ "all_filed", "entiva_files", "customer_files" ], "description": "IRAS requires all outstanding GST returns to be filed and outstanding GST paid. all_filed: nothing outstanding. entiva_files: Entiva files them with this." }, "filer_capacity": { "type": "string", "enum": [ "entity_officer", "liquidator" ], "description": "Who files." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator." }, "payment_confirmation": { "type": "object", "description": "Confirmation that the GST due was paid to IRAS: {paid_on: date, reference: string}." } }, "required": [ "entity_type", "gst_registration_number", "cancellation_effective_date", "return_period_start", "return_period_end", "return_figures", "outstanding_returns_status", "filer_capacity" ], "description": "Files the final GST return, GST F8, that IRAS issues once cancellation of GST registration is approved. It covers GST up to the last day of registration, which is one day before the effective date of cancellation." }, "Create_sg_gst_final_return_file": { "type": "object", "properties": { "type": { "const": "sg.gst_final_return.file" }, "params": { "$ref": "#/components/schemas/Params_sg_gst_final_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the final GST return after cancellation", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "f8_workings", "title": "Workings for the final return", "source": "generated", "required": true }, { "key": "asset_valuation", "title": "Open market value of business assets", "source": "uploaded", "required": false }, { "key": "figures_declaration", "title": "Approval of the final return figures", "source": "generated", "required": true }, { "key": "corppass_authorisation", "title": "Corppass authorisation for Entiva's filer", "source": "uploaded", "required": false }, { "key": "gst_f8_submission", "title": "GST F8 submission", "source": "generated", "required": true }, { "key": "f8_acknowledgement", "title": "IRAS acknowledgement of the F8", "source": "registry_issued", "required": false }, { "key": "statement_of_account", "title": "IRAS statement of account", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "figures_declaration", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "gst_f8_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "GST F8", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "final_return_not_issued", "type": null, "when": "The cancellation is approved but IRAS has not yet issued the F8 on myTax." }, { "code": "outstanding_returns_unfiled", "type": null, "when": "Earlier GST returns are unfiled and outstanding_returns_status says all_filed." }, { "code": "asset_valuation_missing", "type": null, "when": "Assets that need output tax total more than S$10,000 and no valuation was uploaded." }, { "code": "filing_deadline_passed", "type": null, "when": "More than one month has passed since the end of the F8 period." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_gst_registration_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "description": "Entity type of the GST-registered entity." }, "gst_registration_number": { "type": "string", "description": "GST registration number as shown on IRAS's register of GST-registered businesses." }, "reason": { "type": "string", "enum": [ "stopped_taxable_supplies", "business_ceased", "business_transferred_as_whole", "business_form_changed", "not_liable_to_register" ], "description": "Compulsory: stopped_taxable_supplies, business_ceased, business_transferred_as_whole, business_form_changed." }, "event_date": { "type": "string", "format": "date", "description": "Date of the event that starts the 30-day duty: taxable supplies stopped, business ceased, business transferred as a whole, or legal form changed." }, "filer_capacity": { "type": "string", "enum": [ "entity_officer", "liquidator" ], "description": "Who applies." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator." }, "registered_voluntarily": { "type": "boolean", "description": "Whether registration was voluntary." }, "registration_effective_date": { "type": "string", "format": "date", "description": "GST registration effective date." }, "projected_taxable_turnover_12m": { "$ref": "#/components/schemas/Money", "description": "Required when reason is not_liable_to_register: projected taxable turnover for the next 12 months, which must be S$1 million or less due to specific." }, "reverse_charge_liable": { "type": "boolean", "description": "Required when reason is not_liable_to_register: whether the entity is still liable under reverse charge." }, "business_transfer": { "type": "object", "description": "Required when reason is business_transferred_as_whole: {transferee_name, transferee_uen, transferee_gst_registered: boolean, transfer_date: date." }, "successor_entity": { "type": "object", "description": "Required when reason is business_form_changed: {entity_type, uen, name} of the new form." }, "assets_on_hand_open_market_value": { "$ref": "#/components/schemas/Money", "description": "Estimated open market value of assets held on the last day of registration with input tax claimed or acquired as a going concern." }, "file_final_return": { "type": "boolean", "description": "When true Entiva creates sg.gst_final_return.file as soon as IRAS approves and issues the F8." } }, "required": [ "entity_type", "gst_registration_number", "reason", "event_date", "filer_capacity" ], "description": "Applies on myTax Portal to cancel the entity's GST registration, which IRAS requires within 30 days of stopping taxable supplies, ceasing business, transferring the business as a whole or changing its legal form." }, "Create_sg_gst_registration_cancel": { "type": "object", "properties": { "type": { "const": "sg.gst_registration.cancel" }, "params": { "$ref": "#/components/schemas/Params_sg_gst_registration_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel GST registration with IRAS", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "lp", "general_partnership", "sole_proprietorship", "foreign_company", "vcc", "registered_society", "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cessation_authorisation", "title": "Decision and authority to cancel GST registration", "source": "generated", "required": true }, { "key": "corppass_authorisation", "title": "Corppass authorisation for Entiva's filer", "source": "uploaded", "required": true }, { "key": "turnover_projection_support", "title": "Support for the 12-month turnover projection", "source": "uploaded", "required": false }, { "key": "business_transfer_agreement", "title": "Agreement transferring the business", "source": "uploaded", "required": false }, { "key": "gst_cancellation_application", "title": "GST cancellation application", "source": "generated", "required": true }, { "key": "iras_cancellation_approval", "title": "IRAS approval notice with effective date", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cessation_authorisation", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "corppass_authorisation", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gst_cancellation_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRAS", "form": "Application for cancellation of GST registration on myTax Portal", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "voluntary_registration_minimum_period", "type": null, "when": "registered_voluntarily is true and fewer than 2 years have passed since registration_effective_date." }, { "code": "turnover_condition_not_met", "type": null, "when": "reason is not_liable_to_register but the projected turnover is above S$1 million, the entity is still liable under reverse charge, or no substantiation was uploaded." }, { "code": "cancellation_overdue", "type": null, "when": "More than 30 days have passed since event_date on a compulsory reason." }, { "code": "corppass_authorisation_missing", "type": null, "when": "Entiva's filer is not assigned to the GST digital service with the Approver role, or the authorisation has expired." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_liquidator_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "winding_up_type": { "type": "string", "enum": [ "members", "creditors" ], "description": "Which winding up." }, "appointment_type": { "type": "string", "enum": [ "liquidator", "provisional_liquidator" ], "description": "A provisional liquidator is appointed immediately after the creditors' declaration." }, "effective_date": { "type": "string", "format": "date", "description": "Today or a past date." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the winding up commenced." }, "liquidators": { "type": "array", "items": {}, "description": "At least one." }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "Copy of the resolution appointing the liquidator." }, "proposed_remuneration": { "$ref": "#/components/schemas/Money", "description": "Liquidator's proposed remuneration." } }, "required": [ "entity_type", "winding_up_type", "appointment_type", "effective_date", "commencement_date", "liquidators", "resolution_document_id" ], "description": "Files the notice of appointment of a liquidator or provisional liquidator on Bizfile. In a members' winding up this is the third and last opening filing and sets the entity to In-Liquidation." }, "Create_sg_liquidator_appoint": { "type": "object", "properties": { "type": { "const": "sg.liquidator.appoint" }, "params": { "$ref": "#/components/schemas/Params_sg_liquidator_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Voluntary winding up: appoint the liquidator or provisional liquidator", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidator_consent_to_act", "title": "Liquidator's consent to act", "source": "uploaded", "required": true }, { "key": "appointment_resolution", "title": "Resolution appointing the liquidator", "source": "generated", "required": true }, { "key": "ip_licence_check", "title": "MinLaw register of insolvency practitioners check", "source": "registry_issued", "required": false }, { "key": "acra_receipt_and_status_notice", "title": "ACRA receipt and In-Liquidation status notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "appointment_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "acra_receipt_and_status_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File winding up of business entity'", "channel": "online", "government_fee": { "amount": 20, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liquidator_not_licensed", "type": null, "when": "A creditors' winding up names a liquidator with no valid IP licence." }, { "code": "prior_filings_missing", "type": null, "when": "The declaration or notice of resolution has not been filed." }, { "code": "liquidator_consent_missing", "type": null, "when": "The liquidator's consent to act is not uploaded." }, { "code": "provisional_liquidator_expired", "type": null, "when": "A provisional liquidator's 30 days ended without an extension." } ] } }, "Params_sg_liquidator_accounts_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The appointed liquidator." }, "period_start": { "type": "string", "format": "date", "description": "First period starts at the earliest appointment date." }, "period_end": { "type": "string", "format": "date", "description": "Not more than 12 months after the start." }, "is_final_account": { "type": "boolean", "description": "True if the liquidator ceases to act or is released by court order." }, "or_filing_date": { "type": "string", "format": "date", "description": "Date the account and statement were filed with the Official Receiver." }, "account_document_id": { "type": "string", "pattern": "^doc_", "description": "Account of receipts and payments and statement of position, kept as the Entiva record." } }, "required": [ "entity_type", "liquidator", "period_start", "period_end", "is_final_account", "or_filing_date", "account_document_id" ], "description": "Files the liquidator's account of receipts and payments and statement of position through Bizfile 'Manage winding up', for a members' or creditors' voluntary winding up that began on or after 30 July 2020. Each period is at most 12 months." }, "Create_sg_liquidator_accounts_file": { "type": "object", "properties": { "type": { "const": "sg.liquidator_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_sg_liquidator_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the liquidator's account of receipts and payments", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "receipts_and_payments_account", "title": "Account of receipts and payments and statement of position", "source": "uploaded", "required": true }, { "key": "or_filing_evidence", "title": "Evidence of filing with the Official Receiver", "source": "uploaded", "required": true }, { "key": "acra_receipt", "title": "ACRA receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" } ], "approvals": [], "signatures": [ { "document_key": "receipts_and_payments_account", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "acra_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Manage winding up': 'Liquidator's Account of Receipts & Payments & Statement of P", "channel": "online", "government_fee": { "amount": 20, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "period_exceeds_12_months", "type": null, "when": "The period is longer than 12 months." }, { "code": "period_not_ended", "type": null, "when": "period_end is in the future." }, { "code": "pre_irda_winding_up_not_supported", "type": null, "when": "The winding up began before 30 July 2020." }, { "code": "or_filing_missing", "type": null, "when": "No Official Receiver filing date or evidence." } ] } }, "Params_sg_llp_strike_off": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llp" ], "description": "Entity type key." }, "reason": { "type": "string", "description": "Reason for striking off, as entered in Bizfile." }, "effective_date": { "type": "string", "format": "date", "description": "Date the LLP ceased business." }, "confirmations": { "type": "object", "description": "All must be true: ceased_business, no_unpaid_debts_or_government_issues, no_registered_charges, no_legal_or_regulatory_proceedings, owns_nothing_owes_nothing." }, "consenting_partners": { "type": "array", "items": {}, "description": "person_ref list of the partners who consent." }, "tax_credits_checked": { "type": "boolean", "description": "Outstanding tax credits were checked." }, "registered_office_and_email_current": { "type": "boolean", "description": "Registered office address and LLP email are current." }, "submit_not_before": { "type": "string", "format": "date", "description": "Earliest submission date." } }, "required": [ "entity_type", "reason", "confirmations", "consenting_partners", "tax_credits_checked", "registered_office_and_email_current" ], "description": "Applies on Bizfile to strike an LLP off the register. The criteria match those for companies, and all or a majority of partners must agree." }, "Create_sg_llp_strike_off": { "type": "object", "properties": { "type": { "const": "sg.llp.strike_off" }, "params": { "$ref": "#/components/schemas/Params_sg_llp_strike_off" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Strike off a limited liability partnership", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_consent_resolution", "title": "Partners' resolution consenting to strike-off", "source": "generated", "required": true }, { "key": "iras_evidence", "title": "IRAS Notice of Assessment and Statement of Accounts", "source": "uploaded", "required": false }, { "key": "bizfile_application", "title": "Bizfile application", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_consent_resolution", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bizfile_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply to strike off business entity'", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "striking_off_criteria_not_met", "type": null, "when": "A confirmation is false." }, { "code": "outstanding_government_matters", "type": null, "when": "IRAS or another agency has unresolved matters." }, { "code": "registered_charge_exists", "type": null, "when": "An unsatisfied charge is registered." }, { "code": "majority_consent_missing", "type": null, "when": "Fewer than a majority of partners consented." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an LLP." } ] } }, "Params_sg_members_winding_up_declare_solvency": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "declaration_date": { "type": "string", "format": "date", "description": "Date of the directors' meeting." }, "attending_directors": { "type": "array", "items": {}, "description": "person_ref list of directors who attended the meeting." }, "declarants": { "type": "array", "items": {}, "description": "person_ref list of those who made the declaration: all directors if two or fewer, otherwise a majority." }, "debts_payable_within_12_months": { "type": "boolean", "description": "Declarants formed the opinion that debts can be paid in full within 12 months after winding up begins." }, "statement_of_affairs_document_id": { "type": "string", "pattern": "^doc_", "description": "Statement of affairs in the prescribed form: assets and expected realisation, liabilities, estimated winding-up expenses, to the latest practicable date." }, "planned_resolution_date": { "type": "string", "format": "date", "description": "Planned date of the winding-up resolution." }, "notice_of_meeting_date": { "type": "string", "format": "date", "description": "Date the notices of the resolution meeting will be sent." } }, "required": [ "entity_type", "declaration_date", "attending_directors", "declarants", "debts_payable_within_12_months", "statement_of_affairs_document_id", "planned_resolution_date" ], "description": "First Bizfile filing of a solvent winding up. Directors declare at a directors' meeting that the company can pay its debts in full within 12 months of winding up, attach the statement of affairs, and lodge before the notices of the." }, "Create_sg_members_winding_up_declare_solvency": { "type": "object", "properties": { "type": { "const": "sg.members_winding_up.declare_solvency" }, "params": { "$ref": "#/components/schemas/Params_sg_members_winding_up_declare_solvency" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Members' voluntary winding up: lodge the declaration of solvency", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "directors_meeting_minutes", "title": "Minutes of the directors' meeting", "source": "generated", "required": true }, { "key": "declaration_of_solvency", "title": "Declaration of solvency", "source": "generated", "required": true }, { "key": "statement_of_affairs", "title": "Statement of affairs", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "ACRA acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "declaration_of_solvency", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "directors_meeting_minutes", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File winding up of business entity': declaration of solvency with statement of af", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "solvency_opinion_missing", "type": null, "when": "Declarants cannot confirm payment of debts within 12 months." }, { "code": "declaration_window_exceeded", "type": null, "when": "planned_resolution_date is more than 5 weeks after declaration_date." }, { "code": "declaration_after_notices", "type": null, "when": "The notices of the meeting were already sent." }, { "code": "statement_of_affairs_incomplete", "type": null, "when": "The statement lacks assets, liabilities or estimated expenses." }, { "code": "open_sanctions_alert", "type": null, "when": "An open screening alert on a declarant pauses the action." } ] } }, "Params_sg_representative_office_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "representative_office" ], "description": "Entity type." }, "licence_number": { "type": "string", "description": "Enterprise Singapore RO licence number, as shown on the GoBusiness licence." }, "foreign_parent_name": { "type": "string", "description": "Name of the foreign entity that holds the licence." }, "foreign_parent_country": { "type": "string", "description": "ISO 3166 country code of the foreign parent." }, "foreign_parent_registration_number": { "type": "string", "description": "Registration number of the foreign parent in its home register." }, "licence_expiry_date": { "type": "string", "format": "date", "description": "Expiry date of the current licence." }, "requested_cancellation_date": { "type": "string", "format": "date", "description": "Date the cancellation should take effect." }, "reason": { "type": "string", "enum": [ "closing_singapore_presence", "replaced_by_branch", "replaced_by_subsidiary", "licence_period_ending", "parent_restructuring", "other" ], "description": "Why the licence is being cancelled." }, "chief_representative": { "type": "string", "pattern": "^per_", "description": "The Chief Representative stationed in Singapore." }, "parent_authorised_signatory": { "type": "string", "pattern": "^per_", "description": "The foreign parent's authorised signatory who signs the authority letter." }, "continuing_presence": { "type": "string", "enum": [ "none", "foreign_company", "subsidiary" ], "description": "What replaces the RO, if anything." }, "successor_formation_id": { "type": "string", "description": "ID of the formation that creates the successor." }, "licence_fees_non_refundable_acknowledged": { "type": "boolean", "description": "The parent acknowledges that licence fees already paid are not refunded." }, "no_reregistration_acknowledged": { "type": "boolean", "description": "The parent acknowledges that an RO cannot be re-registered after cancellation." } }, "required": [ "entity_type", "licence_number", "foreign_parent_name", "foreign_parent_country", "foreign_parent_registration_number", "licence_expiry_date", "requested_cancellation_date", "reason", "chief_representative", "parent_authorised_signatory", "continuing_presence", "licence_fees_non_refundable_acknowledged", "no_reregistration_acknowledged" ], "description": "Cancels an Enterprise Singapore Representative Office licence through GoBusiness before it expires, when the foreign parent is closing its Singapore presence early. Entiva files as the authorised third-party filer." }, "Create_sg_representative_office_cancel": { "type": "object", "properties": { "type": { "const": "sg.representative_office.cancel" }, "params": { "$ref": "#/components/schemas/Params_sg_representative_office_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a Representative Office licence", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "representative_office" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "parent_authority_letter", "title": "Parent's authority to cancel and to appoint Entiva as third-party filer", "source": "generated", "required": true }, { "key": "parent_board_resolution", "title": "Parent's board resolution to close the RO", "source": "uploaded", "required": false }, { "key": "cancellation_application", "title": "GoBusiness cancellation application", "source": "generated", "required": true }, { "key": "cancellation_confirmation", "title": "Enterprise Singapore confirmation of cancellation", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "parent_authority_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cancellation_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Enterprise Singapore", "form": "GoBusiness cancellation application for the Representative Office licence", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "licence_not_active", "type": null, "when": "The licence number is not an active RO licence." }, { "code": "parent_authority_missing", "type": null, "when": "The authority letter is unsigned or the signatory is not authorised for the parent." }, { "code": "acknowledgement_required", "type": null, "when": "licence_fees_non_refundable_acknowledged or no_reregistration_acknowledged is not true." }, { "code": "successor_formation_not_found", "type": null, "when": "continuing_presence is not none and successor_formation_id does not exist or is not a Singapore formation." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_restoration_order_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "description": "Entity type being restored." }, "court_order_basis": { "type": "string", "enum": [ "ca_s344_5", "llpa_s68_4", "ca_s377b_5", "irda_s208_2", "other" ], "description": "Provision the order was made under, using ACRA's labels: ca_s344_5 (Companies Act s344), llpa_s68_4 (LLP Act s68), ca_s377b_5 (Companies Act s377B)." }, "court_order_reference": { "type": "string", "description": "Order reference number, as ACRA asks for it." }, "court_order_date": { "type": "string", "format": "date", "description": "Date the order was made." }, "court_order_document": { "type": "string", "pattern": "^doc_", "description": "The sealed order, uploaded as a document with purpose court_order." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The person who obtained the order and is the ACRA applicant." }, "appeal_reasons": { "type": "string", "description": "Reasons as entered in Bizfile." }, "supporting_documents": { "type": "array", "items": {}, "description": "Array of document_ref IDs for further supporting documents ACRA asks for." }, "solicitor": { "type": "object", "description": "Solicitor information: {firm_name, advocate_name, email, phone}." }, "official_receiver_lodged": { "type": "boolean", "description": "For irda_s208_2: whether a copy of the order has been lodged with the Official Receiver." } }, "required": [ "entity_type", "court_order_basis", "court_order_reference", "court_order_date", "court_order_document", "applicant", "appeal_reasons" ], "description": "Lodges a High Court order with ACRA on Bizfile so that the entity's status returns to Live." }, "Create_sg_restoration_order_file": { "type": "object", "properties": { "type": { "const": "sg.restoration_order.file" }, "params": { "$ref": "#/components/schemas/Params_sg_restoration_order_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Lodge a court order restoring an entity, or declaring its dissolution void, with ACRA", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "court_order", "title": "Sealed court order", "source": "uploaded", "required": true }, { "key": "supporting_documents", "title": "Other supporting documents", "source": "uploaded", "required": false }, { "key": "applicant_authorisation", "title": "Authority to lodge the order", "source": "generated", "required": true }, { "key": "bizfile_application", "title": "Bizfile court-order restoration submission", "source": "generated", "required": true }, { "key": "restoration_notice", "title": "ACRA outcome notice", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "applicant_authorisation", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bizfile_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'Apply to restore business entity' eService, court-order routes", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "court_order_missing", "type": null, "when": "No sealed order is attached, or the file cannot be read." }, { "code": "order_entity_mismatch", "type": null, "when": "The UEN or name in the order does not match the entity record." }, { "code": "lodgement_deadline_at_risk", "type": null, "when": "For irda_s208_2, 7 days from the order date are about to pass or have passed." }, { "code": "lodgement_rejected", "type": null, "when": "ACRA rejects the lodgement, for example because the order is incomplete." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_simplified_winding_up_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "description": "Entity type key." }, "nominated_liquidator": { "type": "string", "pattern": "^per_", "description": "Licensed insolvency practitioner nominated as liquidator." }, "liquidator_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "The liquidator's written consent to be nominated and to the proposed remuneration." }, "proposed_remuneration": { "$ref": "#/components/schemas/Money", "description": "Remuneration approved at the meeting." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting passing the special resolution." }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "Signed special resolution, added after the meeting." }, "estimated_total_liabilities": { "$ref": "#/components/schemas/Money", "description": "Liabilities including contingent, prospective and related-party liabilities." }, "no_unsuitability_circumstances": { "type": "boolean", "description": "Directors confirm none of the unsuitability circumstances applies, such as an existing s160 resolution, a provisional liquidator, pending legal proceedings, or." } }, "required": [ "entity_type", "nominated_liquidator", "liquidator_consent_document_id", "proposed_remuneration", "meeting_date", "estimated_total_liabilities", "no_unsuitability_circumstances" ], "description": "Company-side first step into the SWUP. The company gets a licensed liquidator's written consent, passes a special resolution nominating the liquidator, lodges the resolution with the Registrar within 7 days and gives notice of its." }, "Create_sg_simplified_winding_up_pass": { "type": "object", "properties": { "type": { "const": "sg.simplified_winding_up.pass" }, "params": { "$ref": "#/components/schemas/Params_sg_simplified_winding_up_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Simplified Winding Up Programme: pass the resolution and give notice of intention", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidator_consent", "title": "Liquidator's written consent and proposed remuneration", "source": "uploaded", "required": true }, { "key": "special_resolution", "title": "Special resolution to enter the SWUP and nominate the liquidator", "source": "generated", "required": true }, { "key": "notice_of_intention", "title": "Notice of intention to enter the SWUP, for every creditor, contributory and officer", "source": "generated", "required": true }, { "key": "acra_lodgement_receipt", "title": "Registrar lodgement receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liquidator_consent", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "acra_lodgement_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Lodgement of the special resolution with the Registrar on Bizfile", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liabilities_above_limit", "type": null, "when": "estimated_total_liabilities exceeds S$2,000,000." }, { "code": "swup_unsuitable", "type": null, "when": "An unsuitability circumstance applies, so use the creditors' route." }, { "code": "liquidator_consent_missing", "type": null, "when": "No written consent from the nominated liquidator." }, { "code": "lodgement_deadline_passed", "type": null, "when": "More than 7 days passed since the resolution." } ] } }, "Params_sg_simplified_winding_up_record": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "description": "Entity type key." }, "resolve_action_id": { "type": "string", "description": "act_ id of the sg.simplified_winding_up.resolve action." }, "objection_status": { "type": "string", "enum": [ "none", "resolved", "substitute_liquidator_nominated", "upheld" ], "description": "Objections to the nominated liquidator or to entry." }, "substitute_liquidator": { "type": "string", "pattern": "^per_", "description": "Required when objection_status is substitute_liquidator_nominated." }, "directors_statement_document_id": { "type": "string", "pattern": "^doc_", "description": "Board statement that liabilities do not exceed S$2 million and that no unsuitability circumstance is known." }, "statement_of_affairs_document_id": { "type": "string", "pattern": "^doc_", "description": "Statement of affairs: assets, debts, creditors, securities, causes of insolvency, debtors, and IDs or UENs." }, "notice_replies_update": { "type": "string", "description": "Update on any reply to the notice of intention." }, "notice_publication_date": { "type": "string", "format": "date", "description": "Date the liquidator publishes the notice of entry." } }, "required": [ "entity_type", "resolve_action_id", "objection_status", "directors_statement_document_id", "statement_of_affairs_document_id", "notice_replies_update" ], "description": "Second step into the SWUP. After the 21-day objection window the company gives the nominated liquidator its directors' statement, statement of affairs and a note of replies." }, "Create_sg_simplified_winding_up_record": { "type": "object", "properties": { "type": { "const": "sg.simplified_winding_up.record" }, "params": { "$ref": "#/components/schemas/Params_sg_simplified_winding_up_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Simplified Winding Up Programme: publish and lodge the notice of entry", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "directors_statement", "title": "Directors' statement on liabilities and suitability", "source": "generated", "required": true }, { "key": "statement_of_affairs", "title": "Statement of affairs", "source": "generated", "required": true }, { "key": "notice_of_entry", "title": "Notice of entry into the SWUP", "source": "generated", "required": true }, { "key": "publication_and_lodgement_receipts", "title": "Receipts for the OR-website publication and the Registrar lodgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_statement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_of_affairs", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_entry", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "publication_and_lodgement_receipts", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Official Receiver's SIP e-Notices", "form": "Notice of entry into the SWUP: published on the Official Receiver's website, then lodged w", "channel": "online", "government_fee": { "amount": 150.42, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "objection_window_open", "type": null, "when": "The 21-day objection window has not ended." }, { "code": "liabilities_above_limit", "type": null, "when": "Liabilities exceed S$2,000,000." }, { "code": "swup_unsuitable", "type": null, "when": "The liquidator finds an unsuitability circumstance, or a valid objection is upheld." }, { "code": "documents_late", "type": null, "when": "Company documents reached the liquidator more than 7 days after the objection window." } ] } }, "Params_sg_society_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_society" ], "description": "Entity type." }, "constitution_dissolution_clause": { "type": "string", "description": "The clause of the society's constitution under which it dissolves, with the threshold it requires." }, "general_meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting that passed the resolution to dissolve." }, "total_members": { "type": "integer", "description": "Total members as at the meeting date." }, "eligible_voting_members": { "type": "integer", "description": "Members eligible to vote as at the meeting date." }, "members_present": { "type": "integer", "description": "Members present at the meeting." }, "votes_for": { "type": "integer", "description": "Votes for dissolution." }, "votes_against": { "type": "integer", "description": "Votes against dissolution." }, "reason_for_dissolution": { "type": "string", "description": "Reason for dissolution, as it will appear in the minutes and the application." }, "remaining_funds": { "$ref": "#/components/schemas/Money", "description": "Funds remaining after paying debts." }, "fund_disposal_description": { "type": "string", "description": "How the remaining funds were or will be disposed of under the society's rules." }, "effective_date_of_dissolution": { "type": "string", "format": "date", "description": "Effective date of dissolution." }, "office_bearers": { "type": "array", "items": {}, "description": "Particulars of all office bearers: array of {person: person_ref, office: string}." }, "president": { "type": "string", "pattern": "^per_", "description": "The President." }, "secretary": { "type": "string", "pattern": "^per_", "description": "The Secretary." }, "treasurer": { "type": "string", "pattern": "^per_", "description": "The Treasurer." }, "submitter": { "type": "string", "pattern": "^per_", "description": "The committee member who logs in to ROS eServices with Singpass and submits." }, "is_charity_or_ipc": { "type": "boolean", "description": "Whether the society is a registered charity or an IPC." }, "bank_account_closed": { "type": "boolean", "description": "Whether the bank account is closed with no balance." }, "tax_clearance_obtained": { "type": "boolean", "description": "Whether tax clearance has been obtained from the Controller of Income Tax." } }, "required": [ "entity_type", "constitution_dissolution_clause", "general_meeting_date", "total_members", "eligible_voting_members", "members_present", "votes_for", "votes_against", "reason_for_dissolution", "remaining_funds", "fund_disposal_description", "effective_date_of_dissolution", "office_bearers", "president", "secretary", "treasurer", "submitter", "is_charity_or_ipc", "bank_account_closed", "tax_clearance_obtained" ], "description": "Prepares and tracks the Voluntary Dissolution application on ROS eServices, which a society uses to deregister once it is no longer active. The society must follow the dissolution rules in its constitution." }, "Create_sg_society_dissolve": { "type": "object", "properties": { "type": { "const": "sg.society.dissolve" }, "params": { "$ref": "#/components/schemas/Params_sg_society_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a registered society voluntarily", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_meeting_minutes", "title": "Signed minutes of the general meeting", "source": "generated", "required": true }, { "key": "meeting_papers", "title": "Agenda, proxy slips and attendance sheet", "source": "uploaded", "required": true }, { "key": "final_audited_accounts", "title": "Final audited income and expenditure statement and balance sheet", "source": "uploaded", "required": true }, { "key": "fund_disposal_evidence", "title": "Evidence that remaining funds were disposed of per the rules", "source": "uploaded", "required": true }, { "key": "closed_bank_account_statement", "title": "Bank statement showing the account closed with no balance", "source": "uploaded", "required": true }, { "key": "iras_tax_clearance", "title": "Evidence of tax clearance from the Controller of Income Tax", "source": "uploaded", "required": true }, { "key": "coc_no_objection_letter", "title": "Letter of no objection from the Commissioner of Charities", "source": "uploaded", "required": false }, { "key": "ros_dissolution_submission", "title": "ROS Voluntary Dissolution application", "source": "generated", "required": true }, { "key": "ros_acknowledgement", "title": "ROS acknowledgement", "source": "registry_issued", "required": false }, { "key": "dissolution_confirmation", "title": "ROS outcome", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "registry_idv" }, { "role": "officer", "verification_level": "identity" }, { "role": "officer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting" }, { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_meeting_minutes", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_dissolution_submission", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_dissolution_submission", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_dissolution_submission", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ros_dissolution_submission", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Societies", "form": "ROS eServices: Voluntary Dissolution", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "singpass_required_for_office_bearer", "type": null, "when": "The President, Secretary or Treasurer has no Singpass." }, { "code": "dissolution_threshold_not_met", "type": null, "when": "The vote does not meet the threshold in constitution_dissolution_clause." }, { "code": "coc_no_objection_required", "type": null, "when": "is_charity_or_ipc is true and no letter of no objection is attached." }, { "code": "tax_clearance_missing", "type": null, "when": "tax_clearance_obtained is false or no evidence is attached." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a person-only step." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert pauses the action." } ] } }, "Params_sg_strike_off_withdraw": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "description": "Entity type key." }, "strike_off_action_id": { "type": "string", "description": "act_ id of the strike-off action to withdraw." }, "reason": { "type": "string", "description": "Why the application is withdrawn." } }, "required": [ "entity_type", "strike_off_action_id" ], "description": "Withdraws a strike-off application that ACRA has not yet completed. The entity stays on the register as live and keeps its compliance duties." }, "Create_sg_strike_off_withdraw": { "type": "object", "properties": { "type": { "const": "sg.strike_off.withdraw" }, "params": { "$ref": "#/components/schemas/Params_sg_strike_off_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a pending strike-off application", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "acra_withdrawal_acknowledgement", "title": "ACRA withdrawal acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "acra_withdrawal_acknowledgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile withdrawal of the application to strike off", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "strike_off_not_pending", "type": null, "when": "The entity is already struck off or has no pending application." }, { "code": "action_not_found", "type": null, "when": "strike_off_action_id does not exist." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_sg_vcc_strike_off": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "vcc" ], "description": "Entity type key." }, "reason": { "type": "string", "description": "Reason for striking off." }, "effective_date": { "type": "string", "format": "date", "description": "Date the VCC stopped business." }, "register_of_members_document_id": { "type": "string", "pattern": "^doc_", "description": "Register of members information." }, "confirmations": { "type": "object", "description": "All must be true: inactive, no_debts, no_assets_or_investor_balances, no_proceedings." }, "consenting_directors": { "type": "array", "items": {}, "description": "person_ref list of VCC directors who consent." }, "umbrella_sub_fund_names": { "type": "array", "items": {}, "description": "Sub-fund names of an umbrella VCC." }, "submit_not_before": { "type": "string", "format": "date", "description": "Earliest submission date." } }, "required": [ "entity_type", "reason", "register_of_members_document_id", "confirmations", "consenting_directors" ], "description": "Applies in VCC eServices to strike an inactive, debt-free VCC off the register under the VCC Regulations 2020. The register of members must be uploaded." }, "Create_sg_vcc_strike_off": { "type": "object", "properties": { "type": { "const": "sg.vcc.strike_off" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_strike_off" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Strike off a variable capital company", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_consent_resolution", "title": "VCC directors' resolution to strike off", "source": "generated", "required": true }, { "key": "register_of_members", "title": "Register of members", "source": "uploaded", "required": true }, { "key": "vcc_eservices_application", "title": "Vcc eservices application", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_consent_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "vcc_eservices_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC eServices > Close a VCC > 'Application to strike off a VCC'", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "vcc_not_inactive", "type": null, "when": "The VCC still has activity, assets or investor balances." }, { "code": "register_of_members_missing", "type": null, "when": "No register of members was uploaded." }, { "code": "majority_consent_missing", "type": null, "when": "Fewer than a majority of directors consented." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a VCC." } ] } }, "Params_sg_vcc_sub_fund_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "vcc" ], "description": "Entity type key." }, "sub_fund_name": { "type": "string", "description": "Registered name of the sub-fund." }, "ground": { "type": "string", "enum": [ "umbrella_ceased_all_business", "sub_fund_inactive" ], "description": "ACRA's two grounds." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the VCC directors resolved to dissolve the sub-fund." }, "assets_and_liabilities_cleared": { "type": "boolean", "description": "Entiva policy: the sub-fund holds no assets and owes no liabilities, and investors are redeemed." }, "fund_manager_confirmation_document_id": { "type": "string", "pattern": "^doc_", "description": "Permissible fund manager's confirmation that the sub-fund is inactive." } }, "required": [ "entity_type", "sub_fund_name", "ground", "resolution_date", "assets_and_liabilities_cleared" ], "description": "Applies in VCC eServices to dissolve one sub-fund of an umbrella VCC without striking off the VCC. ACRA allows it when the umbrella has stopped all business across its sub-funds or the sub-fund is no longer active." }, "Create_sg_vcc_sub_fund_dissolve": { "type": "object", "properties": { "type": { "const": "sg.vcc_sub_fund.dissolve" }, "params": { "$ref": "#/components/schemas/Params_sg_vcc_sub_fund_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a VCC sub-fund", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "vcc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "VCC directors' resolution to dissolve the sub-fund", "source": "generated", "required": true }, { "key": "sub_fund_closing_statement", "title": "Closing statement showing no assets, liabilities or investors", "source": "uploaded", "required": true }, { "key": "vcc_eservices_application", "title": "Vcc eservices application", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "vcc_eservices_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "VCC eServices > Close a VCC > 'Application to Dissolve a Sub-Fund'", "channel": "online", "government_fee": { "amount": null, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "sub_fund_not_found", "type": null, "when": "The named sub-fund is not registered under this VCC." }, { "code": "sub_fund_not_inactive", "type": null, "when": "The sub-fund still has assets, liabilities or investors." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a VCC." } ] } }, "Params_sg_winding_up_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "description": "Entity type key." }, "winding_up_type": { "type": "string", "enum": [ "members", "creditors" ], "description": "Which winding up this resolution belongs to." }, "prior_action_id": { "type": "string", "description": "act_ id of the declaration action." }, "resolution_basis": { "type": "string", "enum": [ "special_resolution", "duration_or_dissolution_event" ], "description": "IRDA s160: expiry of a fixed duration or a dissolution event in the constitution, or a special resolution." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the resolution passed." }, "resolution_document_id": { "type": "string", "pattern": "^doc_", "description": "Signed resolution to upload to Bizfile." }, "corporate_members_only": { "type": "boolean", "description": "True if every member is a corporation." }, "minutes_signed_date": { "type": "string", "format": "date", "description": "Required when corporate_members_only is true." }, "publish_notices": { "type": "boolean", "description": "Default true: Entiva publishes the Gazette and English-daily notices within 10 days." } }, "required": [ "entity_type", "winding_up_type", "prior_action_id", "resolution_basis", "resolution_date", "resolution_document_id", "corporate_members_only" ], "description": "Lodges the winding-up resolution on Bizfile and publishes the Gazette and newspaper notices. Used in both the members' and the creditors' voluntary winding up." }, "Create_sg_winding_up_pass": { "type": "object", "properties": { "type": { "const": "sg.winding_up.pass" }, "params": { "$ref": "#/components/schemas/Params_sg_winding_up_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Voluntary winding up: lodge the notice of resolution", "x-entiva": { "jurisdiction": "sg", "stage": "closure", "applies_to": [ "private_ltd_shares", "exempt_private_company", "public_ltd_shares", "public_ltd_guarantee", "unlimited_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "winding_up_resolution", "title": "Winding-up resolution", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Signed minutes", "source": "generated", "required": false }, { "key": "gazette_and_newspaper_notice", "title": "Gazette and English-daily notice of the resolution", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "ACRA acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "winding_up_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "ACRA", "form": "Bizfile 'File winding up of business entity': notice of resolution", "channel": "online", "government_fee": { "amount": 0, "currency": "SGD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "resolution_outside_solvency_window", "type": null, "when": "Members' route: the resolution is more than 5 weeks after the declaration." }, { "code": "declaration_not_filed", "type": null, "when": "The prior declaration action has not completed." }, { "code": "minutes_required", "type": null, "when": "corporate_members_only is true and minutes are missing." }, { "code": "lodgement_deadline_passed", "type": null, "when": "More than 7 days have passed since the resolution." } ] } }, "Params_uk_acsp_register": { "type": "object", "properties": { "registrant_kind": { "type": "string", "enum": [ "entiva_group_entity", "licensed_partner", "customer_firm" ], "description": "entiva_group_entity: Entiva's own UK entity. licensed_partner: an Entiva firm used by Entiva for licensed acts. customer_firm: another supervised.", "examples": [ "entiva_group_entity" ] }, "senior_person": { "type": "string", "pattern": "^per_", "description": "The applicant's director, general partner, partner or member who files the application.", "examples": [ "per_9Rt3Uk6Fe1" ] }, "senior_person_personal_code": { "type": "string", "description": "The senior person's 11-character Companies House personal code.", "examples": [ "[write-only]" ] }, "company_authentication_code": { "type": "string", "description": "Required when the applicant is a limited company or LLP.", "examples": [ "[write-only]" ] }, "supervisory_bodies": { "type": "array", "items": {}, "description": "At least one UK AML supervisory body.", "examples": [ "[{\"name\":\"HMRC\",\"membership_id\":\"XYML00000000000\"}]" ] }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Correspondence address for the agent account." }, "correspondence_email": { "type": "string", "description": "Correspondence email for the agent account.", "examples": [ "acsp@entiva.example" ] }, "business_sector": { "type": "string", "description": "Optional business sector shown on the form." }, "appear_on_public_acsp_list": { "type": "boolean", "description": "Opt in to appear on Companies House's public ACSP list.", "examples": [ "true" ] }, "accept_agent_responsibilities": { "type": "boolean", "description": "Must be true.", "examples": [ "true" ] }, "additional_account_users": { "type": "array", "items": {}, "description": "Person ids of staff to add to the agent account after registration.", "examples": [ "[\"per_4Hj8Lc2Qd7\"]" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registrant_kind", "senior_person", "senior_person_personal_code", "supervisory_bodies", "correspondence_address", "correspondence_email", "accept_agent_responsibilities", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a UK firm that is supervised for anti-money laundering as a Companies House authorised agent, so it can verify people's identities for Companies House and file for clients." }, "Create_uk_acsp_register": { "type": "object", "properties": { "type": { "const": "uk.acsp.register" }, "params": { "$ref": "#/components/schemas/Params_uk_acsp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a firm as a Companies House authorised corporate service provider", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company", "roe_overseas_entity", "charitable_company", "scottish_qualifying_partnership", "uk_societas", "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "aml_supervision_evidence", "title": "Evidence of AML supervision and membership number", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Resolution approving the application and naming the senior person", "source": "generated", "required": true }, { "key": "acsp_procedures_pack", "title": "Identity verification procedures aligned to the Companies House standard", "source": "generated", "required": true }, { "key": "application_summary", "title": "Application data for the senior person's review", "source": "generated", "required": true }, { "key": "acsp_registration_confirmation", "title": "Companies House confirmation of registration as an authorised agent", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_summary", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_summary", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Online application to register as a Companies House authorised agent", "channel": "online", "government_fee": { "amount": 63, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The applicant entity cannot be an ACSP (for example it is not a relevant person under MLR 2017 reg 8)" }, { "code": "aml_supervision_not_confirmed", "type": null, "when": "No named supervisory authority confirms the applicant is known and supervised, or the details do not match the supervisor's records" }, { "code": "senior_person_not_verified", "type": null, "when": "" }, { "code": "senior_person_role_invalid", "type": null, "when": "The applicant is not a director, general partner, partner, member or equivalent" }, { "code": "authentication_code_invalid", "type": null, "when": "The company authentication code is wrong or missing for a company or LLP applicant" }, { "code": "not_fit_and_proper", "type": null, "when": "The registrar refuses because the applicant does not appear fit and proper" }, { "code": "payment_failed", "type": null, "when": "The £63 application fee is not paid" }, { "code": "human_presence_required", "type": null, "when": "An agent key tries to complete the senior person's sign-in or acceptance step" } ] } }, "Params_uk_articles_adopt": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "model", "model_with_amendments", "cic_model", "bespoke" ], "description": "model, model_with_amendments, cic_model, or bespoke." }, "document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of bespoke articles.", "examples": [ "doc_1Qz8k3Lp6Yq8Fk" ] }, "amendments": { "type": "array", "items": {}, "description": "mode model_with_amendments only." }, "customisations": { "type": "object", "description": "Drafting answers for bespoke without document_id, e.g. {share_classes, transfer_restrictions, drag_and_tag}." } }, "required": [ "mode" ], "description": "Chooses and prepares the articles for a company or CIC that is still forming: the model articles for its type, model articles with amendments, the CIC Regulator's model constitution, or bespoke articles. The result is attached to the." }, "Create_uk_articles_adopt": { "type": "object", "properties": { "type": { "const": "uk.articles.adopt" }, "params": { "$ref": "#/components/schemas/Params_uk_articles_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt articles of association for a company being formed", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "articles_review_note", "title": "Checklist of mandatory clauses and differences from the model articles", "source": "generated", "required": true }, { "key": "bespoke_articles_upload", "title": "Bespoke articles supplied by the customer", "source": "uploaded", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "articles_of_association", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "None separately. Articles travel inside the uk.company.incorporate or uk.cic.incorporate p", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_forming", "type": null, "when": "The entity is already incorporated." }, { "code": "model_articles_not_available", "type": null, "when": "mode is model, model_with_amendments or cic_model for a type that has none." }, { "code": "cic_articles_missing_statutory_clauses", "type": null, "when": "A CIC's articles omit a statutory clause, including the asset lock." }, { "code": "bespoke_articles_unreadable", "type": null, "when": "The uploaded document cannot be read as articles." } ] } }, "Params_uk_charity_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Where the charity registers. england_wales: Charity Commission. scotland: OSCR. northern_ireland is rejected here because CCNI has paused inviting applications.", "examples": [ "england_wales" ] }, "regulator": { "type": "string", "enum": [ "charity_commission", "oscr" ], "description": "Override for cross-border charities.", "examples": [ "charity_commission" ] }, "charitable_purposes": { "type": "string", "description": "The purposes, which must be exclusively charitable, written by the trustees.", "examples": [ "To relieve poverty and advance education in Cardiff." ] }, "public_benefit_statement": { "type": "string", "description": "How the purposes are for the public benefit.", "examples": [ "Our free food and skills programme is open to all residents of Cardiff in need." ] }, "activities_description": { "type": "string", "description": "How the purposes will be carried out.", "examples": [ "Food bank, community kitchen and adult literacy classes." ] }, "trustees": { "type": "array", "items": {}, "description": "Person ids of the charity trustees.", "examples": [ "[\"per_1Qe5Rs8Zb3\",\"per_6Vm2Hn4Dk9\",\"per_3Tx7Jc1Pw5\"]" ] }, "trustee_personal_benefit": { "type": "object", "description": "Shape: {any_benefit, details}.", "examples": [ "{\"any_benefit\":false}" ] }, "works_with_vulnerable_groups": { "type": "boolean", "description": "If true, trustees sign a declaration that all legally required checks were done.", "examples": [ "true" ] }, "income_evidence": { "type": "object", "description": "Charity Commission only: proof the charity's income is over £5,000.", "examples": [ "{\"type\":\"bank_statement\",\"document_id\":\"doc_7Pr3Wn5Lq2\"}" ] }, "bank_account": { "type": "object", "description": "Shape: {account_name, sort_code, account_number}.", "examples": [ "{\"account_name\":\"Brightwater Trust\"}" ] }, "public_contact": { "type": "object", "description": "Shape: {postal_address, email, phone, website}.", "examples": [ "{\"email\":\"info@brightwatertrust.example\"}" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registration_jurisdiction", "charitable_purposes", "public_benefit_statement", "activities_description", "trustees", "trustee_personal_benefit", "works_with_vulnerable_groups", "bank_account", "public_contact", "name", "nature_of_business", "countries_of_operation", "directors", "beneficial_owners" ], "description": "Registers an existing company limited by guarantee with charitable objects as a charity with the Charity Commission for England and Wales or with OSCR in Scotland. Northern Ireland registration is paused and is handled by." }, "Create_uk_charity_register": { "type": "object", "properties": { "type": { "const": "uk.charity.register" }, "params": { "$ref": "#/components/schemas/Params_uk_charity_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charitable company as a charity", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "governing_document", "title": "Articles of association with charitable objects and dissolution clauses", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "uploaded", "required": true }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "uploaded", "required": false }, { "key": "trustee_declaration", "title": "Signed trustee declaration, one per trustee", "source": "uploaded", "required": true }, { "key": "proof_of_income", "title": "Proof of income over £5,000", "source": "uploaded", "required": false }, { "key": "safeguarding_declaration", "title": "Trustees' declaration on checks for work with vulnerable groups", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution approving the charity registration", "source": "generated", "required": true }, { "key": "charity_registration_notice", "title": "Regulator's confirmation with the charity number", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "trustee_declaration", "signer_role": "trustee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for England and Wales, or the Office of the Scottish Charity Regulator", "form": "Charity Commission online registration", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a charitable company" }, { "code": "ccni_registration_paused", "type": null, "when": "registration_jurisdiction is northern_ireland; use uk.charity.register_interest" }, { "code": "objects_not_exclusively_charitable", "type": null, "when": "The articles or purposes are not exclusively charitable" }, { "code": "proof_of_income_missing", "type": null, "when": "england_wales and income_evidence is absent or not independently examined, audited or otherwise acceptable" }, { "code": "income_below_threshold", "type": null, "when": "The Charity Commission applies and income is not over £5,000, so registration is not yet required" }, { "code": "trustee_declaration_missing", "type": null, "when": "A signed trustee declaration scan is missing for any trustee" }, { "code": "trustee_ineligible", "type": null, "when": "The regulator's checks find a named trustee ineligible" }, { "code": "public_benefit_text_generic", "type": null, "when": "The Charity Commission flags generic or AI-generated text" }, { "code": "application_inactive_deleted", "type": null, "when": "OSCR deletes the application after 3 months without activity, or the Commission's saved draft expires after 3 months" }, { "code": "charity_test_not_met", "type": null, "when": "OSCR decides the charity test is not met" }, { "code": "registry_rejected", "type": null, "when": "The regulator rejects the application; reasons come back in requirement and the trustees may reapply, seek a review or appeal" } ] } }, "Params_uk_charity_interest_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "northern_ireland" ], "description": "Only Northern Ireland.", "examples": [ "northern_ireland" ] }, "charitable_purposes": { "type": "array", "items": {}, "description": "The charitable purposes the organisation will pursue, in the organisation's own words, mapped to one or more of CCNI's 12 charitable purposes.", "examples": [ "[\"relief of poverty\",\"advancement of education\"]" ] }, "public_benefit_statement": { "type": "string", "description": "How the purposes are for the public benefit.", "examples": [ "Free meals and advice open to all in need in Belfast." ] }, "governed_by_ni_law": { "type": "boolean", "description": "Eligibility: the organisation is governed by the law of Northern Ireland.", "examples": [ "true" ] }, "exclusively_charitable": { "type": "boolean", "description": "Eligibility: the organisation has exclusively charitable purposes.", "examples": [ "true" ] }, "controls_governance_and_resources": { "type": "boolean", "description": "Eligibility: the organisation is an institution with control and direction over its governance and resources.", "examples": [ "true" ] }, "contact_person": { "type": "string", "pattern": "^per_", "description": "The person CCNI will contact with the password when it invites the organisation to apply.", "examples": [ "per_4Ln8Bx2Vc6" ] }, "trustees": { "type": "array", "items": {}, "description": "Person ids of trustees, so Entiva can pre-verify them while registration is paused.", "examples": [ "[\"per_4Ln8Bx2Vc6\",\"per_9Fd1Tr5Qs3\"]" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registration_jurisdiction", "charitable_purposes", "public_benefit_statement", "governed_by_ni_law", "exclusively_charitable", "controls_governance_and_resources", "contact_person", "name", "nature_of_business", "countries_of_operation", "directors", "beneficial_owners" ], "description": "Northern Ireland charity registration is currently paused. This action submits the Charity Commission for Northern Ireland's online expression of intent for a charitable company, then waits for CCNI to invite the organisation to apply." }, "Create_uk_charity_interest_register": { "type": "object", "properties": { "type": { "const": "uk.charity_interest.register" }, "params": { "$ref": "#/components/schemas/Params_uk_charity_interest_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit an expression of intent to register a charity in Northern Ireland", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "expression_of_intent", "title": "Expression of intent answers", "source": "generated", "required": true }, { "key": "expression_of_intent_receipt", "title": "Submission receipt", "source": "generated", "required": true }, { "key": "ccni_invitation", "title": "CCNI invitation and password to apply", "source": "registry_issued", "required": false }, { "key": "governing_document", "title": "Governing document", "source": "uploaded", "required": false }, { "key": "trustee_declaration", "title": "CCNI trustee declaration form", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "expression_of_intent", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "expression_of_intent_receipt", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for Northern Ireland", "form": "Online Expression of intent form", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a charitable company" }, { "code": "not_governed_by_ni_law", "type": null, "when": "governed_by_ni_law is false" }, { "code": "not_exclusively_charitable", "type": null, "when": "exclusively_charitable is false" }, { "code": "expression_of_intent_already_submitted", "type": null, "when": "An expression of intent is already recorded for this entity" }, { "code": "ccni_registration_paused", "type": null, "when": "The follow-on application is requested before CCNI has invited the organisation; Entiva waits" }, { "code": "registry_rejected", "type": null, "when": "CCNI declines the expression of intent" } ] } }, "Params_uk_charity_tax_recognition_apply": { "type": "object", "properties": { "regulator": { "type": "string", "enum": [ "charity_commission", "oscr", "ccni", "none" ], "description": "The regulator the charity is registered with. none is allowed only for a charity that is not required to register.", "examples": [ "charity_commission" ] }, "regulator_registration_number": { "type": "string", "description": "Charity number from the regulator.", "examples": [ "1212345" ] }, "charitable_objectives": { "type": "string", "description": "The charity's objectives.", "examples": [ "To relieve poverty and advance education in Cardiff." ] }, "governing_document": { "type": "string", "pattern": "^doc_", "description": "The governing document." }, "latest_accounts": { "type": "string", "pattern": "^doc_", "description": "Financial accounts." }, "no_accounts_yet": { "type": "boolean", "description": "True if the charity has not yet produced accounts.", "examples": [ "true" ] }, "bank_account": { "type": "object", "description": "Shape: {account_name, sort_code, account_number}.", "examples": [ "{\"account_name\":\"Brightwater Trust\"}" ] }, "officials": { "type": "array", "items": {}, "description": "The charity's officials.", "examples": [ "[{\"person_id\":\"per_1Qe5Rs8Zb3\"}]" ] }, "managers_fit_and_proper_confirmed": { "type": "boolean", "description": "The officials confirm the managers are fit and proper persons.", "examples": [ "true" ] }, "intends_to_claim_gift_aid": { "type": "boolean", "description": "Whether the charity will claim Gift Aid once recognised.", "examples": [ "true" ] } }, "required": [ "regulator", "charitable_objectives", "governing_document", "bank_account", "officials", "managers_fit_and_proper_confirmed" ], "description": "Applies to HMRC for the charity to be recognised for tax reliefs such as Gift Aid. Done after the charity is registered with its regulator, using the HMRC online charity registration service." }, "Create_uk_charity_tax_recognition_apply": { "type": "object", "properties": { "type": { "const": "uk.charity_tax_recognition.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_charity_tax_recognition_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charity with HMRC for charity tax reliefs and Gift Aid", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "charitable_company", "cio", "scio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "governing_document", "title": "Governing document", "source": "uploaded", "required": true }, { "key": "latest_accounts", "title": "Latest accounts", "source": "uploaded", "required": false }, { "key": "regulator_registration_evidence", "title": "Charity number evidence from the regulator", "source": "uploaded", "required": false }, { "key": "trustee_resolution", "title": "Trustees' resolution authorising the HMRC application", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "HMRC agent authorisation", "source": "generated", "required": false }, { "key": "hmrc_recognition_notice", "title": "HMRC notice of charity recognition", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustee_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "hmrc_recognition_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "hmrc_agent_authorisation", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "HMRC online charity registration for tax relief", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a charitable company, CIO or SCIO" }, { "code": "regulator_registration_required", "type": null, "when": "The charity must be on a regulator's register but regulator_registration_number is missing or the regulator action has not completed" }, { "code": "management_condition_unconfirmed", "type": null, "when": "managers_fit_and_proper_confirmed is false" }, { "code": "official_details_incomplete", "type": null, "when": "An official's date of birth or National Insurance number is missing" }, { "code": "hmrc_recognition_already_exists", "type": null, "when": "The charity is already recognised by HMRC; use ChV1 changes instead" }, { "code": "hmrc_registration_rejected", "type": null, "when": "HMRC rejects or queries the application" } ] } }, "Params_uk_cic_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cic" ], "description": "Always cic." }, "cic_form": { "type": "string", "enum": [ "private_shares", "private_guarantee", "public_shares" ], "description": "A CIC is limited by guarantee or by shares; public_shares is a community interest PLC." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK of the registered office; decides the registrar office." }, "welsh_company": { "type": "boolean", "description": "england_wales only: office situated in Wales; Welsh endings allowed; stays in Wales unless changed back on AD05." }, "name": { "type": "string", "description": "Ending 'community interest company' or 'CIC'; a community interest PLC ends 'community interest public limited company' or 'community interest plc'." }, "name_check_action_id": { "type": "string", "description": "act_ id of a completed uk.company_name.check.", "examples": [ "act_1Qz8e2LkUvBn" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Default: Entiva's address in the same part of the UK." }, "registered_email": { "type": "string", "description": "Registered email, not public.", "examples": [ "registered@northgate-robotics.example" ] }, "sic_codes": { "type": "array", "items": {}, "description": "One to four 5-digit SIC 2007 codes for the intended principal business activities (CA 2006 s9-)." }, "lawful_purpose_confirmed": { "type": "boolean", "description": "Must be true." }, "community_interest_statement": { "type": "object", "description": "CIC36 Sections A-D answers: community, activities, benefit, stakeholder involvement." }, "subscribers": { "type": "array", "items": {}, "description": "Items: {person_id | entity_id, shares: [{class, number}]}." }, "directors": { "type": "array", "items": {}, "description": "Items: {person_id | entity_id}." }, "secretary": { "type": "string", "pattern": "^per_", "description": "First secretary." }, "share_capital": { "type": "object", "description": "Required for private_shares and public_shares; same shape as uk.company.incorporate." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required for private_guarantee: amount each member undertakes to contribute on winding up." }, "articles": { "type": "object", "description": "{mode: cic_model | bespoke, document_id}." }, "significant_control": { "type": "object", "description": "Same shape as uk.company.incorporate." }, "no_disqualified_persons_confirmed": { "type": "boolean", "description": "Must be true." }, "disqualification_exceptions": { "type": "array", "items": {}, "description": "Only if disqualified but for court permission or a sanctions licence: {person_id, kind, court_or_issuer, date} (s12-)." }, "follow_on_actions": { "type": "array", "items": {}, "description": "Created automatically once registered." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "cic_form", "registration_jurisdiction", "name", "sic_codes", "lawful_purpose_confirmed", "community_interest_statement", "subscribers", "directors", "articles", "significant_control", "no_disqualified_persons_confirmed", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Registers a new CIC. Entiva files the normal incorporation package plus the CIC36 application with the community interest statement and CIC articles, and the CIC Regulator reviews the community interest test as part of the application." }, "Create_uk_cic_incorporate": { "type": "object", "properties": { "type": { "const": "uk.cic.incorporate" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a UK community interest company", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "cic36", "title": "CIC36 application to form a community interest company", "source": "generated", "required": true }, { "key": "cic_articles_of_association", "title": "CIC articles of association", "source": "generated", "required": true }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "statement_of_proposed_officers", "title": "Statement of proposed officers with consent to act and identity-verification confirmation", "source": "generated", "required": true }, { "key": "statement_of_initial_significant_control", "title": "Statement of initial significant control", "source": "generated", "required": true }, { "key": "statement_of_compliance", "title": "Statement of compliance", "source": "generated", "required": true }, { "key": "corporate_party_pack", "title": "Corporate party pack", "source": "uploaded", "required": false }, { "key": "registered_office_evidence", "title": "Evidence for a customer-supplied registered office", "source": "uploaded", "required": false }, { "key": "plc_secretary_qualification_evidence", "title": "Evidence of the secretary's qualification", "source": "uploaded", "required": false }, { "key": "source_of_wealth_evidence", "title": "Source of funds and source of wealth evidence", "source": "uploaded", "required": false }, { "key": "engagement_terms", "title": "Engagement terms and mandate", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "lawful_purpose_and_eligibility_statements", "title": "Lawful-purpose and no-disqualification statements with click-consent record", "source": "generated", "required": true }, { "key": "director_identity_verification", "title": "Companies House identity verification record for each director", "source": "registry_issued", "required": true }, { "key": "personal_codes", "title": "Personal codes of directors and initial PSCs, held in the KYC vault and never returned by the API", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "incorporator", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "nominee_director", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_compliance", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "cic36", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_of_proposed_officers", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lawful_purpose_and_eligibility_statements", "signer_role": "incorporator", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_identity_verification", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "personal_codes", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "statement_of_initial_significant_control", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cic_articles_of_association", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House, with approval", "form": "IN01 incorporation package", "channel": "online", "government_fee": { "amount": 115, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_not_available", "type": null, "when": "Wrong ending, 'same as' name or sensitive word without permission; run uk.company_name.check." }, { "code": "director_not_verified", "type": null, "when": "A director has no Companies House personal code; the appointment cannot be registered." }, { "code": "no_natural_person_director", "type": null, "when": "No director is a natural person aged 16 or over." }, { "code": "cic_ineligible_applicant", "type": null, "when": "The applicant is a political party, a political campaigning organisation or a subsidiary of either." }, { "code": "cic_articles_missing_statutory_clauses", "type": null, "when": "The CIC articles omit a statutory clause or CIC36 omits Sections A to D." }, { "code": "community_interest_test_failed", "type": null, "when": "The Regulator is not satisfied that a reasonable person might consider the activities for the benefit of the community." }, { "code": "cic_plc_secretary_required", "type": null, "when": "cic_form is public_shares with no qualified secretary." }, { "code": "registered_office_not_appropriate", "type": null, "when": "Customer registered office fails the s86 test or is outside registration_jurisdiction." }, { "code": "subscriber_authentication_missing", "type": null, "when": "A subscriber has not authenticated, or the code is invalid." }, { "code": "statements_not_confirmed", "type": null, "when": "A required statement is false or its click-consent record is missing." }, { "code": "welsh_option_not_available", "type": null, "when": "Welsh option set outside england_wales." }, { "code": "screening_rejected", "type": null, "when": "Compliance review or a confirmed UK Sanctions List match ends the action; no detail is given." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_cio_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "description": "The Charity Commission registers CIOs for England and Wales only.", "examples": [ "england_wales" ] }, "name": { "type": "string", "description": "Proposed name.", "examples": [ "Brightwater Youth CIO" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal office, in England or Wales." }, "constitution_language": { "type": "string", "enum": [ "english", "welsh" ], "description": "English if the principal office is in England.", "examples": [ "english" ] }, "constitution_model": { "type": "string", "enum": [ "association", "foundation", "bespoke" ], "description": "association: a CIO with voting members other than its trustees. foundation: a CIO whose only voting members are its trustees. bespoke: own or amended.", "examples": [ "foundation" ] }, "constitution_document": { "type": "string", "pattern": "^doc_", "description": "Required for bespoke or amended constitutions." }, "charitable_purposes": { "type": "string", "description": "The purposes, which must be exclusively charitable.", "examples": [ "To advance education and relieve unemployment among young people in Bristol." ] }, "public_benefit_statement": { "type": "string", "description": "How the purposes are for the public benefit.", "examples": [ "We run free training courses open to all young people aged 16 to 25 in the Bristol area." ] }, "activities_description": { "type": "string", "description": "How the CIO will carry out its purposes.", "examples": [ "Weekly workshops, work placements and mentoring." ] }, "applicants": { "type": "array", "items": {}, "description": "Person ids of the one or more applicants.", "examples": [ "[\"per_6Yt1Cd8Hj4\",\"per_2Wq5Mn3Rv9\",\"per_8Bk7Ps2Lx6\"]" ] }, "trustees": { "type": "array", "items": {}, "description": "Person ids of the charity trustees.", "examples": [ "[\"per_6Yt1Cd8Hj4\",\"per_2Wq5Mn3Rv9\",\"per_8Bk7Ps2Lx6\"]" ] }, "trustee_personal_benefit": { "type": "object", "description": "Shape: {any_benefit, details}.", "examples": [ "{\"any_benefit\":false}" ] }, "works_with_vulnerable_groups": { "type": "boolean", "description": "If true, the trustees confirm they have read the Commission's safeguarding guidance and sign a declaration that all legally required checks were done.", "examples": [ "true" ] }, "bank_account": { "type": "object", "description": "Main bank or building society details.", "examples": [ "{\"account_name\":\"Brightwater Youth CIO\"}" ] }, "public_contact": { "type": "object", "description": "Shape: {postal_address, email, phone, website}.", "examples": [ "{\"email\":\"hello@brightwater.example\"}" ] }, "latest_accounts": { "type": "string", "pattern": "^doc_", "description": "Most recent accounts, if any." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registration_jurisdiction", "name", "principal_office", "constitution_model", "charitable_purposes", "public_benefit_statement", "activities_description", "applicants", "trustees", "trustee_personal_benefit", "works_with_vulnerable_groups", "bank_account", "public_contact", "nature_of_business", "countries_of_operation", "directors", "beneficial_owners" ], "description": "Creates a CIO by applying to the Charity Commission for England and Wales under Charities Act 2011 s207. The CIO becomes a body corporate when it is entered on the register of charities, and not before." }, "Create_uk_cio_register": { "type": "object", "properties": { "type": { "const": "uk.cio.register" }, "params": { "$ref": "#/components/schemas/Params_uk_cio_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charitable incorporated organisation with the Charity Commission", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "cio" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "constitution", "title": "CIO constitution", "source": "generated", "required": true }, { "key": "trustee_declaration", "title": "Signed trustee declaration, one per trustee", "source": "uploaded", "required": true }, { "key": "safeguarding_declaration", "title": "Trustees' declaration on checks for work with vulnerable groups", "source": "uploaded", "required": false }, { "key": "application_summary", "title": "Application for the applicants' review", "source": "generated", "required": true }, { "key": "charity_registration_notice", "title": "Commission email with the registered charity number", "source": "registry_issued", "required": true }, { "key": "register_entry_copy", "title": "Copy of the register entry sent to the principal office", "source": "registry_issued", "required": false } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "constitution", "signer_role": "applicant", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "trustee_declaration", "signer_role": "trustee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "application_summary", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "Online CIO registration application", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "registration_jurisdiction_not_supported", "type": null, "when": "registration_jurisdiction is scotland or northern_ireland" }, { "code": "name_too_like_existing_charity", "type": null, "when": "The name is the same as, or too like, another charity's name or working name" }, { "code": "name_requires_companies_house_approval", "type": null, "when": "The name would need Companies House approval, which the Commission does not allow for a new CIO" }, { "code": "constitution_non_compliant", "type": null, "when": "The constitution does not meet s206 or the CIO regulations" }, { "code": "charity_test_not_met", "type": null, "when": "The Commission is not satisfied the CIO would be a charity when registered" }, { "code": "trustee_declaration_missing", "type": null, "when": "A signed trustee declaration scan has not been uploaded for every trustee" }, { "code": "trustee_ineligible", "type": null, "when": "The Commission's eligibility checks find a named trustee ineligible" }, { "code": "public_benefit_text_generic", "type": null, "when": "The Commission flags generic or AI-generated purposes or public benefit text" }, { "code": "draft_expired", "type": null, "when": "The Commission's saved application is not completed within 3 months of starting it" }, { "code": "application_returned_incomplete", "type": null, "when": "The Commission returns the application for resubmission" }, { "code": "registry_rejected", "type": null, "when": "The Commission refuses the application; reasons are returned in requirement and the applicants may reapply, request a review or appeal to the Charity Tribunal" } ] } }, "Params_uk_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc" ], "description": "Company type. private_unlimited may or may not have share capital." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK of the registered office; decides the registrar office." }, "welsh_company": { "type": "boolean", "description": "england_wales only: office situated in Wales; Welsh endings allowed; stays in Wales unless changed back on AD05." }, "name": { "type": "string", "description": "Full name with ending: 'Limited' or 'Ltd', 'public limited company' or 'plc', no 'limited' for unlimited; Welsh endings only for a Welsh company." }, "name_check_action_id": { "type": "string", "description": "act_ id of a completed uk.company_name.check.", "examples": [ "act_1Qz8e2LkUvBn" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Default: Entiva's address in the same part of the UK." }, "registered_email": { "type": "string", "description": "Registered email, not public.", "examples": [ "registered@northgate-robotics.example" ] }, "sic_codes": { "type": "array", "items": {}, "description": "One to four 5-digit SIC 2007 codes for the intended principal business activities (CA 2006 s9-)." }, "lawful_purpose_confirmed": { "type": "boolean", "description": "Must be true." }, "subscribers": { "type": "array", "items": {}, "description": "Items: {person_id | entity_id, shares: [{class, number}]}." }, "directors": { "type": "array", "items": {}, "description": "Items: {person_id | entity_id}." }, "secretary": { "type": "string", "pattern": "^per_", "description": "First secretary." }, "secretary_qualification": { "type": "string", "enum": [ "professional_body_member", "barrister_advocate_or_solicitor", "three_of_last_five_years_plc_secretary", "other_capability_judged_by_directors" ], "description": "PLC only: basis of the s273 qualification; attach the evidence." }, "share_capital": { "type": "object", "description": "Statement of capital; required for private_ltd_shares, plc and share-capital unlimited. {currency, classes: [{name, nominal_value, rights: {voting, dividend." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required for private_ltd_guarantee." }, "unlimited_has_share_capital": { "type": "boolean", "description": "private_unlimited only." }, "articles": { "type": "object", "description": "{mode: model | bespoke, document_id}." }, "significant_control": { "type": "object", "description": "Initial significant control: {no_registrable_person: true} or {registrable_persons: [{person_id, natures_of_control[], knows_particulars_included: true}]." }, "no_disqualified_persons_confirmed": { "type": "boolean", "description": "Must be true." }, "disqualification_exceptions": { "type": "array", "items": {}, "description": "Only if disqualified but for court permission or a sanctions licence: {person_id, kind, court_or_issuer, date} (s12-)." }, "speed": { "type": "string", "enum": [ "standard", "same_day" ], "description": "standard or same_day." }, "follow_on_actions": { "type": "array", "items": {}, "description": "Created automatically once registered." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "registration_jurisdiction", "name", "sic_codes", "lawful_purpose_confirmed", "subscribers", "directors", "articles", "significant_control", "no_disqualified_persons_confirmed", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Registers a new company at Companies House by software filing as incorporation agent. Entiva builds the memorandum, articles, statement of capital or guarantee, proposed officers, initial significant control, compliance and." }, "Create_uk_company_incorporate": { "type": "object", "properties": { "type": { "const": "uk.company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_uk_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a UK private limited, guarantee, unlimited or public company", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": false }, { "key": "statement_of_capital", "title": "Statement of capital and initial shareholdings", "source": "generated", "required": false }, { "key": "statement_of_guarantee", "title": "Statement of guarantee", "source": "generated", "required": false }, { "key": "statement_of_proposed_officers", "title": "Statement of proposed officers with consent to act and identity-verification confirmation", "source": "generated", "required": true }, { "key": "statement_of_initial_significant_control", "title": "Statement of initial significant control", "source": "generated", "required": true }, { "key": "statement_of_compliance", "title": "Statement of compliance", "source": "generated", "required": true }, { "key": "corporate_party_pack", "title": "Corporate party pack", "source": "uploaded", "required": false }, { "key": "registered_office_evidence", "title": "Evidence for a customer-supplied registered office", "source": "uploaded", "required": false }, { "key": "plc_secretary_qualification_evidence", "title": "Evidence of the PLC secretary's qualification", "source": "uploaded", "required": false }, { "key": "source_of_wealth_evidence", "title": "Source of funds and source of wealth evidence", "source": "uploaded", "required": false }, { "key": "engagement_terms", "title": "Engagement terms and mandate", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "lawful_purpose_and_eligibility_statements", "title": "Lawful-purpose and no-disqualification statements with click-consent record", "source": "generated", "required": true }, { "key": "director_identity_verification", "title": "Companies House identity verification record for each director", "source": "registry_issued", "required": true }, { "key": "personal_codes", "title": "Personal codes of directors and initial PSCs, held in the KYC vault and never returned by the API", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "incorporator", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "nominee_director", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_compliance", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "statement_of_proposed_officers", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lawful_purpose_and_eligibility_statements", "signer_role": "incorporator", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_identity_verification", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "personal_codes", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "statement_of_initial_significant_control", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "IN01 incorporation package", "channel": "online", "government_fee": { "amount": 100, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_not_available", "type": null, "when": "Wrong ending, 'same as' name or sensitive word without permission; run uk.company_name.check." }, { "code": "director_not_verified", "type": null, "when": "A director has no Companies House personal code; the appointment cannot be registered." }, { "code": "no_natural_person_director", "type": null, "when": "No director is a natural person aged 16 or over." }, { "code": "plc_minimum_directors", "type": null, "when": "entity_type is plc with fewer than two directors." }, { "code": "plc_secretary_required", "type": null, "when": "entity_type is plc with no secretary." }, { "code": "plc_secretary_not_qualified", "type": null, "when": "The PLC secretary has no s273 qualification or no evidence of it." }, { "code": "share_payment_below_minimum", "type": null, "when": "A PLC share is paid up less than one-quarter of nominal value plus the whole premium." }, { "code": "bespoke_articles_required", "type": null, "when": "entity_type is private_unlimited and articles.mode is model." }, { "code": "registered_office_not_appropriate", "type": null, "when": "Customer registered office fails the s86 test or is outside registration_jurisdiction." }, { "code": "subscriber_authentication_missing", "type": null, "when": "A subscriber has not authenticated, or the code is invalid." }, { "code": "statements_not_confirmed", "type": null, "when": "A required statement is false or its click-consent record is missing." }, { "code": "person_disqualified", "type": null, "when": "Screening finds a proposed officer or PSC disqualified with no permission supplied." }, { "code": "welsh_option_not_available", "type": null, "when": "Welsh option set outside england_wales." }, { "code": "screening_rejected", "type": null, "when": "Compliance review or a confirmed UK Sanctions List match ends the action; no detail is given." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_company_name_check": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp" ], "description": "Fixes the required ending. lp is England, Wales and Northern Ireland only; slp is Scotland only." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK of the registered office; decides the registrar office." }, "name": { "type": "string", "description": "The full name including its ending, exactly as it would be registered." }, "welsh_company": { "type": "boolean", "description": "england_wales only: office situated in Wales; Welsh endings allowed; stays in Wales unless changed back on AD05." }, "cic_form": { "type": "string", "enum": [ "private", "public" ], "description": "cic only: a private CIC or a community interest public limited company." }, "group_company_number": { "type": "string", "description": "Existing company or LLP in the same group; a 'same as' name is allowed only within a group or with written no-objection.", "examples": [ "09876543" ] }, "same_as_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the written no-objection from the holder of a 'same as' name." }, "sensitive_word_permission_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the permission letter for a sensitive word or government-connection name." } }, "required": [ "entity_type", "registration_jurisdiction", "name" ], "description": "Free check of a proposed name against the Companies House register and the name rules, before formation. The UK has no name reservation, so a clear result is a snapshot: a name is held only by registering it." }, "Create_uk_company_name_check": { "type": "object", "properties": { "type": { "const": "uk.company_name.check" }, "params": { "$ref": "#/components/schemas/Params_uk_company_name_check" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Check a UK company, LLP or partnership name", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_check_report", "title": "Name check report", "source": "generated", "required": true }, { "key": "same_as_consent", "title": "Written no-objection from the holder of a 'same as' name", "source": "uploaded", "required": false }, { "key": "sensitive_word_permission", "title": "Permission to use a sensitive word", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "name_check_report", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "None", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "invalid_entity_for_jurisdiction", "type": null, "when": "entity_type lp is used with scotland, or slp with england_wales or northern_ireland." }, { "code": "welsh_option_not_available", "type": null, "when": "Welsh option set outside england_wales." }, { "code": "name_check_unavailable", "type": null, "when": "Retry with the same Idempotency-Key." } ] } }, "Params_uk_corporation_tax_register": { "type": "object", "properties": { "activity_status": { "type": "string", "enum": [ "active", "not_yet_active" ], "description": "active, or not_yet_active." }, "first_activity_date": { "type": "string", "format": "date", "description": "Required if active: start of the first accounting period." }, "accounts_made_up_to": { "type": "string", "description": "Month and day the accounts are made up to." }, "business_activity_description": { "type": "string", "description": "Plain-language description of the main activity." }, "sic_codes": { "type": "array", "items": {}, "description": "SIC 2007 codes." }, "utr": { "type": "string", "description": "10-digit UTR if HMRC already issued one; then this action only adds the service and records it.", "examples": [ "1234567890" ] }, "registration_route": { "type": "string", "enum": [ "hmrc_online", "written_declaration" ], "description": "hmrc_online or written_declaration." }, "agent_authorisation_method": { "type": "string", "enum": [ "online_agent_authorisation", "form_64_8" ], "description": "online_agent_authorisation or form_64_8." }, "late_registration_acknowledged": { "type": "boolean", "description": "Must be true if first_activity_date is over 3 months ago." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "activity_status", "name", "nature_of_business", "countries_of_operation", "directors", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Tells HMRC that a company, CIC or UK establishment has become active and is within the charge to Corporation Tax, so that HMRC issues the Unique Taxpayer Reference. Entiva prepares the registration, obtains the company's authorisation." }, "Create_uk_corporation_tax_register": { "type": "object", "properties": { "type": { "const": "uk.corporation_tax.register" }, "params": { "$ref": "#/components/schemas/Params_uk_corporation_tax_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a company for Corporation Tax and obtain its UTR", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "ct_registration_summary", "title": "Corporation Tax registration details for approval", "source": "generated", "required": true }, { "key": "ct_registration_letter", "title": "Signed letter of registration", "source": "generated", "required": false }, { "key": "hmrc_agent_authorisation", "title": "HMRC confirmation that Entiva is authorised for Corporation Tax", "source": "registry_issued", "required": true }, { "key": "hmrc_registration_confirmation", "title": "HMRC acknowledgement with the UTR", "source": "registry_issued", "required": true }, { "key": "utr_letter", "title": "HMRC letter carrying the UTR, if it reaches the company by post", "source": "uploaded", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "hmrc_agent_authorisation", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ct_registration_summary", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "ct_registration_letter", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "HM Revenue and Customs", "form": "Corporation Tax registration", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_incorporated", "type": null, "when": "The entity has no company or registration number yet." }, { "code": "first_activity_date_missing", "type": null, "when": "activity_status is active and first_activity_date is missing." }, { "code": "late_registration_acknowledgement_required", "type": null, "when": "More than 3 months have passed since first_activity_date and late_registration_acknowledged is not true." }, { "code": "utr_invalid_format", "type": null, "when": "utr is not 10 digits." }, { "code": "already_registered_for_corporation_tax", "type": null, "when": "HMRC already holds a Corporation Tax registration for the entity." }, { "code": "agent_authorisation_pending", "type": null, "when": "HMRC has not yet confirmed Entiva's authorisation." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_existing_body_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the registered office will be.", "examples": [ "england_wales" ] }, "registered_office_situation": { "type": "string", "enum": [ "england_and_wales", "wales", "scotland", "northern_ireland" ], "description": "Whether the registered office is stated to be in England and Wales, in Wales, Scotland or Northern Ireland.", "examples": [ "england_and_wales" ] }, "target_entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc" ], "description": "The class of company to register as.", "examples": [ "private_ltd_shares" ] }, "existing_body": { "type": "object", "description": "The body being registered.", "examples": [ "{\"name\":\"Dunmore Pier Company\",\"basis\":\"formed_under_other_act\",\"is_joint_stock_company\":true}" ] }, "name": { "type": "string", "description": "The company name on registration, with the correct limited, unlimited or public ending.", "examples": [ "Dunmore Pier Company Limited" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Intended registered office address." }, "members_assent": { "type": "object", "description": "Assent of members at a general meeting called for the purpose.", "examples": [ "{\"meeting_date\":\"2026-10-09\",\"members_present\":120,\"votes_for\":108,\"votes_against\":12,\"percent_assenting\":90}" ] }, "statement_of_capital": { "type": "object", "description": "Required for a joint stock company." }, "statement_of_guarantee": { "type": "object", "description": "Required for a company limited by guarantee." }, "proposed_officers": { "type": "object", "description": "Statement of proposed officers.", "examples": [ "{\"directors\":[{\"person_id\":\"per_3Lm9Qf4Ws2\"}]}" ] }, "articles": { "type": "object", "description": "Shape: {mode: model | bespoke, document_id}.", "examples": [ "{\"mode\":\"bespoke\",\"document_id\":\"doc_9Bt4Vk1Nx7\"}" ] }, "public_company_requirements": { "type": "object", "description": "Required when target_entity_type is plc." }, "pscs": { "type": "array", "items": {}, "description": "People with significant control.", "examples": [ "[]" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registration_jurisdiction", "registered_office_situation", "target_entity_type", "existing_body", "name", "registered_office", "members_assent", "proposed_officers", "articles", "nature_of_business", "countries_of_operation", "directors", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Re-registers a joint stock company or a company formed by another Act, letters patent or other lawful constitution as a Companies Act 2006 company, as unlimited, limited by shares or limited by guarantee, with a members' assent and." }, "Create_uk_existing_body_register": { "type": "object", "properties": { "type": { "const": "uk.existing_body.register" }, "params": { "$ref": "#/components/schemas/Params_uk_existing_body_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an existing body as a company under the Companies Act 2006", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "constituting_instrument", "title": "Copy of the Act, charter, deed, contract or other instrument that constitutes or governs the body", "source": "uploaded", "required": true }, { "key": "members_assent_resolution", "title": "Members' assent", "source": "uploaded", "required": true }, { "key": "articles", "title": "Articles of association", "source": "generated", "required": true }, { "key": "s1040_application", "title": "Application for registration with name, registered office part of the UK, liability, and private or.", "source": "generated", "required": true }, { "key": "statement_of_capital_and_initial_shareholdings", "title": "Statement of capital and initial shareholdings", "source": "generated", "required": false }, { "key": "statement_of_guarantee", "title": "Statement of guarantee", "source": "generated", "required": false }, { "key": "statement_of_proposed_officers", "title": "Statement of proposed officers with company statement of consent to act", "source": "generated", "required": true }, { "key": "statement_of_registered_office", "title": "Statement of intended registered office address", "source": "generated", "required": true }, { "key": "statement_of_compliance", "title": "Statement of compliance", "source": "generated", "required": true }, { "key": "public_company_resolution_and_balance_sheet", "title": "Resolution to be a public company, balance sheet and any valuation report", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_assent_resolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_proposed_officers", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_of_compliance", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s1040_application", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Application to register under s1040 and the Companies", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "body_not_authorised_to_register", "type": null, "when": "The body is not within s1040: not in existence on 2 Nov 1862 and not formed under another Act, letters patent or otherwise duly constituted" }, { "code": "risk_transformation_company_excluded", "type": null, "when": "The body is registered under Part 4 of the Risk Transformation Regulations 2017" }, { "code": "not_joint_stock_cannot_be_limited_by_shares", "type": null, "when": "target_entity_type is private_ltd_shares or plc and the body is not a joint stock company" }, { "code": "liability_limited_by_enactment_requires_joint_stock", "type": null, "when": "Liability is limited by Act or letters patent and the body is not a joint stock company, or it tries to register as unlimited or guarantee" }, { "code": "members_assent_insufficient", "type": null, "when": "The members' assent does not reach a majority of those present, or 75% where required" }, { "code": "statement_of_capital_stale", "type": null, "when": "The reference date is more than 28 days before the application" }, { "code": "public_company_tests_failed", "type": null, "when": "The s91 share capital or s92 net assets test is not met for a plc" }, { "code": "director_not_verified", "type": null, "when": "A proposed director has no verified identity or unique identifier (reg 7)" }, { "code": "director_disqualified", "type": null, "when": "A proposed director is disqualified or ineligible and no court permission or licence is recorded" }, { "code": "name_unavailable", "type": null, "when": "The proposed name is unavailable or breaches company name rules" }, { "code": "registration_jurisdiction_not_supported", "type": null, "when": "registered_office_situation does not match registration_jurisdiction" }, { "code": "registry_rejected", "type": null, "when": "Companies House rejects the application" } ] } }, "Params_uk_general_partnership_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Law governing the partnership agreement and the main place of business.", "examples": [ "england_wales" ] }, "partnership_name": { "type": "string", "description": "Trading name of the partnership.", "examples": [ "Marlow & Reed Design" ] }, "business_description": { "type": "string", "description": "What the partnership does.", "examples": [ "Interior design studio" ] }, "business_start_date": { "type": "string", "format": "date", "description": "Date the business started trading.", "examples": [ "2026-11-01" ] }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Main place of business." }, "partners": { "type": "array", "items": {}, "description": "At least two partners.", "examples": [ "[{\"person_id\":\"per_8Ka3Dt6Mv1\",\"profit_share_percent\":50,\"nominated_partner\":true},{\"person_id\":\"per_2Zp9Wc4Xr7\",\"profit_share_percent\":50}]" ] }, "agreement_mode": { "type": "string", "enum": [ "generate", "upload", "none" ], "description": "generate: Entiva drafts the agreement. upload: the customer supplies it. none: no written agreement.", "examples": [ "generate" ] }, "agreement_execution": { "type": "string", "enum": [ "under_hand", "deed" ], "description": "under_hand or deed.", "examples": [ "under_hand" ] }, "accounting_year_end": { "type": "string", "description": "Month and day of the accounting date, for example 04-05.", "examples": [ "04-05" ] }, "expected_taxable_turnover": { "$ref": "#/components/schemas/Money", "description": "Expected VAT taxable turnover for the first 12 months.", "examples": [ "{\"amount\":60000,\"currency\":\"GBP\"}" ] }, "authorise_entiva_as_agent": { "type": "boolean", "description": "Ask the nominated partner to authorise Entiva as HMRC tax agent for the partnership.", "examples": [ "true" ] } }, "required": [ "registration_jurisdiction", "partnership_name", "business_description", "business_start_date", "principal_place_of_business", "partners", "agreement_mode" ], "description": "Sets up an ordinary partnership with a partnership agreement and registers it, through its nominated partner, with HMRC for Self Assessment. Each partner also registers separately." }, "Create_uk_general_partnership_register": { "type": "object", "properties": { "type": { "const": "uk.general_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_uk_general_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up a general partnership and register it with HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": false }, { "key": "corporate_partner_documents", "title": "Corporate partner KYB pack", "source": "uploaded", "required": false }, { "key": "hmrc_agent_authorisation", "title": "HMRC agent authorisation", "source": "generated", "required": false }, { "key": "sa400_submission_receipt", "title": "HMRC partnership registration receipt", "source": "registry_issued", "required": true }, { "key": "partnership_utr_letter", "title": "HMRC letter with the partnership Unique Taxpayer Reference", "source": "registry_issued", "required": true }, { "key": "partner_registration_confirmations", "title": "Each partner's own Self Assessment registration confirmation", "source": "uploaded", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "partner", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "sa400_submission_receipt", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "partner_registration_confirmations", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "Online 'Register a partner or partnership for Self Assessment'", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "partner_count_below_two", "type": null, "when": "Fewer than two partners are supplied" }, { "code": "nominated_partner_required", "type": null, "when": "Not exactly one partner is flagged as the nominated partner" }, { "code": "profit_shares_invalid", "type": null, "when": "profit_share_percent values do not total 100" }, { "code": "partnership_name_needs_review", "type": null, "when": "The name contains restricted words or a company or LLP ending, or looks misleading; compliance review is required" }, { "code": "qualifying_partnership_registration_required", "type": null, "when": "registration_jurisdiction is scotland and every partner is a limited company, so the partnership is a qualifying partnership that must also register under." }, { "code": "registration_deadline_passed", "type": null, "when": "The computed 5 October deadline has passed, so a late-registration penalty may apply" }, { "code": "corporate_partner_owners_unresolved", "type": null, "when": "The individuals who own or control a corporate partner cannot be identified" }, { "code": "partner_verification_incomplete", "type": null, "when": "A partner has not completed identity_address verification" }, { "code": "hmrc_registration_rejected", "type": null, "when": "HMRC rejects or queries the registration" } ] } }, "Params_uk_limited_partnership_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "slp" ], "description": "lp for England, Wales and Northern Ireland; slp for Scotland, where every LP has legal personality and is an eligible Scottish partnership." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK of the registered office; decides the registrar office." }, "firm_name": { "type": "string", "description": "Must end 'limited partnership' or 'LP' in any capitalisation, with or without punctuation; Welsh 'partneriaeth cyfyngedig' or 'PC' where the principal place of." }, "name_check_action_id": { "type": "string", "description": "act_ id of a completed uk.company_name.check.", "examples": [ "act_1Qz8e2LkUvBn" ] }, "nature_of_business": { "type": "string", "description": "General nature of the intended business (LPA 1907 s8A)." }, "sic_codes": { "type": "array", "items": {}, "description": "SIC 2007 codes, where the general nature of the business is given by classification category (s8A)." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Where business is actually carried on; fixes the registrar (LPA 1907 s8A)." }, "term": { "type": "object", "description": "Intended duration, if any, from registration: {years} or {end_date}." }, "general_partners": { "type": "array", "items": {}, "description": "At least one." }, "limited_partners": { "type": "array", "items": {}, "description": "At least one." }, "significant_control": { "type": "object", "description": "Required if scotland." }, "partnership_agreement_action_id": { "type": "string", "description": "act_ id of a uk.partnership_agreement.adopt action.", "examples": [ "act_1Qz8h2Gh5Ti7Af" ] }, "pre_registration_liability_acknowledged": { "type": "boolean", "description": "Must be true." }, "follow_on_actions": { "type": "array", "items": {}, "description": "Action types created automatically after registration." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "registration_jurisdiction", "firm_name", "nature_of_business", "principal_place_of_business", "general_partners", "limited_partners", "pre_registration_liability_acknowledged", "name", "countries_of_operation", "beneficial_owners" ], "description": "Registers a limited partnership at Companies House on form LP5 or LP5. Entiva prepares the application with each partner's particulars and each limited partner's contribution, collects every partner's signature or authentication, and." }, "Create_uk_limited_partnership_register": { "type": "object", "properties": { "type": { "const": "uk.limited_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a UK limited partnership or Scottish limited partnership", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "lp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "lp5_application", "title": "LP5 or LP5 application for registration of a limited partnership", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Limited partnership agreement", "source": "generated", "required": false }, { "key": "corporate_party_pack", "title": "Corporate party pack", "source": "uploaded", "required": false }, { "key": "slp_control_evidence", "title": "Evidence of control for the PSC statement", "source": "uploaded", "required": false }, { "key": "source_of_wealth_evidence", "title": "Source of funds and source of wealth evidence", "source": "uploaded", "required": false }, { "key": "engagement_terms", "title": "Engagement terms and mandate", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration of the limited partnership", "source": "registry_issued", "required": true }, { "key": "statement_of_initial_significant_control", "title": "Initial significant control statement", "source": "generated", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "each", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "lp5_application", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_initial_significant_control", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP5", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "invalid_entity_for_jurisdiction", "type": null, "when": "entity_type lp with scotland, or slp with england_wales or northern_ireland." }, { "code": "name_ending_invalid", "type": null, "when": "firm_name does not end with a form allowed by LPA 1907 s8B." }, { "code": "partner_roles_incomplete", "type": null, "when": "There is no general partner or no limited partner." }, { "code": "limited_partner_contribution_missing", "type": null, "when": "A limited partner has no contribution amount or form." }, { "code": "principal_place_of_business_outside_jurisdiction", "type": null, "when": "The address is not in the part of the UK given by registration_jurisdiction." }, { "code": "slp_psc_statement_required", "type": null, "when": "registration_jurisdiction is scotland and significant_control is missing." }, { "code": "partner_authentication_missing", "type": null, "when": "A proposed partner has not signed or authenticated the application." }, { "code": "pre_registration_liability_not_acknowledged", "type": null, "when": "pre_registration_liability_acknowledged is false." }, { "code": "person_disqualified", "type": null, "when": "Screening finds a proposed officer or PSC disqualified with no permission supplied." }, { "code": "screening_rejected", "type": null, "when": "Compliance review or a confirmed UK Sanctions List match ends the action; no detail is given." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_llp_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llp" ], "description": "Always llp." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK of the registered office; decides the registrar office." }, "welsh_llp": { "type": "boolean", "description": "england_wales only." }, "name": { "type": "string", "description": "Run uk.company_name.check first." }, "name_check_action_id": { "type": "string", "description": "act_ id of a completed uk.company_name.check.", "examples": [ "act_1Qz8e2LkUvBn" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Default: Entiva's address in the same part of the UK." }, "registered_email": { "type": "string", "description": "Registered email, not public.", "examples": [ "registered@northgate-robotics.example" ] }, "sic_codes": { "type": "array", "items": {}, "description": "SIC 2007 codes, if LL IN01 asks for them." }, "lawful_business_confirmed": { "type": "boolean", "description": "Must be true: two or more persons are carrying on a lawful business with a view to profit and have subscribed their names (LLP Act 2000 s2)." }, "members": { "type": "array", "items": {}, "description": "At least two members." }, "designated_members": { "type": "string", "enum": [ "all_members", "named" ], "description": "all_members: every person who is from time to time a member is designated. named: only members flagged designated: true (LLP Act 2000 s2)." }, "no_disqualified_persons_confirmed": { "type": "boolean", "description": "Must be true." }, "disqualification_exceptions": { "type": "array", "items": {}, "description": "Only if disqualified but for court permission or a sanctions licence: {person_id, kind, court_or_issuer, date} (LLP Act s2-)." }, "significant_control": { "type": "object", "description": "LLP initial significant control: {no_registrable_person: true} or {registrable_persons: [{person_id, natures_of_control[], knows_particulars_included: true}]." }, "partnership_agreement_action_id": { "type": "string", "description": "act_ id of a uk.partnership_agreement.adopt.", "examples": [ "act_1Qz8g3Ee4Nf9Xc" ] }, "speed": { "type": "string", "enum": [ "standard", "same_day" ], "description": "standard or same_day." }, "follow_on_actions": { "type": "array", "items": {}, "description": "Action types created automatically once the LLP is registered." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "registration_jurisdiction", "name", "lawful_business_confirmed", "members", "designated_members", "no_disqualified_persons_confirmed", "significant_control", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Registers a new LLP at Companies House by software filing. Entiva builds the incorporation document with the members' particulars, identity-verification confirmations, disqualification and initial significant control statements." }, "Create_uk_llp_incorporate": { "type": "object", "properties": { "type": { "const": "uk.llp.incorporate" }, "params": { "$ref": "#/components/schemas/Params_uk_llp_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a UK limited liability partnership", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "llp_incorporation_document", "title": "LL IN01 incorporation document with members' particulars and statements", "source": "generated", "required": true }, { "key": "statement_of_compliance", "title": "Statement of compliance (LLP Act 2000 s2)", "source": "generated", "required": true }, { "key": "corporate_party_pack", "title": "Corporate party pack", "source": "uploaded", "required": false }, { "key": "registered_office_evidence", "title": "Evidence for a customer-supplied registered office", "source": "uploaded", "required": false }, { "key": "llp_agreement", "title": "LLP agreement", "source": "generated", "required": false }, { "key": "source_of_wealth_evidence", "title": "Source of funds and source of wealth evidence", "source": "uploaded", "required": false }, { "key": "engagement_terms", "title": "Engagement terms and mandate", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "member_identity_verification", "title": "Companies House identity verification record for each individual member", "source": "registry_issued", "required": true }, { "key": "personal_codes", "title": "Personal codes of members and initial PSCs, held in the KYC vault and never returned by the API", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "llp_incorporation_document", "signer_role": "incorporator", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_compliance", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "llp_incorporation_document", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "llp_incorporation_document", "signer_role": "incorporator", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "member_identity_verification", "signer_role": "member", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "personal_codes", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "llp_incorporation_document", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LL IN01 application for incorporation of an LLP", "channel": "online", "government_fee": { "amount": 100, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_not_available", "type": null, "when": "Wrong ending, 'same as' name or sensitive word without permission; run uk.company_name.check." }, { "code": "member_not_verified", "type": null, "when": "An individual member has no Companies House personal code; the LLP cannot be registered without it." }, { "code": "llp_minimum_members", "type": null, "when": "Fewer than two members are listed." }, { "code": "llp_designated_members_missing", "type": null, "when": "designated_members is named but no member is flagged designated, or fewer than two members are designated." }, { "code": "registered_office_not_appropriate", "type": null, "when": "Customer registered office fails the s86 test or is outside registration_jurisdiction." }, { "code": "subscriber_authentication_missing", "type": null, "when": "A subscriber has not authenticated, or the code is invalid." }, { "code": "statements_not_confirmed", "type": null, "when": "A required statement is false or its click-consent record is missing." }, { "code": "welsh_option_not_available", "type": null, "when": "Welsh option set outside england_wales." }, { "code": "screening_rejected", "type": null, "when": "Compliance review or a confirmed UK Sanctions List match ends the action; no detail is given." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_overseas_entity_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "UK part where the land is.", "examples": [ "england_wales" ] }, "other_land_jurisdictions": { "type": "array", "items": {}, "description": "Further UK parts where the entity holds land, using the same enum values.", "examples": [ "[\"scotland\"]" ] }, "land_trigger": { "type": "string", "enum": [ "buying", "selling", "transferring", "leasing", "charging", "holds_land_acquired_since_cutoff", "disposed_since_2022_02_28" ], "description": "Why the entity must register: buying, selling, transferring, leasing or charging UK land; holds_land_acquired_since_cutoff; or disposed_since_2022_02_28.", "examples": [ "buying" ] }, "land_title_numbers": { "type": "array", "items": {}, "description": "HM Land Registry or Registers of Scotland or LPS title numbers, where known.", "examples": [ "[\"NGL123456\"]" ] }, "disposal_details": { "type": "object", "description": "Required when land_trigger is disposed_since_2022_02_28." }, "overseas_entity": { "type": "object", "description": "The entity.", "examples": [ "{\"name\":\"Harbour Point Holdings S.A.\",\"country_of_formation\":\"LU\"}" ] }, "beneficial_owners_identified": { "type": "string", "enum": [ "all", "some", "none" ], "description": "all: every registrable beneficial owner is identified. some or none: managing_officers[] becomes mandatory.", "examples": [ "all" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "Registrable beneficial owners.", "examples": [ "[{\"kind\":\"individual\",\"person_id\":\"per_7Ds4Nf1Qw8\"}]" ] }, "managing_officers": { "type": "array", "items": {}, "description": "Required if no beneficial owner exists or not all are identified." }, "trusts": { "type": "array", "items": {}, "description": "Required where trustees are registrable beneficial owners." }, "filing_mode": { "type": "string", "enum": [ "entiva_files_and_verifies", "verify_only" ], "description": "entiva_files_and_verifies: Entiva verifies and files, with the verification statement delivered inside the application. verify_only: the customer files.", "examples": [ "entiva_files_and_verifies" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Officer of the entity who instructs Entiva and confirms the information is accurate.", "examples": [ "per_2Hs6Bv9Xc3" ] }, "contact": { "type": "object", "description": "Application contact.", "examples": [ "{\"name\":\"A. Becker\",\"email\":\"a.becker@example.com\"}" ] } }, "required": [ "registration_jurisdiction", "land_trigger", "overseas_entity", "beneficial_owners_identified", "beneficial_owners", "authorised_signatory", "contact" ], "description": "Registers a non-UK entity that holds, or is about to buy, sell, transfer, lease or charge UK land on the Companies House Register of Overseas Entities. A UK-regulated agent verifies every beneficial owner and managing officer, signs the." }, "Create_uk_overseas_entity_register": { "type": "object", "properties": { "type": { "const": "uk.overseas_entity.register" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_entity_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an overseas entity on the Register of Overseas Entities", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "roe_overseas_entity" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "overseas_entity_registry_extract", "title": "Extract or certificate from the entity's home register", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Constitution or governing document", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members or shareholder list with shares and voting rights", "source": "uploaded", "required": true }, { "key": "register_of_directors_or_managers", "title": "Register of directors or managers", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart down to the ultimate individuals", "source": "uploaded", "required": true }, { "key": "beneficial_owner_evidence", "title": "Evidence of each beneficial owner's interest", "source": "uploaded", "required": true }, { "key": "trust_deed", "title": "Trust deed and deeds of appointment", "source": "uploaded", "required": false }, { "key": "disposal_deed", "title": "Deed or transfer evidencing a disposal", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution approving registration and naming the authorised signatory", "source": "generated", "required": true }, { "key": "roe_application_draft", "title": "ROE application for the customer's review", "source": "generated", "required": true }, { "key": "roe_verification_statement", "title": "Overseas entity verification checks statement", "source": "generated", "required": true }, { "key": "verification_evidence_pack", "title": "Verification evidence kept by the verifying agent", "source": "generated", "required": true }, { "key": "notice_of_registration", "title": "Companies House notice of registration with the Overseas Entity ID", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "roe_application_draft", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "roe_verification_statement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "roe_application_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House, Register of Overseas Entities", "form": "Online ROE application including the UK-regulated agent's verification statement and agent", "channel": "online", "government_fee": { "amount": 250, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "registration_jurisdiction_not_supported", "type": null, "when": "registration_jurisdiction is not one of england_wales, scotland or northern_ireland" }, { "code": "verification_expired", "type": null, "when": "The agent's verification is more than 3 months old when the application is filed" }, { "code": "beneficial_owner_unverified", "type": null, "when": "A beneficial owner or managing officer has not completed identity_address or KYB verification" }, { "code": "managing_officer_required", "type": null, "when": "beneficial_owners_identified is some or none and managing_officers[] is empty" }, { "code": "trust_information_missing", "type": null, "when": "A trustee is a registrable beneficial owner but trusts[] is empty or incomplete" }, { "code": "agent_assurance_code_unavailable", "type": null, "when": "No UK-regulated agent holding an agent assurance code is available, so the verification statement cannot be made" }, { "code": "agent_details_mismatch", "type": null, "when": "The agent's details on the statement do not exactly match those used to request the assurance code" }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists for any beneficial owner, managing officer or the entity" }, { "code": "payment_failed", "type": null, "when": "The £250 card payment to Companies House fails" }, { "code": "entity_already_registered", "type": null, "when": "The overseas entity already has an Overseas Entity ID in Entiva's records or the register" }, { "code": "registry_rejected", "type": null, "when": "Companies House rejects the application; the £250 fee is refunded and next steps are returned in requirement" } ] } }, "Params_uk_partnership_agreement_adopt": { "type": "object", "properties": { "agreement_type": { "type": "string", "enum": [ "llp_agreement", "limited_partnership_agreement", "pflp_written_agreement" ], "description": "llp_agreement, limited_partnership_agreement, pflp_written_agreement." }, "mode": { "type": "string", "enum": [ "entiva_template", "uploaded" ], "description": "entiva_template: drafted from the answers in key_terms. uploaded: the customer's agreement, supplied as document_id." }, "document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the uploaded agreement." }, "governing_law": { "type": "string", "enum": [ "england_wales", "scots_law", "northern_ireland" ], "description": "Default follows the registration jurisdiction of the entity." }, "execution": { "type": "string", "enum": [ "under_hand", "deed_individuals", "deed_company" ], "description": "under_hand, deed_individuals, deed_company." }, "partners": { "type": "array", "items": {}, "description": "The parties." }, "key_terms": { "type": "object", "description": "Template answers: {profit_sharing, capital_contributions, management_and_voting, admission_and_exit}." }, "effective_date": { "type": "string", "format": "date", "description": "Default: the date the partnership is registered." } }, "required": [ "agreement_type", "mode", "partners" ], "description": "Prepares and executes the private agreement that governs an LLP, limited partnership or private fund limited partnership. It is never filed at Companies House." }, "Create_uk_partnership_agreement_adopt": { "type": "object", "properties": { "type": { "const": "uk.partnership_agreement.adopt" }, "params": { "$ref": "#/components/schemas/Params_uk_partnership_agreement_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt an LLP agreement or limited partnership agreement", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "llp", "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_agreement", "title": "LLP or limited partnership agreement", "source": "generated", "required": true }, { "key": "uploaded_agreement", "title": "Customer-supplied agreement", "source": "uploaded", "required": false }, { "key": "corporate_party_pack", "title": "Corporate party pack", "source": "uploaded", "required": false } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "partner", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. LLP and LP agreements are private and not filed", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "agreement_type_mismatch", "type": null, "when": "agreement_type does not fit the entity type." }, { "code": "partner_not_on_application", "type": null, "when": "A listed partner is not a partner of the pending registration." }, { "code": "signature_method_invalid_for_deed", "type": null, "when": "Execution is a deed and a partner tries an electronic signature without the required witness or authorised signatories." }, { "code": "entity_not_forming_or_active", "type": null, "when": "The entity is closed or being wound up." } ] } }, "Params_uk_partnership_self_assessment_register": { "type": "object", "properties": { "partnership_start_date": { "type": "string", "format": "date", "description": "Date the partnership started." }, "accounting_date": { "type": "string", "description": "Month and day the partnership's accounts are made up to." }, "nominated_partner": { "type": "string", "pattern": "^per_", "description": "The partner who completes SA400 and deals with HMRC for the partnership." }, "nature_of_business": { "type": "string", "description": "What the partnership does." }, "business_address": { "$ref": "#/components/schemas/Address", "description": "Address of the partnership's business." }, "partners": { "type": "array", "items": {}, "description": "Items: {person_id | entity_id, role}." }, "registration_route": { "type": "string", "enum": [ "online", "paper_sa400" ], "description": "online or paper_sa400." }, "nominated_partner_utr": { "type": "string", "description": "10-digit UTR of the nominated partner, if the online route asks for one.", "examples": [ "1234567890" ] }, "vat_registration_number": { "type": "string", "description": "VAT registration number, if the partnership has one.", "examples": [ "123456789" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "partnership_start_date", "accounting_date", "nominated_partner", "nature_of_business", "business_address", "partners", "name", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers the partnership with HMRC for Self Assessment on form SA400, completed by the nominated partner, so HMRC issues the partnership's reference. Individual partners register for Self Assessment separately." }, "Create_uk_partnership_self_assessment_register": { "type": "object", "properties": { "type": { "const": "uk.partnership_self_assessment.register" }, "params": { "$ref": "#/components/schemas/Params_uk_partnership_self_assessment_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a partnership, LLP or limited partnership for Self Assessment", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "llp", "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "sa400_registration", "title": "SA400 partnership registration details for the nominated partner", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "HMRC confirmation that Entiva is authorised for the partnership", "source": "registry_issued", "required": false }, { "key": "hmrc_registration_confirmation", "title": "HMRC acknowledgement with the partnership reference", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "sa400_registration", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sa400_registration", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "hmrc_agent_authorisation", "signer_role": "partner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "HM Revenue and Customs", "form": "SA400 partnership registration", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_incorporated", "type": null, "when": "The entity has no company or registration number yet." }, { "code": "nominated_partner_not_a_partner", "type": null, "when": "nominated_partner is not listed in partners or is not a partner of the entity." }, { "code": "partnership_start_date_in_future", "type": null, "when": "partnership_start_date is after today." }, { "code": "already_registered_for_self_assessment", "type": null, "when": "HMRC already holds a partnership registration for the entity." }, { "code": "government_gateway_required", "type": null, "when": "registration_route is online and the nominated partner has not completed the Government Gateway step." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_paye_scheme_register": { "type": "object", "properties": { "first_payday": { "type": "string", "format": "date", "description": "Date of the first payday.", "examples": [ "2026-11-27" ] }, "payroll_triggers": { "type": "array", "items": {}, "description": "At least one of: pay_at_or_above_threshold, pension_or_other_job, expenses_or_benefits, cis_subcontractors, sole_director_only_employee.", "examples": [ "[\"pay_at_or_above_threshold\"]" ] }, "expected_employee_count": { "type": "integer", "description": "Number of people expected to be on the payroll in the first pay period, including directors who are paid through payroll.", "examples": [ "3" ] }, "pay_frequency": { "type": "string", "enum": [ "weekly", "fortnightly", "four_weekly", "monthly", "other" ], "description": "How often staff will be paid.", "examples": [ "monthly" ] }, "payroll_method": { "type": "string", "enum": [ "payroll_software", "payroll_provider", "other" ], "description": "How payroll will be run.", "examples": [ "payroll_software" ] }, "directors_count": { "type": "integer", "description": "Number of directors or members/partners.", "examples": [ "2" ] }, "authorised_officer": { "type": "string", "pattern": "^per_", "description": "Director, designated member, general partner or authorised signatory who instructs Entiva and, if HMRC requires it, signs in to HMRC personally.", "examples": [ "per_3kQ9wZ7Lm2" ] }, "authorise_entiva_as_agent": { "type": "boolean", "description": "If true, Entiva asks the officer to authorise it as HMRC tax agent so later payroll-related filings can be made for the entity.", "examples": [ "true" ] }, "already_paid_staff": { "type": "boolean", "description": "True if anyone has already been paid before registration.", "examples": [ "false" ] }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Where HMRC posts the PAYE reference letter." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "first_payday", "payroll_triggers", "expected_employee_count", "pay_frequency", "payroll_method", "directors_count", "authorised_officer", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a UK entity as an employer with HMRC before its first payday so it receives a PAYE reference. Entiva collects the payroll facts, gets the officer's instruction, and completes the HMRC online registration." }, "Create_uk_paye_scheme_register": { "type": "object", "properties": { "type": { "const": "uk.paye_scheme.register" }, "params": { "$ref": "#/components/schemas/Params_uk_paye_scheme_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an entity as an employer with HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "employer_registration_instruction", "title": "Instruction and declaration to register as an employer", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "HMRC agent authorisation", "source": "generated", "required": false }, { "key": "paye_registration_receipt", "title": "HMRC submission receipt", "source": "registry_issued", "required": false }, { "key": "paye_reference_letter", "title": "HMRC letter with the employer PAYE reference", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "employer_registration_instruction", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "hmrc_agent_authorisation", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "paye_registration_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "HMRC online employer registration", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action" }, { "code": "entity_not_registered", "type": null, "when": "The entity has not yet been incorporated or registered, so it cannot be registered as an employer" }, { "code": "registration_too_early", "type": null, "when": "first_payday is more than 2 months after the submission date" }, { "code": "paye_scheme_already_exists", "type": null, "when": "The entity already has an active employer PAYE reference in Entiva's records" }, { "code": "payroll_trigger_missing", "type": null, "when": "payroll_triggers is empty, so Entiva cannot confirm the entity needs to register" }, { "code": "directors_count_requires_alternative_route", "type": null, "when": "The entity is outside the online route and needs HMRC's other route" }, { "code": "officer_verification_incomplete", "type": null, "when": "The authorised officer has not reached the required verification level" }, { "code": "hmrc_registration_rejected", "type": null, "when": "HMRC rejects or queries the registration; the reason is returned in requirement" } ] } }, "Params_uk_private_fund_limited_partnership_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "pflp" ], "description": "Always pflp." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK of the registered office; decides the registrar office." }, "firm_name": { "type": "string", "description": "Must satisfy LPA 1907 s8B: ends 'limited partnership' or 'LP'." }, "name_check_action_id": { "type": "string", "description": "act_ id of a completed uk.company_name.check.", "examples": [ "act_1Qz8e2LkUvBn" ] }, "nature_of_business": { "type": "string", "description": "Not required for a PFLP (s8A); recorded for the file.", "examples": [ "Private equity fund investing in UK growth companies" ] }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Where business is actually carried on; fixes the registrar (LPA 1907 s8A)." }, "general_partners": { "type": "array", "items": {}, "description": "At least one." }, "limited_partners": { "type": "array", "items": {}, "description": "At least one." }, "partnership_agreement_action_id": { "type": "string", "description": "act_ id of a completed uk.partnership_agreement.adopt." }, "collective_investment_scheme_confirmed": { "type": "boolean", "description": "Must be true." }, "significant_control": { "type": "object", "description": "Required if scotland; same shape as uk.limited_partnership.register." }, "pre_registration_liability_acknowledged": { "type": "boolean", "description": "Must be true." }, "follow_on_actions": { "type": "array", "items": {}, "description": "Action types created automatically after registration." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "registration_jurisdiction", "firm_name", "principal_place_of_business", "general_partners", "limited_partners", "partnership_agreement_action_id", "collective_investment_scheme_confirmed", "pre_registration_liability_acknowledged", "name", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a limited partnership and designates it a private fund limited partnership in one application on form LP7 or LP7. The partnership must be constituted by a written agreement and be a collective investment scheme." }, "Create_uk_private_fund_limited_partnership_register": { "type": "object", "properties": { "type": { "const": "uk.private_fund_limited_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_uk_private_fund_limited_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register and designate a UK private fund limited partnership", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "pflp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "lp7_application", "title": "LP7 or LP7 application for registration as a private fund limited partnership", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Written partnership agreement", "source": "generated", "required": true }, { "key": "corporate_party_pack", "title": "Corporate party pack", "source": "uploaded", "required": false }, { "key": "slp_control_evidence", "title": "Evidence of control for the PSC statement", "source": "uploaded", "required": false }, { "key": "source_of_wealth_evidence", "title": "Source of funds and source of wealth evidence", "source": "uploaded", "required": false }, { "key": "engagement_terms", "title": "Engagement terms and mandate", "source": "generated", "required": true }, { "key": "certificate_of_registration_and_designation", "title": "Certificate of registration and designation as a PFLP", "source": "registry_issued", "required": true }, { "key": "statement_of_initial_significant_control", "title": "Initial significant control statement", "source": "generated", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "each", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "lp7_application", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp7_application", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_of_initial_significant_control", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP7", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "invalid_entity_for_jurisdiction", "type": null, "when": "registration_jurisdiction is not one of the three UK values for the entity." }, { "code": "name_ending_invalid", "type": null, "when": "firm_name does not end with a form allowed by LPA 1907 s8B." }, { "code": "pflp_agreement_required", "type": null, "when": "partnership_agreement_action_id is missing, not completed or not a pflp_written_agreement." }, { "code": "pflp_conditions_not_confirmed", "type": null, "when": "collective_investment_scheme_confirmed is false or the general partner confirmation is missing." }, { "code": "partner_roles_incomplete", "type": null, "when": "There is no general partner or no limited partner." }, { "code": "principal_place_of_business_outside_jurisdiction", "type": null, "when": "The address is not in the part of the UK given by registration_jurisdiction." }, { "code": "slp_psc_statement_required", "type": null, "when": "registration_jurisdiction is scotland and significant_control is missing." }, { "code": "partner_authentication_missing", "type": null, "when": "A proposed partner has not signed or authenticated the application." }, { "code": "screening_rejected", "type": null, "when": "Compliance review or a confirmed UK Sanctions List match ends the action; no detail is given." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_public_company_trading_certificate_apply": { "type": "object", "properties": { "allotted_share_capital_nominal": { "$ref": "#/components/schemas/Money", "description": "Nominal value of the company's allotted share capital." }, "aggregate_paid_up_nominal": { "$ref": "#/components/schemas/Money", "description": "Aggregate amount paid up on the company's shares, counting nominal value only." }, "preliminary_expenses": { "type": "object", "description": "{amount: money, estimated: boolean}." }, "promoter_benefits": { "type": "array", "items": {}, "description": "Any amount or benefit paid or given, or intended, to a promoter, and the consideration." }, "signatory": { "type": "string", "pattern": "^per_", "description": "The director or secretary who makes the application and the statement of compliance." }, "statement_of_compliance_confirmed": { "type": "boolean", "description": "Must be true: the company meets the requirements for a certificate under s761." } }, "required": [ "allotted_share_capital_nominal", "aggregate_paid_up_nominal", "preliminary_expenses", "promoter_benefits", "signatory", "statement_of_compliance_confirmed" ], "description": "Applies on form SH50 for the certificate a company registered as public on incorporation needs before it may do business or exercise borrowing powers. The company states its allotted capital meets the £50,000 authorised minimum, gives the." }, "Create_uk_public_company_trading_certificate_apply": { "type": "object", "properties": { "type": { "const": "uk.public_company_trading_certificate.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_public_company_trading_certificate_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a public company trading certificate", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "sh50_application", "title": "SH50 application for trading certificate for a public company", "source": "generated", "required": true }, { "key": "statement_of_compliance", "title": "Statement of compliance", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution approving the application", "source": "generated", "required": true }, { "key": "share_payment_evidence", "title": "Evidence of payment for the allotted shares", "source": "uploaded", "required": true }, { "key": "trading_certificate", "title": "Trading certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "sh50_application", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH50 Application for trading certificate for a public company", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "authorised_minimum_not_met", "type": null, "when": "allotted_share_capital_nominal is below £50,000 or the euro equivalent." }, { "code": "share_payment_below_minimum", "type": null, "when": "aggregate_paid_up_nominal shows shares paid up less than one-quarter plus premium." }, { "code": "entity_not_original_public_company", "type": null, "when": "The entity was re-registered from private to public or is not a public company." }, { "code": "trading_certificate_already_issued", "type": null, "when": "A trading certificate already exists for the entity." }, { "code": "statement_not_confirmed", "type": null, "when": "statement_of_compliance_confirmed is false or the signatory is not a director or secretary." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_register_of_members_form": { "type": "object", "properties": { "from_formation_action_id": { "type": "string", "description": "act_ id of the completed incorporation action." }, "members": { "type": "array", "items": {}, "description": "Needed without from_formation_action_id. {person_id | entity_id, date_registered, shares: [{class, number, amount_paid, amount_unpaid}]} or membership_class." }, "inspection_location": { "type": "string", "enum": [ "registered_office", "sail" ], "description": "registered_office or sail." }, "sail_address": { "$ref": "#/components/schemas/Address", "description": "Required when inspection_location is sail." }, "create_minute_book": { "type": "boolean", "description": "Open the minute book and the record of resolutions and meetings." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "name", "nature_of_business", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Creates the company's register of members from the incorporation and opens its minute book and record of resolutions. Entiva keeps them as the company's service provider at the registered office, or at a single alternative inspection." }, "Create_uk_register_of_members_form": { "type": "object", "properties": { "type": { "const": "uk.register_of_members.form" }, "params": { "$ref": "#/components/schemas/Params_uk_register_of_members_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up the register of members and company records", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "register_of_members", "title": "Register of members", "source": "generated", "required": true }, { "key": "minute_book", "title": "Minute book and record of resolutions", "source": "generated", "required": false }, { "key": "records_location_resolution", "title": "Board resolution fixing where the records are kept", "source": "generated", "required": false }, { "key": "allotment_evidence", "title": "Allotment or transfer documents for members not taken from a formation action", "source": "uploaded", "required": false } ], "people": [ { "role": "incorporator", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "register_of_members", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "records_location_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. The register of members is a company-held record", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_incorporated", "type": null, "when": "The entity has no company or registration number yet." }, { "code": "register_already_exists", "type": null, "when": "A register of members already exists for the entity." }, { "code": "member_particulars_incomplete", "type": null, "when": "A member lacks a date registered, or a shareholder lacks the class, number or amount paid." }, { "code": "members_do_not_match_formation", "type": null, "when": "members differs from the allotments in from_formation_action_id." }, { "code": "sail_address_missing", "type": null, "when": "inspection_location is sail and sail_address is missing." } ] } }, "Params_uk_registered_society_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Part of Great Britain of the registered office.", "examples": [ "england_wales" ] }, "society_type": { "type": "string", "enum": [ "co_operative", "community_benefit" ], "description": "co_operative: the FCA must be satisfied it is a bona fide co-operative society. community_benefit: the FCA must be satisfied the business is or will be.", "examples": [ "community_benefit" ] }, "name": { "type": "string", "description": "Proposed name.", "examples": [ "Hillfoot Community Hub Limited" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office in Great Britain." }, "registration_route": { "type": "string", "enum": [ "fca_portal", "sponsoring_body", "paper_form" ], "description": "fca_portal: the FCA Mutuals Society Portal. sponsoring_body: submitted through a sponsoring body that supplies model rules. paper_form: the FCA Word.", "examples": [ "fca_portal" ] }, "rules_option": { "type": "string", "enum": [ "model_rules_unchanged", "model_rules_amended", "own_rules" ], "description": "Drives the FCA fee band: sponsoring-body model rules unchanged, model rules amended, or own rules.", "examples": [ "own_rules" ] }, "sponsoring_body": { "type": "string", "description": "Required when rules_option is a model-rules option.", "examples": [ "Co-operatives UK" ] }, "rules_document": { "type": "string", "pattern": "^doc_", "description": "Required for own_rules or amended model rules." }, "objects": { "type": "string", "description": "The society's objects and the business, industry or trade it carries on (s2).", "examples": [ "To own and run the Hillfoot village hall and community cafe for the benefit of the community." ] }, "bona_fide_or_community_statement": { "type": "string", "description": "For co_operative, why it is a bona fide co-operative (a society whose main object is profit mainly to pay interest, dividends or bonuses on money invested is.", "examples": [ "Profits are reinvested in the hall. No dividend is paid." ] }, "members": { "type": "array", "items": {}, "description": "At least 3 members, or 2 members that are both registered societies (s2).", "examples": [ "[\"per_1Ax4Lm7Kd2\",\"per_5Cz9Nr3Tq6\",\"per_9Ev2Hp8Wy1\"]" ] }, "signatory_members": { "type": "array", "items": {}, "description": "The three members who sign the application with the secretary.", "examples": [ "[\"per_1Ax4Lm7Kd2\",\"per_5Cz9Nr3Tq6\",\"per_9Ev2Hp8Wy1\"]" ] }, "secretary": { "type": "string", "pattern": "^per_", "description": "The society's secretary, who signs the application.", "examples": [ "per_3Dq6Sv5Bn8" ] }, "committee_members": { "type": "array", "items": {}, "description": "Person ids of the initial committee or board, as the rules provide.", "examples": [ "[\"per_1Ax4Lm7Kd2\",\"per_3Dq6Sv5Bn8\"]" ] }, "fsma_regulated_activity": { "type": "boolean", "description": "True if the society will carry on an activity regulated under FSMA 2000.", "examples": [ "false" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day, for example 03-31.", "examples": [ "03-31" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "registration_jurisdiction", "society_type", "name", "registered_office", "registration_route", "rules_option", "objects", "bona_fide_or_community_statement", "members", "signatory_members", "secretary", "committee_members", "fsma_regulated_activity", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Creates a registered society under the Co-operative and Community Benefit Societies Act 2014 by applying to the FCA. The application is signed by the secretary and three members." }, "Create_uk_registered_society_register": { "type": "object", "properties": { "type": { "const": "uk.registered_society.register" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a co-operative or community benefit society with the FCA", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "society_rules", "title": "Society rules", "source": "generated", "required": true }, { "key": "fca_application", "title": "FCA application for registration", "source": "generated", "required": true }, { "key": "sponsoring_body_confirmation", "title": "Sponsoring body's confirmation of model rules", "source": "uploaded", "required": false }, { "key": "founders_resolution", "title": "Founder members' resolution adopting the rules", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "FCA acknowledgment of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fca_application", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fca_application", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "founders_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority", "form": "FCA Mutuals Society Portal application, an application", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "registration_jurisdiction_not_supported", "type": null, "when": "registration_jurisdiction is northern_ireland, or the registered office is outside Great Britain and the Channel Islands" }, { "code": "minimum_members_not_met", "type": null, "when": "Fewer than 3 members, or fewer than 2 members that are both registered societies (s2)" }, { "code": "secretary_and_signatories_required", "type": null, "when": "The application lacks a secretary and three signing members" }, { "code": "name_ending_invalid", "type": null, "when": "The last word of the name is not 'limited' and no charitable or benevolent exemption applies" }, { "code": "name_undesirable", "type": null, "when": "The FCA considers the name undesirable" }, { "code": "rules_missing_required_matters", "type": null, "when": "The rules do not cover every s14 matter" }, { "code": "not_bona_fide_co_operative", "type": null, "when": "The FCA is not satisfied the society is a bona fide co-operative, or the community-benefit test is not met" }, { "code": "credit_union_objects", "type": null, "when": "The objects are mainly those of a credit union, which must register under the Credit Unions Act 1979" }, { "code": "banking_with_withdrawable_shares", "type": null, "when": "A society with withdrawable share capital is to carry on banking, which cannot be registered" }, { "code": "fsma_authorisation_required", "type": null, "when": "fsma_regulated_activity is true, so separate FCA authorisation is needed" }, { "code": "registry_rejected", "type": null, "when": "The FCA refuses or returns the application" } ] } }, "Params_uk_sail_notify": { "type": "object", "properties": { "sail_address": { "$ref": "#/components/schemas/Address", "description": "The single alternative inspection location where the listed records are open to inspection." }, "records": { "type": "array", "items": {}, "description": "members_register, records_of_resolutions_and_meetings, directors_service_contracts, directors_indemnities, own_share_purchase_contracts." }, "effective_date": { "type": "string", "format": "date", "description": "Date the records are or were first kept at the SAIL." } }, "required": [ "sail_address", "records" ], "description": "Tells Companies House that listed company records, such as the register of members, are kept at a single alternative inspection location instead of the registered office. Entiva files AD02 with AD03 for the move after the board decides." }, "Create_uk_sail_notify": { "type": "object", "properties": { "type": { "const": "uk.sail.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_sail_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify a single alternative inspection location", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "sail_notification", "title": "AD02 notification of SAIL, with AD03 for the records moved", "source": "generated", "required": true }, { "key": "records_location_resolution", "title": "Board resolution fixing the SAIL", "source": "generated", "required": true }, { "key": "occupier_consent", "title": "Consent of the occupier of the SAIL address to hold and show the records", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "records_location_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sail_notification", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AD02 Notification of single alternative inspection location", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_incorporated", "type": null, "when": "The entity has no company or registration number yet." }, { "code": "authentication_code_unavailable", "type": null, "when": "Entiva does not hold the company authentication code, so it cannot authenticate the filing." }, { "code": "record_not_eligible_for_sail", "type": null, "when": "records contains a record type that cannot be kept at a SAIL." }, { "code": "sail_already_notified", "type": null, "when": "The same address is already notified for all listed records." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_scio_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Only Scotland.", "examples": [ "scotland" ] }, "name": { "type": "string", "description": "Proposed name.", "examples": [ "Kelvin Community Garden SCIO" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Proposed principal office." }, "applicants": { "type": "array", "items": {}, "description": "Two or more individuals who apply.", "examples": [ "[\"per_2Ac6Lw3Pn8\",\"per_7Hd1Ys5Gm4\",\"per_5Tk9Bv2Rx7\"]" ] }, "trustees": { "type": "array", "items": {}, "description": "At least 3 charity trustees: the constitution must provide for 3 or more persons and OSCR says a SCIO needs a minimum of three.", "examples": [ "[\"per_2Ac6Lw3Pn8\",\"per_7Hd1Ys5Gm4\",\"per_5Tk9Bv2Rx7\"]" ] }, "constitution_model": { "type": "string", "enum": [ "model", "bespoke" ], "description": "model: Entiva generates a constitution from OSCR's model. bespoke: own draft, uploaded as constitution_document.", "examples": [ "model" ] }, "constitution_document": { "type": "string", "pattern": "^doc_", "description": "Required for bespoke." }, "charitable_purposes": { "type": "string", "description": "The purposes, for the charity test.", "examples": [ "To advance environmental protection and improvement through community gardening." ] }, "public_benefit_statement": { "type": "string", "description": "How the purposes provide public benefit.", "examples": [ "The garden is open free to all residents of Glasgow's west end." ] }, "activities_and_funding": { "type": "object", "description": "Shape: {activities, expected_funding_sources}.", "examples": [ "{\"activities\":\"Weekly gardening sessions\",\"expected_funding_sources\":\"Grants and donations\"}" ] }, "bank_account": { "type": "object", "description": "Shape: {account_name, sort_code, account_number}." }, "public_contact": { "type": "object", "description": "Shape: {postal_address, email, phone, website}.", "examples": [ "{\"email\":\"hello@kelvingarden.example\"}" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registration_jurisdiction", "name", "principal_office", "applicants", "trustees", "constitution_model", "charitable_purposes", "public_benefit_statement", "activities_and_funding", "public_contact", "nature_of_business", "countries_of_operation", "directors", "beneficial_owners" ], "description": "Creates a SCIO by applying to OSCR under the Charities and Trustee Investment Act 2005 s54. The SCIO becomes a body corporate when OSCR enters it in the Scottish Charity Register." }, "Create_uk_scio_register": { "type": "object", "properties": { "type": { "const": "uk.scio.register" }, "params": { "$ref": "#/components/schemas/Params_uk_scio_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Create a Scottish charitable incorporated organisation through OSCR", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "scio" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "scio_constitution", "title": "SCIO constitution", "source": "generated", "required": true }, { "key": "trustee_declaration", "title": "Signed trustee declaration, one per proposed trustee", "source": "uploaded", "required": true }, { "key": "application_summary", "title": "Application for the applicants' review", "source": "generated", "required": true }, { "key": "oscr_registration_notice", "title": "OSCR confirmation and copy of the register entry sent to the principal office", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "scio_constitution", "signer_role": "applicant", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "trustee_declaration", "signer_role": "trustee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "application_summary", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Office of the Scottish Charity Regulator", "form": "OSCR online application to become a charity, choosing the SCIO legal form, with a draft SC", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "applicants_below_two", "type": null, "when": "Fewer than two individual applicants" }, { "code": "trustees_below_three", "type": null, "when": "The constitution or application provides for fewer than three charity trustees" }, { "code": "name_not_permitted", "type": null, "when": "The name falls within s10 of the 2005 Act and OSCR must refuse it" }, { "code": "constitution_non_compliant", "type": null, "when": "The constitution does not meet s50 or the regulations" }, { "code": "charity_test_not_met", "type": null, "when": "OSCR is not satisfied the SCIO would meet the charity test" }, { "code": "trustee_declaration_missing", "type": null, "when": "A signed declaration is missing for any proposed trustee" }, { "code": "application_inactive_deleted", "type": null, "when": "OSCR deletes the application after 3 months without activity" }, { "code": "registration_jurisdiction_not_supported", "type": null, "when": "registration_jurisdiction is not scotland" }, { "code": "registry_rejected", "type": null, "when": "OSCR refuses the application" } ] } }, "Params_uk_scottish_qualifying_partnership_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Only Scotland.", "examples": [ "scotland" ] }, "partnership_name": { "type": "string", "description": "Name of the partnership (SI 2017/694 reg 6).", "examples": [ "Glen Atholl Estates Partnership" ] }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Service address of the partnership (reg 6)." }, "confirms_scots_law_general_partnership": { "type": "boolean", "description": "Confirmation that it is a general partnership that is a qualifying partnership and is constituted under Scots law (reg 6).", "examples": [ "true" ] }, "qualifying_trigger": { "type": "string", "enum": [ "formation", "change_in_partners", "change_in_partners_partners" ], "description": "What made it a qualifying partnership: formation, a change in its partners, or a change in the partners in its partners.", "examples": [ "formation" ] }, "became_qualifying_on": { "type": "string", "format": "date", "description": "Date it became a qualifying partnership.", "examples": [ "2026-10-12" ] }, "partners": { "type": "array", "items": {}, "description": "Each partner.", "examples": [ "[{\"full_name\":\"Atholl Land Holdings Limited\",\"register\":{\"name\":\"Companies House\",\"jurisdiction\":\"scotland\"},\"registration_number\":\"SC123456\"}]" ] }, "psc_information": { "type": "object", "description": "PSC information required by SI 2017/694 Part 5." }, "partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "Optional." } }, "required": [ "registration_jurisdiction", "partnership_name", "service_address", "confirms_scots_law_general_partnership", "qualifying_trigger", "became_qualifying_on", "partners", "psc_information" ], "description": "Registers a Scots-law general partnership that is a qualifying partnership on Companies House form SQP1 and delivers its PSC information, within 14 days of becoming a qualifying partnership." }, "Create_uk_scottish_qualifying_partnership_register": { "type": "object", "properties": { "type": { "const": "uk.scottish_qualifying_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_uk_scottish_qualifying_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Scottish qualifying partnership with Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "sqp1_form", "title": "Form SQP1", "source": "generated", "required": true }, { "key": "sqp_psc_forms", "title": "SQP PSC01 to PSC03 forms, or SQP PSC08 statement", "source": "generated", "required": true }, { "key": "corporate_partner_documents", "title": "Corporate partner KYB pack", "source": "uploaded", "required": true }, { "key": "partnership_agreement_copy", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "sqp_registration_confirmation", "title": "Companies House confirmation of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp1_form", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sqp_psc_forms", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sqp1_form", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP1", "channel": "both", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "not_a_qualifying_partnership", "type": null, "when": "A partner is not a limited company or one of the qualifying forms (Partnership Regulations 2008 reg 3)" }, { "code": "not_scots_law_partnership", "type": null, "when": "The partnership is not constituted under Scots law" }, { "code": "deadline_exceeded", "type": null, "when": "became_qualifying_on is more than 14 days ago, so the late-registration offence exposure is flagged and the filing proceeds as late" }, { "code": "partner_register_details_missing", "type": null, "when": "A partner entered in a register has no register jurisdiction or registration number (reg 6)" }, { "code": "psc_information_missing", "type": null, "when": "Neither PSC details nor a no-PSC statement is supplied" }, { "code": "already_registered", "type": null, "when": "The partnership already has a registered SQP number" }, { "code": "registry_rejected", "type": null, "when": "Companies House rejects or returns the SQP1" } ] } }, "Params_uk_vat_register": { "type": "object", "properties": { "registration_basis": { "type": "string", "enum": [ "compulsory_threshold_exceeded", "compulsory_expected_to_exceed", "voluntary", "non_established_taxable_person" ], "description": "compulsory_threshold_exceeded, compulsory_expected_to_exceed, voluntary, or non_established_taxable_person." }, "taxable_turnover_last_12_months": { "$ref": "#/components/schemas/Money", "description": "Taxable turnover for the last 12 months." }, "expected_taxable_turnover_next_12_months": { "$ref": "#/components/schemas/Money", "description": "Estimate of taxable turnover for the next 12 months." }, "threshold_exceeded_date": { "type": "string", "format": "date", "description": "Required for compulsory_threshold_exceeded: the date taxable turnover went over £90,000.", "examples": [ "2026-09-18" ] }, "date_realised": { "type": "string", "format": "date", "description": "Required for compulsory_expected_to_exceed: the date the business realised it would exceed the threshold.", "examples": [ "2026-10-10" ] }, "requested_effective_date": { "type": "string", "format": "date", "description": "voluntary only: the date registration should take effect." }, "business_activity_description": { "type": "string", "description": "What the business sells." }, "sic_codes": { "type": "array", "items": {}, "description": "SIC 2007 codes." }, "bank_account": { "type": "object", "description": "Only {account_holder_name} goes in the API call; the person enters sort code and account number on the hosted secure link." }, "partners": { "type": "array", "items": {}, "description": "lp, pflp, slp only." }, "utr": { "type": "string", "description": "10-digit UTR if the entity has one.", "examples": [ "1234567890" ] }, "registration_route": { "type": "string", "enum": [ "online", "vat1_post" ], "description": "online, or vat1_post only for HMRC's listed cases." }, "late_registration_acknowledged": { "type": "boolean", "description": "Must be true if the 30-day deadline has passed." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registration_basis", "taxable_turnover_last_12_months", "expected_taxable_turnover_next_12_months", "business_activity_description", "bank_account", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a company, CIC, LLP, partnership or UK establishment for VAT with HMRC, either because taxable turnover passed the £90,000 threshold, is expected to, or voluntarily. Entiva prepares the application, takes the business's." }, "Create_uk_vat_register": { "type": "object", "properties": { "type": { "const": "uk.vat.register" }, "params": { "$ref": "#/components/schemas/Params_uk_vat_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register for VAT", "x-entiva": { "jurisdiction": "uk", "stage": "formation", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "vat_registration_application", "title": "VAT registration details for approval", "source": "generated", "required": true }, { "key": "turnover_evidence", "title": "Sales ledger or invoices supporting turnover", "source": "uploaded", "required": false }, { "key": "hmrc_vat_agent_authorisation", "title": "HMRC confirmation of Entiva's VAT agent authorisation", "source": "registry_issued", "required": false }, { "key": "hmrc_vat_registration_confirmation", "title": "HMRC letter with the VAT registration number and effective date", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "vat_registration_application", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "hmrc_vat_agent_authorisation", "signer_role": "authorised_signatory", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "vat_registration_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HM Revenue and Customs", "form": "HMRC online VAT registration", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_incorporated", "type": null, "when": "The entity has no company or registration number yet." }, { "code": "registration_basis_mismatch", "type": null, "when": "A compulsory basis is chosen but turnover is below £90,000, or voluntary is chosen with turnover above it." }, { "code": "threshold_date_missing", "type": null, "when": "threshold_exceeded_date or date_realised is missing for a compulsory basis." }, { "code": "late_registration_acknowledgement_required", "type": null, "when": "The 30-day deadline has passed and late_registration_acknowledged is not true." }, { "code": "secure_details_required", "type": null, "when": "bank_account or partner identity details have not been given through the hosted secure link." }, { "code": "already_vat_registered", "type": null, "when": "HMRC already holds a VAT registration for the entity." }, { "code": "agent_authorisation_pending", "type": null, "when": "The authorised signatory has not approved Entiva's agent authorisation." }, { "code": "registry_rejected", "type": null, "when": "The registry rejects the filing; message gives its reason." } ] } }, "Params_uk_accounting_records_record": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "records_location": { "type": "string", "enum": [ "registered_office", "other_uk_address", "outside_uk" ], "description": "Where the records are kept: registered_office or other_uk_address (any place the directors think fit, open to officers at all times, s388), or outside_uk." }, "records_address": { "$ref": "#/components/schemas/Address", "description": "Address or provider site where the records are kept." }, "uk_summary_location": { "$ref": "#/components/schemas/Address", "description": "Required for outside_uk: UK address holding the accounts and returns, showing the position with reasonable accuracy at intervals of no more than six months." }, "storage_provider": { "type": "string", "enum": [ "company", "accountant_or_bookkeeper", "cloud_accounting_software", "entiva_archive" ], "description": "Who holds the records." }, "responsible_officer": { "type": "string", "pattern": "^per_", "description": "Director responsible for the records." }, "bookkeeper": { "type": "string", "pattern": "^per_", "description": "Accountant or bookkeeper acting for the company." }, "deals_in_goods": { "type": "boolean", "description": "True if the company deals in goods, so stock records are needed: year-end stock statements, supporting stocktaking, and statements of goods bought and sold." }, "record_types_confirmed": { "type": "array", "items": {}, "description": "Confirms day-to-day entries of sums received and spent with what each was for, and a record of assets and liabilities, plus stock records if deals_in_goods." }, "subsidiaries_covered": { "type": "boolean", "description": "Parent only: whether reasonable steps ensure subsidiaries to which s386 does not apply keep records that let the parent's directors check its accounts." }, "company_status": { "type": "string", "enum": [ "private", "public" ], "description": "private or public." } }, "required": [ "records_location", "records_address", "storage_provider", "responsible_officer", "deals_in_goods", "record_types_confirmed" ], "description": "Records where the company keeps its accounting records, who is responsible, and the retention schedule. Nothing is filed; deadlines and reminders are created." }, "Create_uk_accounting_records_record": { "type": "object", "properties": { "type": { "const": "uk.accounting_records.record" }, "params": { "$ref": "#/components/schemas/Params_uk_accounting_records_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up and confirm the company's accounting records", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "records_policy", "title": "Accounting records and retention schedule", "source": "generated", "required": true }, { "key": "storage_confirmation", "title": "Storage provider confirmation", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "auditor", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "records_policy", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. No filing is made", "form": "None filed", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "uk_summary_location_missing", "type": null, "when": "[requirement_error] records_location is outside_uk and no UK location holds the accounts and returns." }, { "code": "stock_records_missing", "type": null, "when": "[requirement_error] deals_in_goods is true but stock records are not confirmed." }, { "code": "responsible_officer_not_director", "type": null, "when": "[requirement_error] The named person is not a current director." } ] } }, "Params_uk_accounts_filing_extension_apply": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "accounts_period_end": { "type": "string", "format": "date", "description": "End of the accounting reference period the accounts cover." }, "reason_category": { "type": "string", "enum": [ "illness", "fire_or_destruction_of_records", "other_event_outside_control" ], "description": "The event." }, "event_date": { "type": "string", "format": "date", "description": "When the event happened." }, "reason_description": { "type": "string", "description": "What happened, when, why it stops the company filing on time, and what the company has done since." }, "requested_new_deadline": { "type": "string", "format": "date", "description": "The date by which the company says it can file." }, "supporting_documents": { "type": "array", "items": {}, "description": "Document ids with purpose extension_evidence." } }, "required": [ "accounts_period_end", "reason_category", "event_date", "reason_description", "requested_new_deadline" ], "description": "Asks Companies House to extend the accounts filing deadline because of an event outside the company's control, such as a serious illness or a fire that destroyed the records." }, "Create_uk_accounts_filing_extension_apply": { "type": "object", "properties": { "type": { "const": "uk.accounts_filing_extension.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_accounts_filing_extension_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to Companies House for more time to file accounts", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_application_record", "title": "Copy of the application as submitted", "source": "generated", "required": true }, { "key": "decision_notice", "title": "Companies House decision", "source": "registry_issued", "required": true }, { "key": "companies_house_application", "title": "Companies house application", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_application_record", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Online service: Apply to extend your accounts filing deadline", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_passed", "type": null, "when": "requirement_error." }, { "code": "exceeds_twelve_month_cap", "type": null, "when": "invalid_request_error. requested_new_deadline is later than 12 months after accounts_period_end." }, { "code": "director_confirmation_missing", "type": null, "when": "requirement_error." } ] } }, "Params_uk_annual_accounts_file": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date", "description": "First day of the accounting period." }, "period_end": { "type": "string", "format": "date", "description": "Accounting reference date: last day of the period.", "examples": [ "2026-03-31" ] }, "accounts_type": { "type": "string", "enum": [ "micro_entity", "small", "medium", "large" ], "description": "Size regime." }, "accounting_framework": { "type": "string", "enum": [ "frs_105", "frs_102_section_1a", "frs_102", "uk_adopted_ifrs" ], "description": "The framework the accounts follow." }, "audit_status": { "type": "string", "enum": [ "audited", "exempt_small_company", "exempt_micro_entity", "exempt_subsidiary", "exempt_other" ], "description": "Whether the accounts are audited or the basis of exemption." }, "accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "The accounts package: iXBRL from accounting software, or a PDF for Entiva's tagging service where the accounts type allows." }, "approval_date": { "type": "string", "format": "date", "description": "Date the board approved the accounts and the balance sheet was signed." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "The director who signs the balance sheet on behalf of the board." }, "abridged": { "type": "boolean", "description": "File abridged accounts." }, "include_profit_and_loss": { "type": "boolean", "description": "Small companies and micro-entities may currently omit it; from 1 Apr 2028 they must deliver it." }, "cic_report_document_id": { "type": "string", "pattern": "^doc_", "description": "CIC34 community interest company report." }, "first_accounts": { "type": "boolean", "description": "True for the first accounts after incorporation." } }, "required": [ "period_start", "period_end", "accounts_type", "accounting_framework", "audit_status", "accounts_document_id", "approval_date", "signing_director" ], "description": "Files a private company's or CIC's annual accounts with Companies House as iXBRL through software filing, after the board has approved and a director has signed them. CICs also file the CIC34 report." }, "Create_uk_annual_accounts_file": { "type": "object", "properties": { "type": { "const": "uk.annual_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_uk_annual_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File annual accounts", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_accounts", "title": "Annual accounts: balance sheet, profit and loss account and notes", "source": "uploaded", "required": true }, { "key": "directors_report", "title": "Directors' report", "source": "uploaded", "required": true }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "cic34_report", "title": "CIC34 community interest company report", "source": "uploaded", "required": false }, { "key": "board_approval_minute", "title": "Board resolution approving the accounts", "source": "generated", "required": true }, { "key": "filing_acceptance", "title": "Companies House acceptance of the accounts", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_accounts", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_report", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_accounts", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Annual accounts in iXBRL", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "accounts_validation_failed", "type": null, "when": "[registry_error] The iXBRL or package fails Companies House validation." }, { "code": "auditor_report_missing", "type": null, "when": "[requirement_error] audit_status is audited and no auditor's report is uploaded." }, { "code": "cic34_report_missing", "type": null, "when": "[requirement_error] The entity is a CIC and no CIC34 report is provided." }, { "code": "dormant_company_other_action", "type": null, "when": "[invalid_request_error] The company is dormant." }, { "code": "unlimited_company_exempt", "type": null, "when": "[invalid_request_error] A qualifying unlimited company is exempt from delivering accounts." }, { "code": "accounts_not_signed", "type": null, "when": "[requirement_error] The balance sheet or directors' report is unsigned, or the signatory's name is missing." }, { "code": "abridged_not_allowed", "type": null, "when": "[invalid_request_error] abridged is true and the filing date is on or after 1 Apr 2028." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to sign as a director, secretary or auditor." } ] } }, "Params_uk_apostille_certify_and_legalise_document": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "source_document": { "type": "string", "pattern": "^doc_", "description": "The document to be signed or certified, uploaded or generated by Entiva." }, "document_kind": { "type": "string", "enum": [ "power_of_attorney", "board_resolution", "certificate_of_incumbency", "director_declaration", "bank_mandate", "contract", "certified_copy_of_id", "other" ], "description": "What the document is." }, "country_of_use": { "type": "string", "description": "ISO 3166 alpha-2 code of the country that will rely on the document." }, "certification_route": { "type": "string", "enum": [ "notary_remote_video", "notary_in_person", "solicitor_certified_copy" ], "description": "notary_remote_video: a notary in England and Wales certifies a remote signer." }, "apostille_format": { "type": "string", "enum": [ "e_apostille", "paper" ], "description": "e_apostille needs a PDF e-signed by a UK notary or solicitor. paper is £45." }, "service_level": { "type": "string", "enum": [ "standard", "next_day", "restricted_urgent" ], "description": "Paper only." }, "signers": { "type": "array", "items": {}, "description": "Everyone who signs the document: [{person: per_..., capacity, signing_country}]." }, "return_delivery": { "type": "object", "description": "Paper apostille only: {method: courier | post, recipient_name, phone, address}." }, "acknowledge_embassy_legalisation": { "type": "boolean", "description": "Set true when country_of_use is not an Apostille Convention party." } }, "required": [ "source_document", "document_kind", "country_of_use", "certification_route", "apostille_format", "signers" ], "description": "Takes a document the entity's officers or members sign and routes it through a partner UK notary or solicitor, who certifies the signature or the copy." }, "Create_uk_apostille_certify_and_legalise_document": { "type": "object", "properties": { "type": { "const": "uk.apostille.certify_and_legalise_document" }, "params": { "$ref": "#/components/schemas/Params_uk_apostille_certify_and_legalise_document" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notarise or certify a corporate document and apostille it", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "source_document", "title": "Document to be signed or certified", "source": "uploaded", "required": true }, { "key": "signed_source_document", "title": "Signed document", "source": "uploaded", "required": true }, { "key": "notarial_certificate", "title": "Notarial certificate or certification", "source": "generated", "required": true }, { "key": "fcdo_application_summary", "title": "FCDO application and order summary", "source": "generated", "required": true }, { "key": "fcdo_application", "title": "Fcdo application", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "signed_source_document", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "notarial_certificate", "signer_role": "lawyer", "method": "qualified_electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fcdo_application", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "FCDO Legalisation Office", "form": "FCDO online legalisation application", "channel": "both", "government_fee": { "amount": 35, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "remote_notarisation_not_available", "type": null, "when": "requirement_error. certification_route is notary_remote_video but the signer's country does not allow it, or the receiving country will not accept it, or the document is a deed by." }, { "code": "deed_needs_physical_witness", "type": null, "when": "requirement_error. document_kind is power_of_attorney or another deed by an individual and the route has no witness physically present." }, { "code": "signer_not_verified", "type": null, "when": "requirement_error." } ] } }, "Params_uk_apostille_registry_document_request": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "documents": { "type": "array", "items": {}, "description": "[{kind, copies, filing_reference}]. kind: certificate_of_incorporation or certified_copy_of_filing. filing_reference is required for certified_copy_of_filing." }, "country_of_use": { "type": "string", "description": "ISO 3166 alpha-2 code of the country that will rely on the document." }, "service_level": { "type": "string", "enum": [ "standard", "next_day", "restricted_urgent" ], "description": "Next-day and restricted urgent are for registered businesses only; restricted urgent needs FCDO pre-approval." }, "companies_house_delivery": { "type": "string", "enum": [ "standard", "same_day" ], "description": "Companies House turnaround for the certified copy: standard or same_day." }, "return_delivery": { "type": "object", "description": "{method: courier | post, recipient_name, phone, address}." }, "acknowledge_embassy_legalisation": { "type": "boolean", "description": "True if country_of_use is not an Apostille Convention party; the embassy may need to legalise afterwards, which this action does not do." } }, "required": [ "documents", "country_of_use", "return_delivery" ], "description": "Orders certified copies or certificates from Companies House and submits them to the FCDO Legalisation Office for an apostille, so the entity can prove its existence abroad. Public-registry documents are apostilled directly, with no notary." }, "Create_uk_apostille_registry_document_request": { "type": "object", "properties": { "type": { "const": "uk.apostille_registry_document.request" }, "params": { "$ref": "#/components/schemas/Params_uk_apostille_registry_document_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a Companies House document and have it apostilled", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "fcdo_application_summary", "title": "FCDO application and order summary", "source": "generated", "required": true }, { "key": "fcdo_application", "title": "Fcdo application", "source": "generated", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "fcdo_application", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "FCDO Legalisation Office", "form": "FCDO online legalisation application", "channel": "both", "government_fee": { "amount": 45, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "document_not_eligible", "type": null, "when": "requirement_error." }, { "code": "filing_reference_required", "type": null, "when": "invalid_request_error. kind is certified_copy_of_filing and no filing_reference is given." }, { "code": "embassy_legalisation_acknowledgement_required", "type": null, "when": "requirement_error. country_of_use is not an Apostille Convention party and acknowledge_embassy_legalisation is not true." } ] } }, "Params_uk_ccni_annual_monitoring_return_file": { "type": "object", "properties": { "ccni_charity_number": { "type": "string", "description": "The charity's number on the Northern Ireland register." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year the return covers." }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Gross income for the year." }, "amr_answers": { "type": "object", "description": "Answers to the online AMR form." }, "annual_accounts": { "type": "string", "pattern": "^doc_", "description": "The accounts, approved and signed." }, "trustees_annual_report": { "type": "string", "pattern": "^doc_", "description": "The trustees' annual report." }, "scrutiny_report": { "type": "string", "pattern": "^doc_", "description": "Independent examiner's or auditor's report, where required." } }, "required": [ "ccni_charity_number", "financial_year_end", "gross_income", "annual_accounts", "trustees_annual_report" ], "description": "Files the Annual Monitoring Return of a charitable company registered with the Charity Commission for Northern Ireland, within 10 months of the financial year end, with the accounts, the trustees' annual report and any independent." }, "Create_uk_ccni_annual_monitoring_return_file": { "type": "object", "properties": { "type": { "const": "uk.ccni_annual_monitoring_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_ccni_annual_monitoring_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Charity Commission for Northern Ireland annual monitoring return", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amr_draft", "title": "Draft Annual Monitoring Return", "source": "generated", "required": true }, { "key": "trustees_return_declaration", "title": "Trustees' confirmation of the return", "source": "generated", "required": true }, { "key": "annual_accounts", "title": "Annual accounts, approved and signed", "source": "uploaded", "required": true }, { "key": "trustees_annual_report", "title": "Trustees' annual report", "source": "uploaded", "required": true }, { "key": "scrutiny_report", "title": "Independent examiner's or auditor's report", "source": "uploaded", "required": false }, { "key": "regulator_submission", "title": "Regulator submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustees_return_declaration", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "annual_accounts", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "regulator_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for Northern Ireland", "form": "Annual Monitoring Return", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "regulator_access_missing", "type": null, "when": "requirement_error." }, { "code": "documents_missing", "type": null, "when": "requirement_error." }, { "code": "first_year_not_complete", "type": null, "when": "requirement_error." } ] } }, "Params_uk_certificate_of_incorporation_request": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "certificate_type": { "type": "string", "enum": [ "incorporation", "pflp_designation", "pflp_registration_and_designation" ], "description": "incorporation: certificate of incorporation. pflp_designation and pflp_registration_and_designation are for PFLPs only." }, "delivery_speed": { "type": "string", "enum": [ "standard", "same_day" ], "description": "standard: 22 GBP, dispatch targeted within ten working days. same_day: 65 GBP; orders before 11am ship that working day, later orders the next." }, "additional_copies": { "type": "integer", "description": "Extra copies of the same certificate, 16 GBP each, up to 10.", "examples": [ "2" ] }, "delivery_to": { "type": "string", "enum": [ "entiva_scan_and_forward", "direct_to_address" ], "description": "entiva_scan_and_forward: Entiva receives the paper certificate, scans it and forwards or holds it. direct_to_address: Companies House posts it to." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for direct_to_address." }, "purpose": { "type": "string", "enum": [ "bank_account", "foreign_registry", "litigation", "due_diligence", "other" ], "description": "Why the certificate is needed." }, "destination_country": { "type": "string", "description": "ISO 3166 country where the certificate will be used." }, "apostille": { "type": "object", "description": "{requested: boolean}." }, "include_register_status_summary": { "type": "boolean", "description": "Adds an Entiva-generated summary of the company's current status and filing position." } }, "required": [ "certificate_type", "delivery_speed", "delivery_to" ], "description": "Orders an official Companies House certificate in standard or same-day delivery, with extra copies and an optional paper apostille for use abroad." }, "Create_uk_certificate_of_incorporation_request": { "type": "object", "properties": { "type": { "const": "uk.certificate_of_incorporation.request" }, "params": { "$ref": "#/components/schemas/Params_uk_certificate_of_incorporation_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a certificate of incorporation or designation, with optional apostille", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "pflp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate", "title": "Companies House certificate", "source": "registry_issued", "required": true }, { "key": "register_status_summary", "title": "Entiva register status summary", "source": "generated", "required": false }, { "key": "apostille", "title": "FCDO apostille", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "certificate", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Certificate order. No numbered form", "channel": "online", "government_fee": { "amount": 22, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "certificate_type_not_available", "type": null, "when": "[invalid_request_error] pflp_* types for a non-PFLP entity." }, { "code": "apostille_needs_entiva_delivery", "type": null, "when": "[invalid_request_error] apostille.requested with direct_to_address." }, { "code": "non_hague_destination", "type": null, "when": "[requirement_error] The destination is not a Hague Convention state." }, { "code": "entity_dissolved_or_struck_off", "type": null, "when": "[requirement_error] The company is dissolved." } ] } }, "Params_uk_certified_copy_request": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "documents_requested": { "type": "array", "items": {}, "description": "[{filing_description, form_type, filing_date, pages}] pages up to 10 per certified copy." }, "copy_type": { "type": "string", "enum": [ "certified", "uncertified_email" ], "description": "certified: 22 GBP standard or 65 GBP same-day per document by post. uncertified_email: 3 GBP per document by email." }, "delivery_speed": { "type": "string", "enum": [ "standard", "same_day" ], "description": "For certified copies only." }, "delivery_to": { "type": "string", "enum": [ "entiva_scan_and_forward", "direct_to_address", "email" ], "description": "entiva_scan_and_forward, direct_to_address or email. apostille needs entiva_scan_and_forward." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for direct_to_address." }, "purpose": { "type": "string", "enum": [ "bank_account", "foreign_registry", "litigation", "due_diligence", "other" ], "description": "Why the copies are needed." }, "destination_country": { "type": "string", "description": "ISO 3166 country where the copies will be used." }, "apostille": { "type": "object", "description": "{requested: boolean}." } }, "required": [ "documents_requested", "copy_type" ], "description": "Orders certified copies of documents on a company's file, standard or same-day, or uncertified email copies, with optional paper apostille." }, "Create_uk_certified_copy_request": { "type": "object", "properties": { "type": { "const": "uk.certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_uk_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order certified copies of documents filed at Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_copy", "title": "Certified copy of each document", "source": "registry_issued", "required": true }, { "key": "apostille", "title": "FCDO apostille", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "certified_copy", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Certified copy order", "channel": "online", "government_fee": { "amount": 22, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "document_not_found", "type": null, "when": "[invalid_request_error] A requested document is not on the filing history." }, { "code": "page_limit_exceeded", "type": null, "when": "[invalid_request_error] A requested document exceeds 10 pages." }, { "code": "apostille_needs_entiva_delivery", "type": null, "when": "[invalid_request_error] apostille.requested with direct_to_address or email." }, { "code": "non_hague_destination", "type": null, "when": "[requirement_error] The destination is not a Hague Convention state." } ] } }, "Params_uk_charity_commission_annual_return_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "description": "Always england_wales." }, "charity_registration_number": { "type": "string", "description": "The registered charity number." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year the return covers." }, "total_income": { "$ref": "#/components/schemas/Money", "description": "Income for the year; it sets what the return needs." }, "total_spending": { "$ref": "#/components/schemas/Money", "description": "Spending for the year." }, "return_answers": { "type": "object", "description": "Answers keyed by the Commission's question ids for the year; Entiva pre-fills from the last return." }, "serious_incidents_confirmation": { "type": "boolean", "description": "Required when income is above £25,000: the trustees confirm all serious incidents have been reported." }, "trustees_annual_report": { "type": "string", "pattern": "^doc_", "description": "Required above £25,000." }, "annual_accounts": { "type": "string", "pattern": "^doc_", "description": "Required above £25,000." }, "scrutiny_report": { "type": "string", "pattern": "^doc_", "description": "Independent examiner's or auditor's report, where the accounts need one." } }, "required": [ "charity_registration_number", "financial_year_end", "total_income", "total_spending" ], "description": "Files the annual return of a charitable company registered in England and Wales with the Charity Commission, within 10 months of the financial year end." }, "Create_uk_charity_commission_annual_return_file": { "type": "object", "properties": { "type": { "const": "uk.charity_commission_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_charity_commission_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Charity Commission annual return", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "return_answers_draft", "title": "Draft annual return answers", "source": "generated", "required": true }, { "key": "trustees_return_declaration", "title": "Trustees' confirmation of the return", "source": "generated", "required": true }, { "key": "trustees_annual_report", "title": "Trustees' annual report", "source": "uploaded", "required": false }, { "key": "annual_accounts", "title": "Annual accounts, approved and signed", "source": "uploaded", "required": false }, { "key": "scrutiny_report", "title": "Independent examiner's or auditor's report", "source": "uploaded", "required": false }, { "key": "regulator_submission", "title": "Regulator submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustees_return_declaration", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "annual_accounts", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "regulator_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "Annual return", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "regulator_account_missing", "type": null, "when": "requirement_error." }, { "code": "documents_missing_for_income", "type": null, "when": "requirement_error." }, { "code": "serious_incident_confirmation_missing", "type": null, "when": "requirement_error." } ] } }, "Params_uk_cic_report_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's registration_jurisdiction." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end of the accounts the report accompanies.", "examples": [ "2026-03-31" ] }, "report_type": { "type": "string", "enum": [ "simplified", "detailed" ], "description": "simplified is used by most CICs. detailed is for CICs with more complex financial arrangements, such as performance-related interest on debt or debentures, or." }, "community_benefit_statement": { "type": "string", "description": "Accurate and fair account of how the CIC's activities in the year benefited the community.", "examples": [ "48 free coding workshops for 612 young people in Leeds." ] }, "stakeholder_consultation": { "type": "string", "description": "Steps taken in the year to consult people affected by the CIC's activities and the results." }, "directors_remuneration": { "type": "object", "description": "{in_accounts_notes: boolean, details?: string}." }, "asset_transfers": { "type": "array", "items": {}, "description": "Transfers of assets for less than full consideration in the year: [{recipient, asset_locked_body: boolean, amount: money, is_fair_estimate: boolean}]." }, "dividends": { "type": "object", "description": "Required when a dividend was declared or proposed for the year or declared in any of the four previous years: {per_share_current, history[]: {year." }, "accounts_package": { "type": "string", "pattern": "^doc_", "description": "Approved CIC annual accounts as an iXBRL package accounts ZIP." }, "linked_accounts_action": { "type": "string", "description": "act_ id of the Entiva action preparing the accounts, if any, so both submit as one package." }, "report_signatory": { "type": "string", "pattern": "^per_", "description": "Director who signs the CIC34." }, "report_date": { "type": "string", "format": "date", "description": "Date of the report." }, "company_authentication_code": { "type": "string", "description": "Write-only 6-character company authentication code." } }, "required": [ "financial_year_end", "report_type", "community_benefit_statement", "stakeholder_consultation", "directors_remuneration", "accounts_package", "report_signatory" ], "description": "Prepares, collects director approval of and files the Community Interest Company Report with the CIC's annual accounts as one online package. The 15 GBP report fee is passed through at cost." }, "Create_uk_cic_report_file": { "type": "object", "properties": { "type": { "const": "uk.cic_report.file" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual CIC report with a CIC's accounts", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cic_accounts_package", "title": "Approved CIC accounts", "source": "uploaded", "required": true }, { "key": "cic34_report", "title": "CIC34 community interest company report", "source": "generated", "required": true }, { "key": "board_approval", "title": "Board approval of the accounts and CIC report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance or rejection notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cic34_report", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cic_accounts_package", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cic_accounts_package", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "CIC34 Community Interest Company Report, filed with the accounts", "channel": "online", "government_fee": { "amount": 15, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "cic34_content_missing", "type": null, "when": "[requirement_error] Community benefit, consultation or remuneration section is empty." }, { "code": "report_date_mismatch", "type": null, "when": "[invalid_request_error] financial_year_end differs from the accounts package year end." }, { "code": "accounts_package_invalid", "type": null, "when": "[registry_error] Companies House rejects the ZIP, for example because it is not iXBRL-tagged." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] The signing director has no Companies House identity verification on record." }, { "code": "amended_accounts_not_filable_online", "type": null, "when": "[registry_error] Amended CIC accounts can only be filed on paper." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The deadline has passed." }, { "code": "wrong_entity_type", "type": null, "when": "[jurisdiction_error] The entity is not a CIC." } ] } }, "Params_uk_cio_annual_return_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "The last day of the financial year the return covers.", "examples": [ "2026-03-31" ] }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Gross income for the year." }, "accounts_scrutiny": { "type": "string", "enum": [ "none", "independent_examination", "audit" ], "description": "The scrutiny the accounts have had." }, "trustees_annual_report_document_id": { "type": "string", "pattern": "^doc_", "description": "The approved trustees' annual report." }, "accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "The approved accounts." }, "scrutiny_report_document_id": { "type": "string", "pattern": "^doc_", "description": "Independent examiner's or auditor's report." }, "serious_incidents_declared": { "type": "boolean", "description": "Declaration that all serious incidents were reported to the Commission first." }, "return_answers": { "type": "object", "description": "Answers to the annual return questions." }, "submitting_trustee": { "type": "string", "pattern": "^per_", "description": "The trustee who will submit using their own My Charity Commission account." } }, "required": [ "financial_year_end", "gross_income", "accounts_scrutiny", "trustees_annual_report_document_id", "accounts_document_id", "submitting_trustee" ], "description": "Prepares the trustees' annual report, accounts and annual return for a charitable incorporated organisation in England and Wales. A trustee submits it through their own My Charity Commission account, within 10 months of the financial year." }, "Create_uk_cio_annual_return_file": { "type": "object", "properties": { "type": { "const": "uk.cio_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_cio_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare and submit the Charity Commission annual return for a CIO", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "cio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustees_annual_report", "title": "Trustees' annual report", "source": "uploaded", "required": true }, { "key": "accounts", "title": "Accounts for the financial year", "source": "uploaded", "required": true }, { "key": "scrutiny_report", "title": "Independent examiner's or auditor's report", "source": "uploaded", "required": false }, { "key": "return_answers_pack", "title": "Prepared annual return answers and filing guide for the trustee", "source": "generated", "required": true }, { "key": "submission_confirmation", "title": "Charity Commission submission confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "trustee", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustees_annual_report", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "accounts", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "return_answers_pack", "signer_role": "trustee", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "Charity Commission annual return service, with the trustees' annual report, accounts and a", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "accounts_missing", "type": null, "when": "[requirement_error] The approved accounts or trustees' annual report are not uploaded." }, { "code": "scrutiny_report_missing", "type": null, "when": "[requirement_error] accounts_scrutiny is independent_examination or audit and no report is uploaded." }, { "code": "serious_incidents_declaration_missing", "type": null, "when": "[requirement_error] Income is above the Commission's threshold and the declaration is not given." }, { "code": "submission_pending_trustee", "type": null, "when": "[requirement_error] The trustee has not submitted the return in their Charity Commission account." }, { "code": "not_england_wales", "type": null, "when": "[jurisdiction_error] The CIO is not registered with the Charity Commission for England and Wales." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to sign as a trustee." } ] } }, "Params_uk_confirmation_statement_file": { "type": "object", "properties": { "confirmation_date": { "type": "string", "format": "date", "description": "The date up to which the information is confirmed.", "examples": [ "2026-10-31" ] }, "lawful_purpose_confirmed": { "type": "boolean", "description": "The company confirms its intended future activities are lawful." }, "director_verifications": { "type": "array", "items": {}, "description": "One item per current director: {person_id, personal_code}. personal_code is the 11-character Companies House code, write-only." }, "registered_email_address": { "type": "string", "description": "Needed only when the company has not yet given a registered email address." }, "sic_codes": { "type": "array", "items": {}, "description": "Up to four SIC codes, if the nature of business changed." }, "statement_of_capital": { "type": "object", "description": "{currency, classes[]: {class_name, number_of_shares, nominal_value, amount_unpaid, rights_summary}}." }, "shareholder_information": { "type": "array", "items": {}, "description": "Optional [{name, class, shares_held}]." }, "traded_company_status": { "type": "object", "description": "Optional {shares_admitted_to_trading: boolean, market: string, psc_exempt: boolean} for companies whose shares are traded." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's value." } }, "required": [ "confirmation_date", "lawful_purpose_confirmed", "director_verifications" ], "description": "Files the CS01 for a private company, PLC or CIC, confirming the register is correct, the company's intended activities are lawful and every director has verified their identity. Due within 14 days after each 12-month review period." }, "Create_uk_confirmation_statement_file": { "type": "object", "properties": { "type": { "const": "uk.confirmation_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_confirmation_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a confirmation statement", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "confirmation_statement_draft", "title": "Draft confirmation statement with the register data to be confirmed", "source": "generated", "required": true }, { "key": "register_of_members_extract", "title": "Register of members extract", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies House acceptance of the confirmation statement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "confirmation_statement_draft", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "confirmation_statement_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "confirmation_statement_draft", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "CS01", "channel": "online", "government_fee": { "amount": 50, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_not_verified", "type": null, "when": "[requirement_error] At least one director has not completed Companies House identity verification." }, { "code": "pending_changes_unfiled", "type": null, "when": "[requirement_error] Officer, PSC, registered office or registered email changes have not yet been filed." }, { "code": "lawful_purpose_not_confirmed", "type": null, "when": "[requirement_error] lawful_purpose_confirmed is false or the director's consent is outstanding." }, { "code": "invalid_confirmation_date", "type": null, "when": "[invalid_request_error] confirmation_date is before the last confirmation date or after the review period end." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to give the director's click_consent." }, { "code": "authentication_invalid", "type": null, "when": "[registry_error] The company authentication code or presenter credentials are rejected." }, { "code": "restoration_requires_paper_cs01", "type": null, "when": "[jurisdiction_error] The company was restored after strike-off." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the filing." } ] } }, "Params_uk_corporation_tax_pay": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "accounting_period_start": { "type": "string", "format": "date", "description": "Start of the period the payment covers." }, "accounting_period_end": { "type": "string", "format": "date", "description": "End of the period the payment covers." }, "amount_due": { "$ref": "#/components/schemas/Money", "description": "{amount, currency}." }, "payment_schedule": { "type": "string", "enum": [ "single", "instalment" ] }, "instalment_due_date": { "type": "string", "format": "date", "description": "Required for instalment." }, "payment_reference": { "type": "string", "description": "The 17-character Corporation Tax payment reference for this period." }, "payment_method": { "type": "string", "enum": [ "faster_payments", "chaps", "debit_or_corporate_card", "bacs", "direct_debit", "at_bank" ], "description": "How the company pays. faster_payments, chaps and debit_or_corporate_card are same or next day. bacs and an existing direct_debit take 3 working days; a new." }, "linked_return_action": { "type": "string", "description": "act_ id of the uk.corporation_tax_return.file action." }, "payment_evidence": { "type": "string", "pattern": "^doc_", "description": "Bank confirmation uploaded after payment so the action can complete." } }, "required": [ "accounting_period_start", "accounting_period_end", "amount_due", "payment_schedule", "payment_method" ], "description": "Prepares the payment instruction and 17-character HMRC reference, diarises the due date and tracks the company's payment. Entiva does not pay the tax from its own funds." }, "Create_uk_corporation_tax_pay": { "type": "object", "properties": { "type": { "const": "uk.corporation_tax.pay" }, "params": { "$ref": "#/components/schemas/Params_uk_corporation_tax_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Arrange payment of Corporation Tax", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_instruction", "title": "Payment instruction with HMRC reference and pay-by date", "source": "generated", "required": true }, { "key": "payment_evidence", "title": "Bank confirmation of payment", "source": "uploaded", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "payment_instruction", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "Payment with the 17-character Corporation Tax reference. No return form", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "payment_reference_invalid", "type": null, "when": "[requirement_error] The reference is not 17 characters or does not match the period." }, { "code": "amount_mismatch", "type": null, "when": "[requirement_error] amount_due differs from the CT600 tax chargeable." }, { "code": "pay_by_date_missed", "type": null, "when": "[requirement_error] The due date has passed." }, { "code": "spending_limit_exceeded", "type": null, "when": "[permission_error] The amount is above the mandate spending limit." }, { "code": "payment_method_too_slow", "type": null, "when": "[invalid_request_error] The chosen method cannot arrive before the due date." } ] } }, "Params_uk_corporation_tax_return_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "accounting_period_start": { "type": "string", "format": "date", "description": "Start of the Corporation Tax accounting period.", "examples": [ "2025-04-01" ] }, "accounting_period_end": { "type": "string", "format": "date", "description": "End of the period.", "examples": [ "2026-03-31" ] }, "utr": { "type": "string", "description": "10-digit Corporation Tax Unique Taxpayer Reference." }, "return_type": { "type": "string", "enum": [ "original", "amended" ], "description": "original or amended." }, "hmrc_notice_reference": { "type": "string", "description": "Reference of HMRC's notice to deliver a Company Tax Return, if received." }, "nil_or_dormant_return": { "type": "boolean", "description": "True for a nil return, including a dormant company that still received a notice." }, "close_company": { "type": "boolean", "description": "Whether the company is a close company." }, "profits_band": { "type": "string", "enum": [ "up_to_1_5m", "over_1_5m_to_20m", "over_20m" ], "description": "Drives the payment schedule: profits up to 1.5 million GBP pay once; above that, instalments." }, "supplementary_pages": { "type": "array", "items": {}, "description": "CT600 supplementary pages to include, as strings, for example CT600A or CT600C." }, "taxable_total_profits": { "$ref": "#/components/schemas/Money", "description": "{amount, currency}." }, "corporation_tax_chargeable": { "$ref": "#/components/schemas/Money", "description": "{amount, currency}." }, "accounts_ixbrl": { "type": "string", "pattern": "^doc_", "description": "Accounts in iXBRL." }, "computations_ixbrl": { "type": "string", "pattern": "^doc_", "description": "Tax computations in iXBRL." }, "declaration_signatory": { "type": "string", "pattern": "^per_", "description": "Authorised officer who approves the return and the declaration that it is correct and complete." }, "create_payment_action": { "type": "boolean", "description": "Default true." } }, "required": [ "accounting_period_start", "accounting_period_end", "utr", "return_type", "profits_band", "taxable_total_profits", "corporation_tax_chargeable", "accounts_ixbrl", "computations_ixbrl", "declaration_signatory" ], "description": "Files the CT600 with iXBRL accounts and computations as HMRC-authorised tax agent after an authorised officer approves the return. Optionally opens the payment action." }, "Create_uk_corporation_tax_return_file": { "type": "object", "properties": { "type": { "const": "uk.corporation_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_corporation_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Company Tax Return with HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "accounts_ixbrl", "title": "Accounts in iXBRL", "source": "uploaded", "required": true }, { "key": "computations_ixbrl", "title": "Tax computations in iXBRL", "source": "uploaded", "required": true }, { "key": "ct600_draft", "title": "CT600 for approval", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "Record of the client's HMRC agent authorisation", "source": "generated", "required": true }, { "key": "hmrc_notice_to_deliver", "title": "HMRC notice to deliver a Company Tax Return", "source": "uploaded", "required": false }, { "key": "hmrc_submission_receipt", "title": "HMRC submission receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "hmrc_agent_authorisation", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ct600_draft", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ct600_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "CT600 Company Tax Return, with iXBRL accounts and computations", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] The client has not authorised Entiva through Online Agent Authorisation or form 64-8." }, { "code": "ixbrl_validation_failed", "type": null, "when": "[registry_error] HMRC rejects the accounts or computations tagging." }, { "code": "figures_mismatch", "type": null, "when": "[requirement_error] taxable_total_profits or corporation_tax_chargeable differs from the computations." }, { "code": "accounting_period_invalid", "type": null, "when": "[invalid_request_error] The period is longer than 12 months or overlaps a filed period." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The 12-month deadline has passed." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to give the HMRC authorisation code or the officer's attestation." } ] } }, "Params_uk_data_protection_fee_pay": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "registration_type": { "type": "string", "enum": [ "new", "renewal" ], "description": "new for the first registration, renewal for a later charge period." }, "ico_registration_number": { "type": "string", "description": "Required for renewal." }, "charge_period_start": { "type": "string", "format": "date", "description": "First day of the 12-month charge period." }, "annual_turnover": { "$ref": "#/components/schemas/Money", "description": "Turnover for the tier test." }, "staff_count": { "type": "integer", "description": "Number of staff for the tier test." }, "is_charity": { "type": "boolean", "description": "Charities are in tier 1 whatever their size." }, "is_public_authority": { "type": "boolean", "description": "Public authorities skip the turnover test." }, "tier": { "type": "string", "enum": [ "tier_1", "tier_2", "tier_3" ], "description": "Optional cross-check." }, "payment_method": { "type": "string", "enum": [ "card", "direct_debit" ], "description": "card or direct_debit." }, "exempt_processing_claim": { "type": "boolean", "description": "True if all of the entity's processing is exempt processing under the Schedule to SI 2018/480." }, "exempt_processing_basis": { "type": "array", "items": {}, "description": "Required if exempt_processing_claim is true: non_automated, staff_volunteer_contractor_administration, advertising_marketing_pr, accounts_and_records." } }, "required": [ "registration_type", "charge_period_start", "annual_turnover", "staff_count" ], "description": "Registers the entity as a fee payer with the Information Commissioner's Office, or renews the registration, and pays the annual data protection fee for one 12-month charge period." }, "Create_uk_data_protection_fee_pay": { "type": "object", "properties": { "type": { "const": "uk.data_protection_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_uk_data_protection_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the ICO data protection fee", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company", "general_partnership", "scottish_qualifying_partnership", "charitable_company", "cio", "scio", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "tier_calculation_worksheet", "title": "Tier calculation worksheet", "source": "generated", "required": true }, { "key": "ico_payment_confirmation", "title": "ICO payment confirmation", "source": "registry_issued", "required": true }, { "key": "direct_debit_mandate", "title": "Direct debit mandate", "source": "generated", "required": true }, { "key": "exemption_confirmation", "title": "Exemption confirmation", "source": "generated", "required": true }, { "key": "ico_payment", "title": "Ico payment", "source": "generated", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tier_calculation_worksheet", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "direct_debit_mandate", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ico_payment", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Information Commissioner's Office", "form": "Data protection fee registration or renewal and payment", "channel": "online", "government_fee": { "amount": 52, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "registration_number_required", "type": null, "when": "invalid_request_error. registration_type is renewal and ico_registration_number is empty." }, { "code": "tier_mismatch", "type": null, "when": "requirement_error. tier is given and differs from the tier Entiva computes from the figures." }, { "code": "exemption_requires_confirmation", "type": null, "when": "requirement_error. exempt_processing_claim is true and no person has given the exemption confirmation." } ] } }, "Params_uk_dormant_accounts_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "financial_year_end": { "type": "string", "format": "date", "description": "Accounting reference date the accounts are made up to.", "examples": [ "2026-03-31" ] }, "dormant_throughout_period": { "type": "boolean", "description": "Must be true: no significant accounting transactions in the period." }, "dormant_since_formation": { "type": "boolean", "description": "True if dormant since incorporation." }, "dormant_since_previous_year_end": { "type": "boolean", "description": "True if dormant since the previous year end." }, "qualifies_as_small": { "type": "boolean", "description": "At least two of: turnover up to 15 million GBP, balance sheet total up to 7.5 million GBP, up to 50 employees." }, "members_have_not_required_audit": { "type": "boolean", "description": "Statement that the members have not required the company to obtain an audit." }, "balance_sheet": { "type": "object", "description": "{called_up_share_capital_not_paid?, total_assets, total_liabilities, net_assets, prior_year_comparatives} in the company's currency." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Director who signs the balance sheet for the board and whose printed name appears on it." }, "first_accounts": { "type": "boolean", "description": "True for a first set of accounts covering more than 12 months." }, "company_authentication_code": { "type": "string", "description": "Write-only." } }, "required": [ "financial_year_end", "dormant_throughout_period", "dormant_since_formation", "qualifies_as_small", "members_have_not_required_audit", "balance_sheet", "signatory" ], "description": "Prepares and files dormant company accounts for a company that had no significant accounting transactions in the year. Includes the dormancy and audit-exemption statements above the director's signature." }, "Create_uk_dormant_accounts_file": { "type": "object", "properties": { "type": { "const": "uk.dormant_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_uk_dormant_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File dormant company accounts with Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dormant_accounts", "title": "Dormant company accounts", "source": "generated", "required": true }, { "key": "board_approval", "title": "Board approval", "source": "generated", "required": true }, { "key": "cic_report", "title": "CIC34 report", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies House acceptance or rejection notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dormant_accounts", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dormant_accounts", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Dormant company accounts. Paper AA02 only for a company dormant since incorporation", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_dormant", "type": null, "when": "[requirement_error] A significant accounting transaction occurred, so dormant accounts cannot be used." }, { "code": "audit_exemption_not_available", "type": null, "when": "[requirement_error] Neither dormant since formation nor dormant since the previous year end with small company status." }, { "code": "aa02_not_suitable", "type": null, "when": "[requirement_error] A paper route was asked for but the company has traded or is a subsidiary." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The deadline has passed." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] The signing director has no Companies House identity verification." } ] } }, "Params_uk_gender_pay_gap_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "snapshot_date": { "type": "string", "format": "date", "description": "5 April of the reporting year for private and voluntary-sector employers." }, "employee_headcount": { "type": "integer", "description": "Employees on the snapshot date, counted as individuals; agency workers excluded." }, "voluntary": { "type": "boolean", "description": "True if the employer has fewer than 250 employees and reports anyway." }, "calculation_source": { "type": "string", "enum": [ "customer_supplied", "entiva_calculated" ], "description": "customer_supplied gives the figures; entiva_calculated works them out from payroll_extract." }, "payroll_extract": { "type": "string", "pattern": "^doc_", "description": "Required for entiva_calculated." }, "figures": { "type": "object", "description": "For customer_supplied: {mean_hourly_pay_gap_percent, median_hourly_pay_gap_percent, mean_bonus_gap_percent, median_bonus_gap_percent, bonus_proportion." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Signs the accuracy statement (reg 14): a director, LLP designated member, general partner, partner, governing-body member or senior officer, else the most." }, "signatory_job_title": { "type": "string", "description": "Published with the signatory's name." }, "employer_website_url": { "type": "string", "description": "Page on the employer's own website where the figures and the signed statement are published." } }, "required": [ "snapshot_date", "employee_headcount", "calculation_source", "signatory", "signatory_job_title", "employer_website_url" ], "description": "Reports an employer's gender pay gap to the government gender pay gap service and publishes the figures and a signed statement of accuracy on the employer's own website. It applies to an employer with 250 or more employees on the 5 April." }, "Create_uk_gender_pay_gap_file": { "type": "object", "properties": { "type": { "const": "uk.gender_pay_gap.file" }, "params": { "$ref": "#/components/schemas/Params_uk_gender_pay_gap_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report and publish the gender pay gap", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company", "cio", "scio", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payroll_extract", "title": "Payroll extract for the snapshot period", "source": "uploaded", "required": false }, { "key": "calculation_workings", "title": "Calculation workings", "source": "generated", "required": true }, { "key": "written_statement", "title": "Written statement of accuracy", "source": "generated", "required": true }, { "key": "website_publication_evidence", "title": "Evidence of website publication", "source": "uploaded", "required": true }, { "key": "gpg_service_submission", "title": "Gpg service submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "written_statement", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gpg_service_submission", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "GOV.UK gender pay gap service", "form": "Gender pay gap report entered in the online service, plus the figures and signed written s", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "figures_inconsistent", "type": null, "when": "invalid_request_error." }, { "code": "signatory_not_eligible", "type": null, "when": "requirement_error." }, { "code": "below_reporting_threshold", "type": null, "when": "requirement_error. employee_headcount is under 250 and voluntary is not true." } ] } }, "Params_uk_hmrc_dormancy_cease": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "utr": { "type": "string", "description": "10-digit Corporation Tax UTR." }, "activity_start_date": { "type": "string", "format": "date", "description": "Date the company restarted business activities." }, "activity_type": { "type": "string", "enum": [ "trading", "investment_income", "property_rental", "other" ], "description": "What made the company active." }, "keep_accounting_reference_date": { "type": "boolean", "description": "Default true." }, "vat_registration_needed": { "type": "boolean", "description": "Raises a task if VAT registration or reactivation is needed." }, "will_employ_staff": { "type": "boolean", "description": "Raises a PAYE task." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director who declares the company is active again." } }, "required": [ "utr", "activity_start_date", "activity_type", "declarant" ], "description": "Re-registers a restarted company for Corporation Tax with HMRC and opens the first return, payment and accounts deadlines for the new accounting period." }, "Create_uk_hmrc_dormancy_cease": { "type": "object", "properties": { "type": { "const": "uk.hmrc_dormancy.cease" }, "params": { "$ref": "#/components/schemas/Params_uk_hmrc_dormancy_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Tell HMRC a dormant company has restarted", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restart_declaration", "title": "Declaration that the company has restarted", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "Record of the client's HMRC agent authorisation", "source": "generated", "required": true }, { "key": "hmrc_receipt", "title": "HMRC confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "restart_declaration", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "restart_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "HMRC", "form": "Re-registration for Corporation Tax", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_currently_dormant", "type": null, "when": "[requirement_error] HMRC has no dormancy on record for this UTR." }, { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] The client has not authorised Entiva as tax agent." }, { "code": "notification_late", "type": null, "when": "[requirement_error] More than 3 months have passed since the accounting period began." } ] } }, "Params_uk_hmrc_dormancy_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "utr": { "type": "string", "description": "10-digit Corporation Tax UTR." }, "ever_traded": { "type": "boolean", "description": "Whether the company ever traded." }, "date_stopped_trading": { "type": "string", "format": "date", "description": "Date the company stopped trading." }, "confirm_no_trade_and_no_other_income": { "type": "boolean", "description": "Must be true." }, "dormant_from": { "type": "string", "format": "date", "description": "Date from which the company is dormant." }, "notice_to_deliver_received": { "type": "boolean", "description": "True if HMRC issued a notice to deliver a Company Tax Return or a return was filed." }, "vat_registered": { "type": "boolean", "description": "If true Entiva raises a task: nil VAT returns while dormant if trading will restart, or deregister within 30 days if not." }, "employs_staff": { "type": "boolean", "description": "If true Entiva raises a task to close the PAYE scheme if trading will not restart this tax year." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director who declares the company is dormant." } }, "required": [ "utr", "ever_traded", "confirm_no_trade_and_no_other_income", "dormant_from", "declarant" ], "description": "Reports to HMRC, as the company's tax agent, that the company has stopped trading and has no other income, so it need not pay Corporation Tax or file further returns unless HMRC asks." }, "Create_uk_hmrc_dormancy_notify": { "type": "object", "properties": { "type": { "const": "uk.hmrc_dormancy.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_hmrc_dormancy_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Tell HMRC a company is dormant for Corporation Tax", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dormancy_declaration", "title": "Declaration that the company is dormant for Corporation Tax", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "Record of the client's HMRC agent authorisation", "source": "generated", "required": true }, { "key": "hmrc_dormancy_letter", "title": "HMRC letter treating the company as dormant", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dormancy_declaration", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "hmrc_agent_authorisation", "signer_role": "officer", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dormancy_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "HMRC", "form": "HMRC online dormancy notification. No numbered form on the pages read", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_dormant", "type": null, "when": "[requirement_error] The company has income such as interest, rent or other investment income." }, { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] The client has not authorised Entiva as tax agent." }, { "code": "return_still_required", "type": null, "when": "[requirement_error] A notice to deliver was received; the return must be filed first." }, { "code": "excluded_body_type", "type": null, "when": "[jurisdiction_error] The entity is of a kind HMRC does not treat as dormant." } ] } }, "Params_uk_llp_annual_accounts_file": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date", "description": "First day of the accounting period." }, "period_end": { "type": "string", "format": "date", "description": "Accounting reference date.", "examples": [ "2026-03-31" ] }, "accounts_type": { "type": "string", "enum": [ "micro_entity", "small", "medium", "large" ], "description": "Size regime." }, "accounting_framework": { "type": "string", "enum": [ "frs_105", "frs_102_section_1a", "frs_102", "uk_adopted_ifrs" ], "description": "The framework the accounts follow." }, "audit_status": { "type": "string", "enum": [ "audited", "exempt_small", "exempt_micro", "exempt_other" ], "description": "Whether the accounts are audited or the basis of exemption." }, "accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "The accounts package: iXBRL, or PDF for tagging." }, "approval_date": { "type": "string", "format": "date", "description": "Date the members approved the accounts." }, "signing_designated_member": { "type": "string", "pattern": "^per_", "description": "The designated member who signs on behalf of the members." }, "first_accounts": { "type": "boolean", "description": "True for first accounts: 21 months after incorporation, or 3 months after the accounting reference date if later." } }, "required": [ "period_start", "period_end", "accounts_type", "accounting_framework", "audit_status", "accounts_document_id", "approval_date", "signing_designated_member" ], "description": "Files an LLP's annual accounts with Companies House as iXBRL through software filing, after the members have approved them and a designated member has signed. Due 9 months after the year end." }, "Create_uk_llp_annual_accounts_file": { "type": "object", "properties": { "type": { "const": "uk.llp_annual_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_uk_llp_annual_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File annual accounts", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_accounts", "title": "LLP annual accounts", "source": "uploaded", "required": true }, { "key": "members_report", "title": "Members' report", "source": "uploaded", "required": false }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "members_approval_record", "title": "Members' resolution approving the accounts", "source": "generated", "required": true }, { "key": "filing_acceptance", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_accounts", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_approval_record", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "annual_accounts", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LLP accounts in iXBRL", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_report_missing", "type": null, "when": "[requirement_error] audit_status is audited and no auditor's report is uploaded." }, { "code": "accounts_validation_failed", "type": null, "when": "[registry_error] The iXBRL package fails Companies House validation." }, { "code": "accounts_not_signed", "type": null, "when": "[requirement_error] The designated member has not signed." }, { "code": "dormant_llp_other_action", "type": null, "when": "[invalid_request_error] The LLP is dormant." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to sign as a designated member or auditor." } ] } }, "Params_uk_llp_confirmation_statement_file": { "type": "object", "properties": { "confirmation_date": { "type": "string", "format": "date", "description": "The date up to which the information is confirmed, no later than the last day of the review period." }, "member_verifications": { "type": "array", "items": {}, "description": "One item per current individual member: {person_id, personal_code}. personal_code is write-only; Entiva pre-fills from the vault." }, "lawful_purpose_confirmed": { "type": "boolean", "description": "The LLP confirms its intended future activities are lawful." }, "registered_email_address": { "type": "string", "description": "Needed only if the LLP has not yet given one." }, "sic_codes": { "type": "array", "items": {}, "description": "Optional update to the LLP's SIC codes." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's value." } }, "required": [ "confirmation_date", "member_verifications", "lawful_purpose_confirmed" ], "description": "Files the LL CS01 for an LLP, confirming its register data is current and that every individual member has verified their identity. Due within 14 days after each 12-month review period." }, "Create_uk_llp_confirmation_statement_file": { "type": "object", "properties": { "type": { "const": "uk.llp_confirmation_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_llp_confirmation_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a confirmation statement", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "confirmation_statement_draft", "title": "Draft LLP confirmation statement", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "confirmation_statement_draft", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "confirmation_statement_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "confirmation_statement_draft", "signer_role": "member", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LL CS01", "channel": "online", "government_fee": { "amount": 50, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "member_not_verified", "type": null, "when": "[requirement_error] An individual member has not completed Companies House identity verification." }, { "code": "pending_changes_unfiled", "type": null, "when": "[requirement_error] Member, PSC, registered office or email changes are not yet filed." }, { "code": "invalid_confirmation_date", "type": null, "when": "[invalid_request_error] confirmation_date is outside the review period." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to give the designated member's consent." }, { "code": "restoration_requires_paper_cs01", "type": null, "when": "[jurisdiction_error] The LLP was restored after strike-off." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the filing." } ] } }, "Params_uk_lp_principal_place_of_business_change": { "type": "object", "properties": { "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "The new principal place of business, inside the same part of the UK as the partnership's registrar.", "examples": [ "{\"line1\":\"3 Castle Terrace\",\"city\":\"Edinburgh\",\"postcode\":\"EH1 2EL\",\"country\":\"GB\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "The date the partnership's principal place of business changed." }, "signing_general_partner": { "type": "string", "pattern": "^per_", "description": "The general partner who approves and signs for the firm." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." } }, "required": [ "principal_place_of_business", "effective_date", "signing_general_partner" ], "description": "Notifies the registrar of a new principal place of business for an English, Welsh, Northern Irish or Scottish limited partnership on form LP6, within 7 days of the change." }, "Create_uk_lp_principal_place_of_business_change": { "type": "object", "properties": { "type": { "const": "uk.lp_principal_place_of_business.change" }, "params": { "$ref": "#/components/schemas/Params_uk_lp_principal_place_of_business_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a limited partnership's principal place of business", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_decision", "title": "General partners' decision approving the change", "source": "generated", "required": true }, { "key": "lp6_notice", "title": "LP6 statement of changes", "source": "generated", "required": true }, { "key": "register_update_confirmation", "title": "Updated record on the register", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "lp6_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partners_decision", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP6", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "outside_registrar_jurisdiction", "type": null, "when": "[jurisdiction_error] new_principal_place_of_business is in a different part of the UK from the partnership's registrar." }, { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is not an LP, PFLP or SLP." }, { "code": "general_partner_not_verified", "type": null, "when": "[requirement_error] The signing general partner has not completed identity_address verification." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key attempts a personal step." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registrar rejects the LP6." } ] } }, "Params_uk_mail_handling_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "address_role": { "type": "string", "enum": [ "registered_office", "service_address" ], "description": "Which address the rules cover: the entity's registered office, or a service address Entiva provides." }, "rules": { "type": "array", "items": {}, "description": "[{mail_class, handling, notify_within_hours, original_retention_days}]. mail_class: companies_house, hmrc, court_or_legal_process, regulator, bank, general." }, "notification_channels": { "type": "array", "items": {}, "description": "Where scans and alerts go: [{type: email | webhook, address}]." }, "forwarding_address": { "$ref": "#/components/schemas/Address", "description": "Default address for scan_and_forward_original." } }, "required": [ "address_role", "rules", "notification_channels" ], "description": "Sets how Entiva handles post that arrives at the Entiva-provided registered office or service address: which classes of mail are scanned, who is told and how fast, which originals are forwarded, held or destroyed, and for how long." }, "Create_uk_mail_handling_change": { "type": "object", "properties": { "type": { "const": "uk.mail_handling.change" }, "params": { "$ref": "#/components/schemas/Params_uk_mail_handling_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up statutory mail handling at the registered office", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "mail_handling_instructions", "title": "Mail handling instructions", "source": "generated", "required": true }, { "key": "authority_to_open_mail", "title": "Authority to open and handle company mail", "source": "generated", "required": true }, { "key": "address_service_terms", "title": "Registered office and address service terms", "source": "generated", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "authority_to_open_mail", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "address_service_terms", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None: this is an Entiva service configuration, not a registry filing", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_not_provided_by_entiva", "type": null, "when": "requirement_error." }, { "code": "rule_conflict", "type": null, "when": "invalid_request_error." }, { "code": "appropriate_address_not_met", "type": null, "when": "requirement_error." } ] } }, "Params_uk_oscr_annual_return_file": { "type": "object", "properties": { "oscr_charity_number": { "type": "string", "description": "The charity's OSCR registration number." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year the return covers." }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Gross income for the year." }, "accounts_type": { "type": "string", "enum": [ "receipts_and_payments", "accruals" ], "description": "Receipts and payments or fully accrued accounts, depending on income size, legal form and constitution wording." }, "external_scrutiny_type": { "type": "string", "enum": [ "audit", "independent_examination" ], "description": "The external scrutiny the accounts had." }, "trustees": { "type": "array", "items": {}, "description": "[{person, appointment_date}] for every trustee." }, "return_answers": { "type": "object", "description": "Answers to the OSCR online annual return questions." }, "trustees_annual_report": { "type": "string", "pattern": "^doc_", "description": "The trustees' annual report." }, "annual_accounts": { "type": "string", "pattern": "^doc_", "description": "The annual accounts, approved and signed." }, "external_scrutiny_report": { "type": "string", "pattern": "^doc_", "description": "The audit or independent examination report." } }, "required": [ "oscr_charity_number", "financial_year_end", "gross_income", "accounts_type", "external_scrutiny_type", "trustees", "trustees_annual_report", "annual_accounts", "external_scrutiny_report" ], "description": "Files the annual return of a Scottish charity through OSCR Online, within 9 months of the financial year end, with the annual accounts, the trustees' annual report and the external scrutiny report." }, "Create_uk_oscr_annual_return_file": { "type": "object", "properties": { "type": { "const": "uk.oscr_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_oscr_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the OSCR annual return", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "charitable_company", "scio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "return_answers_draft", "title": "Draft OSCR annual return", "source": "generated", "required": true }, { "key": "trustees_return_declaration", "title": "Trustees' confirmation of the return", "source": "generated", "required": true }, { "key": "trustees_annual_report", "title": "Trustees' annual report", "source": "uploaded", "required": true }, { "key": "annual_accounts", "title": "Annual accounts, approved and signed", "source": "uploaded", "required": true }, { "key": "external_scrutiny_report", "title": "External scrutiny report", "source": "uploaded", "required": true }, { "key": "regulator_submission", "title": "Regulator submission", "source": "generated", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustees_return_declaration", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "annual_accounts", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "regulator_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Office of the Scottish Charity Regulator", "form": "OSCR online annual return", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "regulator_account_missing", "type": null, "when": "requirement_error." }, { "code": "trustee_details_incomplete", "type": null, "when": "requirement_error." }, { "code": "documents_missing", "type": null, "when": "requirement_error." } ] } }, "Params_uk_overseas_company_accounts_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the establishment's jurisdiction." }, "accounting_reference_period_end": { "type": "string", "format": "date", "description": "End of the accounting reference period the accounts cover.", "examples": [ "2025-12-31" ] }, "disclosure_route": { "type": "string", "enum": [ "parent_law_disclosure", "no_parent_law_disclosure" ], "description": "parent_law_disclosure: parent law requires the company to prepare, audit and disclose accounts, so copies are filed within 3 months of the date they must be." }, "parent_law_disclosure_date": { "type": "string", "format": "date", "description": "Date the accounts must be disclosed under parent law." }, "governing_legislation": { "type": "string", "description": "Legislation under which the accounts were prepared." }, "accounts_follow_gaap": { "type": "boolean", "description": "Whether generally accepted accounting principles were followed." }, "gaap_description": { "type": "string", "description": "Name of the accounting framework, for example IFRS or US GAAP." }, "audit_status": { "type": "string", "enum": [ "audited", "unaudited" ], "description": "Audit status stated on OS AA01." }, "accounts_package": { "type": "string", "pattern": "^doc_", "description": "iXBRL-tagged package accounts ZIP." }, "translation_document": { "type": "string", "pattern": "^doc_", "description": "Certified English translation if the accounts are not in English." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Director who signed the balance sheet for the board." }, "filed_under_other_establishment": { "type": "string", "description": "Registered number of another UK establishment of the same company under which these accounts are filed." }, "company_authentication_code": { "type": "string", "description": "Write-only." } }, "required": [ "accounting_reference_period_end", "disclosure_route", "governing_legislation", "accounts_follow_gaap", "audit_status", "accounts_package" ], "description": "Files the overseas company's accounts for a registered UK establishment as package accounts with form OS AA01, on the parent-law or the 13-month route. The annual document processing fee is 50 GBP online." }, "Create_uk_overseas_company_accounts_file": { "type": "object", "properties": { "type": { "const": "uk.overseas_company_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_company_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File accounts of a UK establishment of an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "accounts_package", "title": "Accounts as iXBRL package accounts ZIP", "source": "uploaded", "required": true }, { "key": "parent_law_disclosure_evidence", "title": "Evidence of the parent-law disclosure date", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "board_approval", "title": "Board approval of the accounts", "source": "uploaded", "required": false }, { "key": "os_aa01", "title": "OS AA01 data sheet", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance or rejection notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "accounts_package", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "os_aa01", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS AA01 with iXBRL package accounts", "channel": "online", "government_fee": { "amount": 50, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "accounts_not_ixbrl", "type": null, "when": "[registry_error] The package is not iXBRL-tagged or not a ZIP." }, { "code": "disclosure_date_missing", "type": null, "when": "[requirement_error] parent_law_disclosure was chosen without parent_law_disclosure_date." }, { "code": "signatory_required", "type": null, "when": "[requirement_error] no_parent_law_disclosure was chosen and no director signatory is named." }, { "code": "authentication_code_invalid", "type": null, "when": "[registry_error] The company authentication code is wrong or was changed." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] The signing director has not completed Companies House identity verification." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The deadline has passed." } ] } }, "Params_uk_overseas_entity_change": { "type": "object", "properties": { "statement_date": { "type": "string", "format": "date", "description": "The date as at which the information is confirmed correct.", "examples": [ "2026-11-03" ] }, "no_changes_confirmed": { "type": "boolean", "description": "True if nothing has changed." }, "entity_details": { "type": "object", "description": "Changes to the entity's name, legal form, governing law, address, service address or email." }, "beneficial_owners": { "type": "array", "items": {}, "description": "[{person_id or entity_id, owner_type, natures_of_control[], start_date, ceased_date}]." }, "managing_officers": { "type": "array", "items": {}, "description": "[{person_id, role, start_date, ceased_date}]." }, "trust_information": { "type": "object", "description": "Trust name, creation date, parties and any changes." }, "verification_checks_date": { "type": "string", "format": "date", "description": "Date of the agent's verification checks." }, "verifying_agent": { "type": "string", "enum": [ "entiva", "licensed_partner", "other_uk_regulated_agent" ], "description": "Who verifies." }, "entity_authentication_code": { "type": "string", "description": "Write-only 6-character code sent to the entity's email on record." }, "contact": { "type": "object", "description": "{name, email} of the contact for the filing." } }, "required": [ "statement_date", "contact" ], "description": "Files the yearly overseas entity update statement on the Register of Overseas Entities, with fresh verification by a UK-regulated agent for any changed information, new beneficial owners and managing officers." }, "Create_uk_overseas_entity_change": { "type": "object", "properties": { "type": { "const": "uk.overseas_entity.change" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_entity_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual update statement for an overseas entity", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "roe_overseas_entity" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "update_statement_draft", "title": "Draft overseas entity update statement", "source": "generated", "required": true }, { "key": "verification_statement", "title": "Verification statement by the UK-regulated agent", "source": "generated", "required": false }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "trust_documents", "title": "Trust deed and deeds of appointment", "source": "uploaded", "required": false }, { "key": "filing_confirmation", "title": "Companies House confirmation of the update statement", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "settlor", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "update_statement_draft", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "verification_statement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "update_statement_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House, Register of Overseas Entities", "form": "Overseas entity update statement", "channel": "online", "government_fee": { "amount": 134, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "verification_stale", "type": null, "when": "[requirement_error] Verification checks are more than 3 months before statement_date." }, { "code": "protected_information_online_filing_unavailable", "type": null, "when": "[registry_error] A beneficial owner or managing officer has protected personal information, so online filing is unavailable." }, { "code": "no_beneficial_owner_or_officer", "type": null, "when": "[requirement_error] There is no active beneficial owner and no managing officer reported." }, { "code": "authentication_missing", "type": null, "when": "[requirement_error] The entity authentication code is missing or invalid." }, { "code": "sanctions_match", "type": null, "when": "[requirement_error] A beneficial owner screens as a confirmed match." }, { "code": "statement_overdue", "type": null, "when": "[requirement_error] statement_date is more than 14 days ago." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the statement." } ] } }, "Params_uk_overseas_entity_address_change": { "type": "object", "properties": { "filing_timing": { "type": "string", "enum": [ "file_now", "with_next_annual_update" ], "description": "file_now files an early update statement and pays its fee. with_next_annual_update records the change and merges it into the next uk.overseas_entity.update.", "examples": [ "file_now" ] }, "principal_address": { "$ref": "#/components/schemas/Address", "description": "New registered or principal address of the overseas entity." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "New service address of the entity." }, "email_address": { "type": "string", "description": "New email address." }, "effective_date": { "type": "string", "format": "date", "description": "Date the detail changed." }, "statement_date": { "type": "string", "format": "date", "description": "For file_now: the date the update statement confirms the register is correct." }, "entity_authentication_code": { "type": "string", "description": "Write-only 6-character code sent by Companies House to the entity's email on record." }, "contact": { "type": "object", "description": "{name, email} of the person Companies House contacts about this filing." } }, "required": [ "filing_timing", "effective_date" ], "description": "Updates the entity's address, service address or email on the ROE. No separate change form was found, so the change is made through an early overseas entity update statement, or held for the next annual update if the customer chooses." }, "Create_uk_overseas_entity_address_change": { "type": "object", "properties": { "type": { "const": "uk.overseas_entity_address.change" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_entity_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change an overseas entity's address, service address or email on the Register of Overseas Entities", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "roe_overseas_entity" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "entity_authority", "title": "Overseas entity's authority for the change", "source": "uploaded", "required": true }, { "key": "address_evidence", "title": "Evidence of the new address", "source": "uploaded", "required": false }, { "key": "verification_statement", "title": "Verification statement from the UK-regulated agent", "source": "generated", "required": true }, { "key": "update_statement_draft", "title": "Overseas entity update statement", "source": "generated", "required": true }, { "key": "filing_confirmation", "title": "Companies House confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "update_statement_draft", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "verification_statement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "update_statement_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House, Register of Overseas Entities", "form": "Overseas entity update statement", "channel": "online", "government_fee": { "amount": 134, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "verification_stale", "type": null, "when": "[requirement_error] The agent's verification checks are more than 3 months before statement_date." }, { "code": "protected_information_online_filing_unavailable", "type": null, "when": "[registry_error] A beneficial owner or managing officer has protected personal information, so the online service cannot be used." }, { "code": "authentication_missing", "type": null, "when": "[requirement_error] The entity authentication code is missing or invalid." }, { "code": "no_change_provided", "type": null, "when": "[invalid_request_error] None of principal_address, service_address or email_address is set." }, { "code": "sanctions_match", "type": null, "when": "[requirement_error] A beneficial owner screens as a confirmed match." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the statement." } ] } }, "Params_uk_partnership_accounts_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the partnership's jurisdiction. slp is Scotland only; lp is England and Wales or Northern Ireland." }, "delivery_route": { "type": "string", "enum": [ "append_to_member_accounts", "consolidated_exemption" ], "description": "append_to_member_accounts: the limited-company member attaches the partnership accounts to its own accounts. consolidated_exemption: no partnership accounts." }, "financial_year_start": { "type": "string", "format": "date", "description": "Start of the partnership's financial year." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year.", "examples": [ "2026-03-31" ] }, "corporate_members": { "type": "array", "items": {}, "description": "[{name, company_number, member_type: limited_company | unlimited_with_limited_company_members | overseas_equivalent, is_delivering_member: boolean}]." }, "delivering_member_company_number": { "type": "string", "description": "Limited-company member that attaches the accounts." }, "delivering_member_accounts_period_end": { "type": "string", "format": "date", "description": "Period end of the member's accounts that carry the attachment." }, "delivery_mode": { "type": "string", "enum": [ "entiva_files_member_accounts", "member_files_own_accounts" ], "description": "entiva_files_member_accounts when the delivering member is an Entiva-managed entity. member_files_own_accounts when it is not; Entiva then produces the." }, "accounts_regime": { "type": "string", "enum": [ "small", "large_and_medium" ], "description": "Companies Act regime applied under reg 4." }, "accounts_approval_date": { "type": "string", "format": "date", "description": "Date the members approved the accounts." }, "accounts_package": { "type": "string", "pattern": "^doc_", "description": "Partnership accounts stating they are prepared under regulation 4 (reg 4), in the format of the delivering member's filing." }, "auditors_report": { "type": "string", "pattern": "^doc_", "description": "Auditor's report (reg 4)." }, "head_office_address": { "$ref": "#/components/schemas/Address", "description": "Partnership head office where the accounts are available for free inspection in business hours." }, "consolidating_undertaking": { "type": "object", "description": "Required for consolidated_exemption: {name, registry_number, accounts_period_end, states_exemption_in_notes: boolean}." }, "translation_document": { "type": "string", "pattern": "^doc_", "description": "Certified English translation if the accounts are not in English." } }, "required": [ "delivery_route", "financial_year_start", "financial_year_end", "corporate_members" ], "description": "Prepares and delivers the audited accounts of a qualifying partnership by appending them to a corporate member's accounts, or records the group-accounts exemption. No separate government fee." }, "Create_uk_partnership_accounts_file": { "type": "object", "properties": { "type": { "const": "uk.partnership_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_uk_partnership_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deliver qualifying partnership accounts with a corporate member's accounts", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_accounts", "title": "Partnership accounts prepared under reg 4", "source": "uploaded", "required": false }, { "key": "auditors_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "group_accounts_reference", "title": "Group accounts that consolidate the partnership", "source": "uploaded", "required": false }, { "key": "attachment_pack", "title": "Attachment pack for the member's accounts filing", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies House acknowledgement of the member's accounts filing", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_accounts", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "attachment_pack", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "No separate form. The partnership accounts are attached to the corporate member's accounts", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_qualifying_partnership", "type": null, "when": "[requirement_error] A member is not a limited company or comparable body." }, { "code": "auditors_report_missing", "type": null, "when": "[requirement_error] No auditor's report is attached (reg 4)." }, { "code": "member_accounts_not_in_scope", "type": null, "when": "[requirement_error] delivery_mode is entiva_files_member_accounts but the member is not an Entiva-managed entity." }, { "code": "accounts_prepared_late", "type": null, "when": "[requirement_error] More than 9 months have passed since the financial year end." }, { "code": "exemption_conditions_not_met", "type": null, "when": "[requirement_error] The consolidating undertaking is not UK-established, or its group accounts are not audited and do not state the exemption." } ] } }, "Params_uk_partnership_tax_return_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction. slp is Scotland only." }, "tax_year": { "type": "string", "description": "Tax year of the return, for example 2025-26.", "examples": [ "2025-26" ] }, "partnership_utr": { "type": "string", "description": "10-digit partnership UTR." }, "nominated_partner": { "type": "string", "pattern": "^per_", "description": "The nominated partner who approves the return and its declaration." }, "return_type": { "type": "string", "enum": [ "original", "amended" ], "description": "original or amended." }, "accounting_date": { "type": "string", "format": "date", "description": "Partnership accounting date." }, "has_corporate_partner": { "type": "boolean", "description": "True if any partner is a limited company." }, "supplementary_pages": { "type": "array", "items": {}, "description": "Pages to file: SA800_PS, SA800_TP, SA801, SA802, SA803, SA804." }, "partners": { "type": "array", "items": {}, "description": "[{partner_ref, partner_utr, profit_share_percent, capital_share_percent, effective_dates}] for the partnership statement." }, "financial_data": { "type": "string", "pattern": "^doc_", "description": "Partnership accounts and computations." }, "total_partnership_profit_or_loss": { "$ref": "#/components/schemas/Money", "description": "{amount, currency}." } }, "required": [ "tax_year", "partnership_utr", "nominated_partner", "return_type", "supplementary_pages", "partners", "financial_data", "total_partnership_profit_or_loss" ], "description": "Files the SA800 and its supplementary pages as HMRC-authorised tax agent after the nominated partner approves. Each partner's own return is separate." }, "Create_uk_partnership_tax_return_file": { "type": "object", "properties": { "type": { "const": "uk.partnership_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_partnership_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Partnership Tax Return with HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "llp", "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_data", "title": "Partnership accounts and computations", "source": "uploaded", "required": true }, { "key": "partnership_statement", "title": "Partnership statement", "source": "generated", "required": true }, { "key": "sa800_draft", "title": "SA800 for approval", "source": "generated", "required": true }, { "key": "hmrc_agent_authorisation", "title": "Record of the client's HMRC agent authorisation", "source": "generated", "required": true }, { "key": "hmrc_submission_receipt", "title": "HMRC submission receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "hmrc_agent_authorisation", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sa800_draft", "signer_role": "partner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sa800_draft", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "SA800 Partnership Tax Return and supplementary pages", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] The nominated partner has not authorised Entiva as tax agent." }, { "code": "partner_share_total_invalid", "type": null, "when": "[requirement_error] Profit shares do not total 100%." }, { "code": "sa800_not_applicable", "type": null, "when": "[requirement_error] The partnership has income types SA800 does not cover; HMRC's form page limits SA800 to trading or professional income plus taxed interest and alternative." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] The deadline has passed." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to give the HMRC authorisation code or the nominated partner's attestation." } ] } }, "Params_uk_pension_declaration_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "declaration_type": { "type": "string", "enum": [ "initial", "re_declaration" ], "description": "initial: the first declaration. re_declaration: the three-yearly one after automatic re-enrolment." }, "duties_start_trigger": { "type": "string", "enum": [ "staging_date", "first_worker_started", "paye_income_first_payable" ], "description": "Initial only." }, "duties_start_date": { "type": "string", "format": "date", "description": "Initial only." }, "reenrolment_cycle_start": { "type": "string", "format": "date", "description": "Re-declaration only." }, "reenrolment_date": { "type": "string", "format": "date", "description": "Re-declaration only." }, "paye_schemes": { "type": "array", "items": {}, "description": "One item per PAYE scheme: [{paye_reference, employer_pension_scheme_reference}]." }, "contact_person": { "type": "object", "description": "Whoever submits: {name, phone, working_address, email, role}." }, "jobholders_enrolled": { "type": "integer", "description": "Jobholders automatically enrolled or re-enrolled." }, "enrolment_by_scheme": { "type": "array", "items": {}, "description": "[{scheme_name, provider_address, jobholders}] for each pension scheme used." }, "transitional_jobholders": { "type": "integer", "description": "Initial only." }, "workers_already_in_qualifying_scheme": { "type": "integer", "description": "Workers already active members of a qualifying scheme." }, "other_workers": { "type": "integer", "description": "Remaining workers not counted above." }, "section_30_jobholders": { "type": "integer", "description": "Re-declaration only." }, "declaration_correct_and_complete": { "type": "boolean", "description": "Must be true: the information is declared correct and complete." } }, "required": [ "declaration_type", "paye_schemes", "contact_person", "jobholders_enrolled", "enrolment_by_scheme", "workers_already_in_qualifying_scheme", "other_workers", "declaration_correct_and_complete" ], "description": "Files the declaration of compliance with The Pensions Regulator: the first one within 5 months of the start of the employer's duties, or the three-yearly re-declaration after automatic re-enrolment, which is due even if there is no one to." }, "Create_uk_pension_declaration_file": { "type": "object", "properties": { "type": { "const": "uk.pension_declaration.file" }, "params": { "$ref": "#/components/schemas/Params_uk_pension_declaration_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the workplace pension declaration of compliance", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "general_partnership", "foreign_company", "charitable_company", "cio", "scio", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "pension_enrolment_confirmation", "title": "Pension provider's enrolment confirmation", "source": "uploaded", "required": true }, { "key": "staff_assessment_summary", "title": "Payroll summary of the staff assessment", "source": "uploaded", "required": true }, { "key": "declaration_record", "title": "Copy of the declaration as submitted", "source": "generated", "required": true }, { "key": "tpr_submission", "title": "Tpr submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "declaration_record", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "tpr_submission", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "The Pensions Regulator", "form": "Declaration or re-declaration of compliance", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "counts_inconsistent", "type": null, "when": "invalid_request_error. enrolment_by_scheme does not add up to jobholders_enrolled, or a count is negative." }, { "code": "paye_scheme_not_found", "type": null, "when": "requirement_error." }, { "code": "deadline_passed", "type": null, "when": "requirement_error." } ] } }, "Params_uk_plc_annual_accounts_file": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date", "description": "First day of the accounting period." }, "period_end": { "type": "string", "format": "date", "description": "Accounting reference date.", "examples": [ "2026-03-31" ] }, "accounting_framework": { "type": "string", "enum": [ "frs_102", "uk_adopted_ifrs", "frs_101" ], "description": "The framework the accounts follow." }, "accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "Audited accounts package." }, "auditor_report_document_id": { "type": "string", "pattern": "^doc_", "description": "The signed auditor's report." }, "strategic_report_document_id": { "type": "string", "pattern": "^doc_", "description": "Strategic report." }, "directors_report_document_id": { "type": "string", "pattern": "^doc_", "description": "Directors' report signed by a director or the secretary." }, "approval_date": { "type": "string", "format": "date", "description": "Date the board approved the accounts and a director signed the balance sheet." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "Director who signs the balance sheet for the board." }, "accounts_meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting at which the accounts and reports are laid." }, "first_accounts": { "type": "boolean", "description": "True for the first accounts: the period is 18 months from incorporation or 3 months after the accounting reference date if later." } }, "required": [ "period_start", "period_end", "accounting_framework", "accounts_document_id", "auditor_report_document_id", "strategic_report_document_id", "directors_report_document_id", "approval_date", "signing_director", "accounts_meeting_date" ], "description": "Files a PLC's audited annual accounts and reports with Companies House, after board approval, the auditor's report and laying before a general meeting. Due 6 months after the accounting reference date, with a licensed auditor involved." }, "Create_uk_plc_annual_accounts_file": { "type": "object", "properties": { "type": { "const": "uk.plc_annual_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_uk_plc_annual_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File annual accounts", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_accounts", "title": "Audited annual accounts", "source": "uploaded", "required": true }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": true }, { "key": "strategic_report", "title": "Strategic report", "source": "uploaded", "required": true }, { "key": "directors_report", "title": "Directors' report", "source": "uploaded", "required": true }, { "key": "board_approval_minute", "title": "Board resolution approving the accounts", "source": "generated", "required": true }, { "key": "accounts_meeting_minute", "title": "Minutes of the general meeting at which accounts were laid", "source": "generated", "required": true }, { "key": "filing_acceptance", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "annual_accounts", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_report", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "accounts_meeting_minute", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "annual_accounts", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Audited annual accounts and reports in iXBRL", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_report_missing", "type": null, "when": "[requirement_error] No signed auditor's report is uploaded." }, { "code": "accounts_not_laid", "type": null, "when": "[requirement_error] accounts_meeting_date is missing or after the end of the filing period." }, { "code": "auditor_not_registered", "type": null, "when": "[requirement_error] The signing auditor cannot be matched to a registered statutory auditor." }, { "code": "accounts_validation_failed", "type": null, "when": "[registry_error] The iXBRL package fails Companies House validation." }, { "code": "fewer_than_two_directors", "type": null, "when": "[requirement_error] The PLC has fewer than two directors on the register." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to sign as a director, secretary or auditor." } ] } }, "Params_uk_psc_cease": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "psc_register_id": { "type": "string", "description": "Identifier of the PSC entry on the register." }, "effective_date": { "type": "string", "format": "date", "description": "Date the person, RLE or other registrable person ceased to meet any PSC condition." }, "date_cessation_confirmed": { "type": "string", "format": "date", "description": "Date the company confirmed the cessation." }, "reason": { "type": "string", "enum": [ "shares_transferred", "shares_cancelled_or_redeemed", "voting_or_appointment_rights_ended", "control_arrangement_ended", "death", "other" ], "description": "Why the PSC ceased." }, "probate_or_letters_received_on": { "type": "string", "format": "date", "description": "Required for death." }, "replacement_psc_action": { "type": "string", "description": "act_ id of a uk.psc.notify action for the successor, if any." }, "replacement_statement": { "type": "string", "description": "Statement type to file if no PSC remains: see uk.psc_statement.file." }, "evidence_documents": { "type": "array", "items": {}, "description": "doc_ ids: stock transfer form, board minute, register of members extract, grant of probate." } }, "required": [ "psc_register_id", "effective_date", "date_cessation_confirmed", "reason" ], "description": "Removes a PSC, relevant legal entity or other registrable person from the central register within 14 days of the company confirming the cessation." }, "Create_uk_psc_cease": { "type": "object", "properties": { "type": { "const": "uk.psc.cease" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify that someone has ceased to be a PSC", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cessation_evidence", "title": "Evidence of cessation", "source": "uploaded", "required": true }, { "key": "psc_form", "title": "PSC07 data set", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "psc_form", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "PSC07", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "psc_not_on_register", "type": null, "when": "[invalid_request_error] psc_register_id does not match a current entry." }, { "code": "psc_statement_required", "type": null, "when": "[requirement_error] Ceasing the last PSC would leave no PSC and no statement." }, { "code": "death_without_probate", "type": null, "when": "[requirement_error] cessation_reason is death but no probate or letters of administration date is given." }, { "code": "filing_window_exceeded", "type": null, "when": "[requirement_error] More than 14 days since date_cessation_confirmed." } ] } }, "Params_uk_psc_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "psc_register_id": { "type": "string", "description": "Identifier of the PSC entry on the register." }, "psc_kind": { "type": "string", "enum": [ "individual", "relevant_legal_entity", "other_registrable_person" ], "description": "individual files PSC04; relevant_legal_entity files PSC05; other_registrable_person files PSC06." }, "changes": { "type": "object", "description": "Only the changed fields." }, "change_reason": { "type": "string", "enum": [ "name_change", "address_change", "share_transfer", "share_allotment", "rights_change", "trust_change", "correction", "other" ], "description": "What caused the change." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect." }, "date_change_confirmed": { "type": "string", "format": "date", "description": "Date the company confirmed the change." }, "protection_application": { "type": "string", "enum": [ "none", "pending", "granted" ], "description": "Protection status of the PSC's information." }, "evidence_documents": { "type": "array", "items": {}, "description": "doc_ ids: name-change evidence, transfer instrument, updated register of members extract." } }, "required": [ "psc_register_id", "psc_kind", "changes", "change_reason", "effective_date", "date_change_confirmed" ], "description": "Files a change to the registered details or natures of control of an existing PSC, relevant legal entity or other registrable person within 14 days of confirming the change." }, "Create_uk_psc_change": { "type": "object", "properties": { "type": { "const": "uk.psc.change" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a PSC's details or natures of control", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "psc_change_confirmation", "title": "PSC's confirmation of the changed details", "source": "generated", "required": true }, { "key": "psc_form", "title": "PSC04 / PSC05 / PSC06 data set", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "psc_change_confirmation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "psc_form", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "PSC04", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "psc_not_on_register", "type": null, "when": "[invalid_request_error] psc_register_id does not match a current entry." }, { "code": "change_creates_new_psc", "type": null, "when": "[requirement_error] The change makes someone else a PSC." }, { "code": "changes_empty", "type": null, "when": "[invalid_request_error] No changed field was supplied." }, { "code": "filing_window_exceeded", "type": null, "when": "[requirement_error] More than 14 days since date_change_confirmed." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to confirm the details for the PSC." } ] } }, "Params_uk_psc_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction. slp is Scotland only." }, "psc_kind": { "type": "string", "enum": [ "individual", "relevant_legal_entity", "other_registrable_person" ], "description": "individual files PSC01; relevant_legal_entity files PSC02; other_registrable_person files PSC03 (a government or public authority treated as an individual." }, "psc_person": { "type": "string", "pattern": "^per_", "description": "Individual PSC." }, "psc_entity": { "type": "object", "description": "Required for relevant_legal_entity and other_registrable_person: {name, principal_office, service_address, legal_form, governing_law, registry." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Public service address of an individual PSC." }, "date_became_psc": { "type": "string", "format": "date", "description": "Date the person met a PSC condition." }, "date_details_confirmed": { "type": "string", "format": "date", "description": "Date the PSC confirmed their particulars.", "examples": [ "2026-10-12" ] }, "natures_of_control": { "type": "array", "items": {}, "description": "[{nature, held_via}] with held_via direct | trust | firm. nature is one of shares_25_to_50 | shares_50_to_75 | shares_75_to_100 | votes_25_to_50 |." }, "verification_id": { "type": "string", "description": "ver_ id of a completed registry_idv verification." }, "protection_application": { "type": "string", "enum": [ "none", "pending", "granted" ], "description": "Whether the PSC has applied to protect their information. pending or granted blocks the online PSC verification service." }, "psc_notice_action": { "type": "string", "description": "act_ id of the s790D notice that led to this notification." }, "replaces_statement_id": { "type": "string", "description": "Existing PSC statement that this entry makes obsolete." }, "evidence_documents": { "type": "array", "items": {}, "description": "doc_ ids proving each nature of control." } }, "required": [ "psc_kind", "date_became_psc", "date_details_confirmed", "natures_of_control" ], "description": "Adds a person with significant control, a registrable relevant legal entity or another registrable person to the central register. Files within 14 days of confirmation and starts the PSC's identity verification." }, "Create_uk_psc_notify": { "type": "object", "properties": { "type": { "const": "uk.psc.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify Companies House of a new PSC", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "psc_evidence", "title": "Evidence of each nature of control", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "psc_notice_response", "title": "PSC's reply to the s790D notice", "source": "uploaded", "required": false }, { "key": "psc_confirmation", "title": "PSC's confirmation of particulars", "source": "generated", "required": true }, { "key": "psc_form", "title": "PSC01 / PSC02 / PSC03 data set", "source": "generated", "required": true }, { "key": "register_excerpt", "title": "Companies House PSC excerpt for a UK corporate PSC", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "psc_confirmation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "psc_form", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "PSC01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "natures_of_control_invalid_for_entity_type", "type": null, "when": "[invalid_request_error] For example surplus_assets_* on a company, or appoint_remove_board_majority on an LLP." }, { "code": "psc_particulars_incomplete", "type": null, "when": "[requirement_error] A required particular under s790K is missing." }, { "code": "rle_not_registrable", "type": null, "when": "[requirement_error] The corporate holder is not subject to its own disclosure requirements." }, { "code": "filing_window_exceeded", "type": null, "when": "[requirement_error] More than 14 days since date_details_confirmed." }, { "code": "sanctions_alert_open", "type": null, "when": "[permission_error] An open sanctions alert involves the PSC." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to complete the PSC's identity check or confirmation." } ] } }, "Params_uk_psc_notice_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "recipient_kind": { "type": "string", "enum": [ "individual", "legal_entity" ], "description": "Who the notice goes to." }, "recipient_person": { "type": "string", "pattern": "^per_", "description": "Individual recipient." }, "recipient_entity": { "type": "object", "description": "Required for legal_entity: {name, registered_office, registry, registration_number, contact_name, contact_email}." }, "recipient_address": { "$ref": "#/components/schemas/Address", "description": "Address the notice is sent to." }, "recipient_email": { "type": "string", "description": "Used only if the recipient has agreed to electronic communications." }, "basis_for_belief": { "type": "string", "description": "Why the company knows or has cause to believe the person is a registrable person or RLE (s790D).", "examples": [ "Register of members shows 42% of shares; shareholders' agreement gives a board appointment right." ] }, "trigger": { "type": "string", "enum": [ "incorporation_review", "share_transfer", "share_allotment", "change_in_rights", "third_party_information", "periodic_review", "other" ], "description": "What prompted the notice." }, "duty_arose_on": { "type": "string", "format": "date", "description": "Date the company first knew or had cause to believe." }, "notice_date": { "type": "string", "format": "date", "description": "Date the notice is given." }, "delivery_method": { "type": "string", "enum": [ "post", "email", "post_and_email" ], "description": "post is the default. email needs the recipient's agreement to electronic communications." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Director or secretary who authorises the notice for the company." } }, "required": [ "recipient_kind", "recipient_address", "basis_for_belief", "trigger", "duty_arose_on", "signatory" ], "description": "Sends the company's notice asking a person it knows or believes to be a PSC or relevant legal entity to confirm their status and give required particulars. The recipient has one month to reply." }, "Create_uk_psc_notice_notify": { "type": "object", "properties": { "type": { "const": "uk.psc_notice.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_notice_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Send a PSC information notice to a suspected PSC", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "psc_notice", "title": "Company notice requesting PSC status and particulars", "source": "generated", "required": true }, { "key": "proof_of_delivery", "title": "Proof of posting or email delivery", "source": "generated", "required": true }, { "key": "recipient_response", "title": "Recipient's reply", "source": "uploaded", "required": false } ], "people": [ { "role": "recipient", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "psc_notice", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. The notice goes to the suspected PSC, not to Companies House", "form": "Company notice under s790D. No Companies House form. Scottish partnerships use the reg 10 ", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_window_exceeded", "type": null, "when": "[requirement_error] More than 14 days since duty_arose_on." }, { "code": "recipient_address_missing", "type": null, "when": "[invalid_request_error] No postal address or agreed electronic address." }, { "code": "recipient_already_on_register", "type": null, "when": "[requirement_error] The recipient is already a registered PSC with all particulars confirmed." }, { "code": "notice_exempt_incorporation_statement", "type": null, "when": "[requirement_error] The person was named in the incorporation statement and nothing suggests they ceased to be a PSC (s790D)." }, { "code": "sanctions_alert_open", "type": null, "when": "[permission_error] An open sanctions alert involves the recipient." } ] } }, "Params_uk_psc_statement_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "operation": { "type": "string", "enum": [ "add_statement", "update_statement" ], "description": "add_statement files PSC08. update_statement files PSC09 to change or withdraw an existing statement." }, "statement_type": { "type": "string", "enum": [ "no_psc", "psc_exists_not_identified", "psc_details_not_confirmed", "steps_to_find_psc_not_yet_completed", "psc_contacted_no_response", "psc_failed_to_confirm_changed_details", "restrictions_notice_issued", "awaiting_confirmation_from_psc" ], "description": "no_psc: no registrable person or RLE exists. psc_exists_not_identified. psc_details_not_confirmed. steps_to_find_psc_not_yet_completed.." }, "statement_date": { "type": "string", "format": "date", "description": "Date the company made or changed the statement." }, "existing_statement_id": { "type": "string", "description": "Required for update_statement." }, "withdraw": { "type": "boolean", "description": "For update_statement: withdraw the statement because a PSC has now been notified." }, "linked_psc_register_id": { "type": "string", "description": "Required for psc_failed_to_confirm_changed_details, restrictions_notice_issued and awaiting_confirmation_from_psc, which name a PSC." }, "linked_notice_action": { "type": "string", "description": "act_ id of the uk.psc_notice.send action." }, "basis": { "type": "string", "description": "Steps the company has taken and why the statement is accurate." } }, "required": [ "operation", "statement_type", "statement_date", "basis" ], "description": "Files the statement that must appear on the register when the company has no PSC, has not identified one, or a notice has gone unanswered, and updates or withdraws it later." }, "Create_uk_psc_statement_file": { "type": "object", "properties": { "type": { "const": "uk.psc_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File or update a PSC statement", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_basis", "title": "Record of steps taken to find PSCs", "source": "generated", "required": true }, { "key": "psc_form", "title": "PSC08 / PSC09 data set", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "psc_form", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "PSC08", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "statement_conflicts_with_register", "type": null, "when": "[requirement_error] For example no_psc while a PSC is registered." }, { "code": "linked_record_missing", "type": null, "when": "[requirement_error] A statement that names a PSC or notice has no linked_psc_register_id or linked_notice_action." }, { "code": "statement_not_found", "type": null, "when": "[invalid_request_error] existing_statement_id does not match a current statement." }, { "code": "notice_period_still_running", "type": null, "when": "[requirement_error] psc_contacted_no_response was chosen before the one-month reply period ended." } ] } }, "Params_uk_psc_verification_provide": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "psc_person": { "type": "string", "pattern": "^per_", "description": "The individual PSC." }, "psc_register_id": { "type": "string", "description": "PSC entry on the register." }, "verification_id": { "type": "string", "description": "ver_ id of a completed registry_idv verification run by Entiva as ACSP." }, "personal_code": { "type": "string", "description": "Write-only 11-character Companies House personal code, if the PSC verified elsewhere." }, "identity_verified_statement": { "type": "boolean", "description": "Must be true." }, "also_director": { "type": "boolean", "description": "True if the PSC is also a director." }, "protection_application": { "type": "string", "enum": [ "none", "pending", "granted" ], "description": "pending or granted blocks the service." } }, "required": [ "psc_person", "identity_verified_statement" ], "description": "Submits a PSC's 11-character personal code and the identity-verified statement through the 'Provide identity verification details for a PSC' service, inside the PSC's 14-day window. Entiva can verify the PSC first as an ACSP." }, "Create_uk_psc_verification_provide": { "type": "object", "properties": { "type": { "const": "uk.psc_verification.provide" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_verification_provide" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Provide a PSC's identity verification details to Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "psc_filing_mandate", "title": "PSC's authority for Entiva to submit their code", "source": "generated", "required": true }, { "key": "verification_record", "title": "Entiva ACSP verification record", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Confirmation that the details were provided", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "psc_filing_mandate", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "psc_filing_mandate", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Online service. No numbered form", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "personal_code_invalid", "type": null, "when": "[registry_error] The code or date of birth does not match Companies House records." }, { "code": "psc_not_verified", "type": null, "when": "[requirement_error] No completed registry_idv verification and no personal code." }, { "code": "psc_protected_information", "type": null, "when": "[requirement_error] The PSC has protected information or a pending protection decision, so the service cannot be used." }, { "code": "window_closed", "type": null, "when": "[requirement_error] The window has passed." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent tried to complete the identity check for the PSC." } ] } }, "Params_uk_psc_verification_extension_request": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's jurisdiction." }, "psc_person": { "type": "string", "pattern": "^per_", "description": "The individual PSC." }, "current_window_end": { "type": "string", "format": "date", "description": "Last day of the PSC's current window." }, "reason": { "type": "string", "description": "Why the PSC cannot verify in time." } }, "required": [ "psc_person", "current_window_end" ], "description": "Asks Companies House for a 14-day extension to a PSC's verification window. It must be requested before the window closes." }, "Create_uk_psc_verification_extension_request": { "type": "object", "properties": { "type": { "const": "uk.psc_verification_extension.request" }, "params": { "$ref": "#/components/schemas/Params_uk_psc_verification_extension_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request a 14-day extension for a PSC's identity verification", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_acknowledgement", "title": "Confirmation of the extension", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_acknowledgement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Extension request in the online service", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "window_already_closed", "type": null, "when": "[requirement_error] current_window_end has passed." }, { "code": "extension_already_used", "type": null, "when": "[registry_error] Companies House refuses a second extension." }, { "code": "psc_not_found", "type": null, "when": "[invalid_request_error] The person is not a registered PSC of this entity." } ] } }, "Params_uk_registered_email_change": { "type": "object", "properties": { "email_mode": { "type": "string", "enum": [ "entiva_provided", "own_email" ], "description": "entiva_provided: Entiva supplies a monitored registered email address and forwards registrar emails to forward_to. own_email: the customer supplies the.", "examples": [ "own_email" ] }, "email": { "type": "string", "description": "Required when email_mode is own_email.", "examples": [ "compliance@meridianlabs.example" ] }, "forward_to": { "type": "array", "items": {}, "description": "Required when email_mode is entiva_provided." }, "appropriate_email_confirmation": { "type": "boolean", "description": "The company states that emails from the registrar would in the ordinary course be expected to reach someone acting for the company (CA 2006 s88A, s88B)." } }, "required": [ "email_mode", "appropriate_email_confirmation" ], "description": "Notifies Companies House of a new registered email address for a company or LLP, either an Entiva-monitored address that forwards to the customer or the customer's own, with the statement that it is an appropriate email address." }, "Create_uk_registered_email_change": { "type": "object", "properties": { "type": { "const": "uk.registered_email.change" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_email_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered email address", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_instruction", "title": "Record of the director's instruction and the appropriate email statement", "source": "generated", "required": true }, { "key": "registered_email_notice", "title": "Notice of change of registered email address", "source": "generated", "required": true }, { "key": "registry_acknowledgement", "title": "Companies House acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "registered_email_notice", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registered_email_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "No numbered form: online notice of change of registered email address", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "email_not_appropriate", "type": null, "when": "[invalid_request_error] appropriate_email_confirmation is false, or the address is malformed or a known disposable domain." }, { "code": "forward_to_missing", "type": null, "when": "[invalid_request_error] email_mode is entiva_provided and forward_to is empty." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to give the director's click_consent." }, { "code": "authentication_missing", "type": null, "when": "[requirement_error] No OAuth consent or authentication code is available." }, { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity type has no registered email duty in this batch, for example an LP or an overseas entity." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the notice." } ] } }, "Params_uk_registered_society_annual_return_file": { "type": "object", "properties": { "year_end_date": { "type": "string", "format": "date", "description": "The last day of the society's year of account.", "examples": [ "2026-03-31" ] }, "society_type": { "type": "string", "enum": [ "co_operative", "community_benefit" ], "description": "Which kind of society this is." }, "accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "Approved revenue account and balance sheet." }, "auditor_report_document_id": { "type": "string", "pattern": "^doc_", "description": "Auditor's report, if the society must appoint an auditor or a report is required under s85." }, "committee_signatorys": { "type": "array", "items": {}, "description": "Exactly two committee members who sign the AR30." }, "secretary": { "type": "string", "pattern": "^per_", "description": "The society's secretary, who also signs." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Defaults to the entity's value." } }, "required": [ "year_end_date", "society_type", "accounts_document_id", "committee_signatorys", "secretary" ], "description": "Prepares the AR30 annual return, balance sheet and any auditor's report for a co-operative or community benefit society, signed by two committee members and the secretary and submitted through the FCA Mutuals Society Portal within 7 months." }, "Create_uk_registered_society_annual_return_file": { "type": "object", "properties": { "type": { "const": "uk.registered_society_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare and submit the FCA annual return for a registered society", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ar30", "title": "AR30 annual return", "source": "generated", "required": true }, { "key": "accounts", "title": "Accounts and balance sheet for the year", "source": "uploaded", "required": true }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": false }, { "key": "portal_receipt", "title": "FCA portal submission confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ar30", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ar30", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ar30", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority, Mutuals Public Register", "form": "AR30 with accounts", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "signatories_incomplete", "type": null, "when": "[requirement_error] Fewer than two committee members and the secretary are named, or one has not signed." }, { "code": "audit_report_missing", "type": null, "when": "[requirement_error] An auditor's report is required but not uploaded." }, { "code": "northern_ireland_not_supported", "type": null, "when": "[jurisdiction_error] The society is in Northern Ireland." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to sign as a committee member or secretary." }, { "code": "deadline_passed", "type": null, "when": "[requirement_error] The 7-month statutory deadline has passed." } ] } }, "Params_uk_slp_confirmation_statement_file": { "type": "object", "properties": { "confirmation_date": { "type": "string", "format": "date", "description": "The date up to which the details are confirmed, no later than the last day of the review period." }, "details_up_to_date_confirmed": { "type": "boolean", "description": "The general partner confirms that all information due for the confirmation period has been delivered." }, "signing_general_partner": { "type": "string", "pattern": "^per_", "description": "The general partner who approves the statement for the firm." }, "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Always scotland." } }, "required": [ "confirmation_date", "details_up_to_date_confirmed", "signing_general_partner" ], "description": "Files the SLP CS01 confirming an eligible Scottish partnership's details are up to date. Changes to LP or PSC details must be filed separately first." }, "Create_uk_slp_confirmation_statement_file": { "type": "object", "properties": { "type": { "const": "uk.slp_confirmation_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_slp_confirmation_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a confirmation statement", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "slp", "pflp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "slp_cs01", "title": "SLP CS01 confirmation statement", "source": "generated", "required": true }, { "key": "partnership_details_extract", "title": "Extract of the partnership's current register details", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies House acceptance and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "slp_cs01", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SLP CS01", "channel": "online", "government_fee": { "amount": 110, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "pending_changes_unfiled", "type": null, "when": "[requirement_error] LP changes or PSC details for the period have not yet been filed." }, { "code": "not_scottish_partnership", "type": null, "when": "[jurisdiction_error] The entity is registered in England and Wales or Northern Ireland." }, { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is a Scottish qualifying partnership." }, { "code": "general_partner_not_verified", "type": null, "when": "[requirement_error] The approving general partner has not completed identity_address verification." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the upload." } ] } }, "Params_uk_sqp_confirmation_statement_file": { "type": "object", "properties": { "confirmation_date": { "type": "string", "format": "date", "description": "Date the statement bears, inside the current confirmation period; deliver within 14 days." }, "authenticating_partner": { "type": "string", "pattern": "^ent_", "description": "The partner whose name is printed on the form to authenticate it." }, "authorised_individual": { "type": "string", "pattern": "^per_", "description": "The individual who acts for that partner." }, "pending_change_actions": { "type": "array", "items": {}, "description": "Ids of actions that file changes the statement depends on." }, "confirm_all_information_delivered": { "type": "boolean", "description": "Must be true: all information required under reg 35 has been, or is being, delivered." } }, "required": [ "confirmation_date", "authenticating_partner", "authorised_individual", "confirm_all_information_delivered" ], "description": "Files form SQP CS01, the annual confirmation that the partnership has delivered everything it must give Companies House for the confirmation period. It cannot report changes, so any change to the partnership or its people with significant." }, "Create_uk_sqp_confirmation_statement_file": { "type": "object", "properties": { "type": { "const": "uk.sqp_confirmation_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_confirmation_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual confirmation statement for a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp_cs01", "title": "Form SQP CS01", "source": "generated", "required": true }, { "key": "register_extract_check", "title": "Companies House record check", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp_cs01", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP CS01, uploaded as a PDF", "channel": "online", "government_fee": { "amount": 110, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unfiled_changes_pending", "type": null, "when": "requirement_error." }, { "code": "psc_particulars_unconfirmed", "type": null, "when": "requirement_error." }, { "code": "deadline_passed", "type": null, "when": "requirement_error." } ] } }, "Params_uk_sqp_psc_cease": { "type": "object", "properties": { "psc_type": { "type": "string", "enum": [ "individual", "relevant_legal_entity", "other_registrable_person" ], "description": "What kind of registrable person has ceased." }, "psc_record": { "type": "string", "description": "Id of the PSC, RLE or ORP on Entiva's copy of the register." }, "name": { "type": "string", "description": "The name exactly as it appears on the public register." }, "month_year_of_birth": { "type": "string", "description": "Individuals only, YYYY-MM." }, "date_ceased": { "type": "string", "format": "date", "description": "The date they ceased to be a PSC, RLE or ORP." }, "ceasing_confirmed_on": { "type": "string", "format": "date", "description": "Date the cessation and its date were confirmed to the partnership." }, "reason": { "type": "string", "enum": [ "interest_disposed_of", "rights_fell_to_25_percent_or_less", "control_ended", "death", "other" ], "description": "Why the person stopped being registrable. other needs an explanation in notes on the evidence." }, "individual_confirmation_received": { "type": "boolean", "description": "Required for individuals: the form must not be sent unless the individual has confirmed they have ceased to be a PSC." } }, "required": [ "psc_type", "psc_record", "name", "date_ceased", "ceasing_confirmed_on", "reason" ], "description": "Tells Companies House that an individual PSC, relevant legal entity or other registrable person has stopped being registrable, for example because they sold their interest or their rights fell to 25% or below. The form covers one person." }, "Create_uk_sqp_psc_cease": { "type": "object", "properties": { "type": { "const": "uk.sqp_psc.cease" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_psc_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify that a person has ceased to be a PSC of a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp_psc07_form", "title": "Form SQP PSC07", "source": "generated", "required": true }, { "key": "cessation_evidence", "title": "Evidence they ceased", "source": "uploaded", "required": true }, { "key": "psc_confirmation_of_cessation", "title": "Individual's confirmation of cessation", "source": "generated", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp_psc07_form", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "psc_confirmation_of_cessation", "signer_role": "other", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP PSC07", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "psc_not_on_register", "type": null, "when": "invalid_request_error. psc_record or name does not match an entry on the register." }, { "code": "individual_confirmation_missing", "type": null, "when": "requirement_error. psc_type is individual and the individual has not confirmed." }, { "code": "still_registrable", "type": null, "when": "requirement_error." } ] } }, "Params_uk_sqp_psc_change": { "type": "object", "properties": { "psc_type": { "type": "string", "enum": [ "individual", "relevant_legal_entity", "other_registrable_person" ], "description": "individual files SQP PSC04; relevant_legal_entity files SQP PSC05; other_registrable_person files SQP PSC06." }, "psc_record": { "type": "string", "description": "Id of the PSC, RLE or ORP on Entiva's copy of the register." }, "current_details": { "type": "object", "description": "How Companies House identifies the entry: {name, month_year_of_birth} for an individual, or {name} for an RLE or ORP." }, "effective_date": { "type": "string", "format": "date", "description": "The date the change happened." }, "changes_confirmed_on": { "type": "string", "format": "date", "description": "Date all the changes and their date were confirmed to the partnership." }, "changes": { "type": "object", "description": "Only fields that changed: {new_name, new_service_address, new_usual_residential_address, new_country_or_state_of_residence, new_nationality." }, "individual_confirmation_received": { "type": "boolean", "description": "Required for individuals." }, "protection_applied_for": { "type": "boolean", "description": "True if the individual has applied for protection; the standard form then cannot be used." } }, "required": [ "psc_type", "psc_record", "current_details", "effective_date", "changes_confirmed_on", "changes" ], "description": "Tells Companies House that the details of an existing individual PSC, relevant legal entity or other registrable person have changed: a new name, service address, usual residential address, country of residence, nationality, or different." }, "Create_uk_sqp_psc_change": { "type": "object", "properties": { "type": { "const": "uk.sqp_psc.change" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_psc_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the details of a PSC of a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp_psc_change_form", "title": "Form SQP PSC04, PSC05 or PSC06", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "psc_confirmation_of_change", "title": "Individual's confirmation of the change", "source": "generated", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp_psc_change_form", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "psc_confirmation_of_change", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP PSC04, PSC05 or PSC06", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "psc_not_on_register", "type": null, "when": "invalid_request_error. psc_record or current_details does not match an entry on the register." }, { "code": "change_not_confirmed", "type": null, "when": "requirement_error." }, { "code": "no_longer_registrable", "type": null, "when": "requirement_error." } ] } }, "Params_uk_sqp_psc_notify": { "type": "object", "properties": { "psc_type": { "type": "string", "enum": [ "individual", "relevant_legal_entity", "other_registrable_person" ], "description": "individual files SQP PSC01; relevant_legal_entity files SQP PSC02; other_registrable_person files SQP PSC03." }, "date_became_registrable": { "type": "string", "format": "date", "description": "Date the person or entity became registrable." }, "particulars_confirmed_on": { "type": "string", "format": "date", "description": "Date all required particulars were confirmed." }, "individual": { "type": "object", "description": "For individuals: {person, service_address}." }, "legal_entity": { "type": "object", "description": "For relevant_legal_entity: {entity, name, registered_or_principal_office, legal_form, governing_law, register, registration_number}." }, "other_registrable_person": { "type": "object", "description": "Required for other_registrable_person: {name, category, principal_office, legal_form, governing_law}. category is corporation_sole, government." }, "natures_of_control": { "type": "object", "description": "{surplus_assets_band, voting_rights_band, appoint_or_remove_management_majority, significant_influence_or_control, via_firm, via_trust}." }, "psc_confirmation_received": { "type": "boolean", "description": "Required for individuals." }, "protection_applied_for": { "type": "boolean", "description": "True if the individual has applied for protection; the standard form then cannot be used and Entiva gets the right form from Companies House's secure forms." } }, "required": [ "psc_type", "date_became_registrable", "particulars_confirmed_on", "natures_of_control" ], "description": "Gives Companies House notice that an individual, a relevant legal entity or an other registrable person such as a government or local authority has become a registrable person with significant control of the partnership." }, "Create_uk_sqp_psc_notify": { "type": "object", "properties": { "type": { "const": "uk.sqp_psc.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_psc_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify Companies House of a new PSC of a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp_psc_form", "title": "Form SQP PSC01, PSC02 or PSC03", "source": "generated", "required": true }, { "key": "psc_confirmation_of_particulars", "title": "Individual's confirmation of their particulars", "source": "generated", "required": false }, { "key": "evidence_of_control", "title": "Evidence of the control", "source": "uploaded", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp_psc_form", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "psc_confirmation_of_particulars", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP PSC01, PSC02 or PSC03", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "particulars_not_confirmed", "type": null, "when": "requirement_error." }, { "code": "not_registrable", "type": null, "when": "requirement_error." }, { "code": "nature_of_control_invalid", "type": null, "when": "invalid_request_error." } ] } }, "Params_uk_sqp_psc_filing_rectify": { "type": "object", "properties": { "original_document_type": { "type": "string", "enum": [ "sqp_psc01", "sqp_psc02", "sqp_psc03", "sqp_psc04", "sqp_psc05", "sqp_psc06", "sqp_psc07", "sqp_psc08", "sqp_psc09" ], "description": "Which form is being corrected." }, "original_registration_date": { "type": "string", "format": "date", "description": "The date the original document was registered." }, "distinguishing_information": { "type": "string", "description": "Needed only if more than one document of that type was filed on the same day." }, "confirm_properly_delivered": { "type": "boolean", "description": "The original was properly delivered and only its content is inaccurate." }, "inaccuracy_description": { "type": "string", "description": "What is wrong on the register and why." }, "corrected_particulars": { "type": "object", "description": "The correct content for the original form, in the same shape as the params of the matching uk.sqp_psc.* or uk.sqp_psc_statement.* action." }, "individual_confirmation_received": { "type": "boolean", "description": "Required where the corrected form is about an individual PSC: the individual has confirmed the corrected particulars." } }, "required": [ "original_document_type", "original_registration_date", "confirm_properly_delivered", "inaccuracy_description", "corrected_particulars" ], "description": "Files form SP RP04 with a corrected replacement when a PSC form was properly delivered and registered but inaccuracies still appear on the register. It cannot be used where the original was not properly delivered." }, "Create_uk_sqp_psc_filing_rectify": { "type": "object", "properties": { "type": { "const": "uk.sqp_psc_filing.rectify" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_psc_filing_rectify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Correct an earlier SQP PSC filing by second filing", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sp_rp04_form", "title": "Form SP RP04", "source": "generated", "required": true }, { "key": "corrected_psc_form", "title": "Corrected PSC form", "source": "generated", "required": true }, { "key": "inaccuracy_evidence", "title": "Evidence of the correct particulars", "source": "uploaded", "required": true }, { "key": "psc_confirmation_of_particulars", "title": "Individual's confirmation of corrections", "source": "generated", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "corrected_psc_form", "signer_role": "partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "psc_confirmation_of_particulars", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sp_rp04_form", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SP RP04 with the second-filed corrected document enclosed", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "original_not_properly_delivered", "type": null, "when": "requirement_error." }, { "code": "original_not_found", "type": null, "when": "invalid_request_error." }, { "code": "form_not_eligible", "type": null, "when": "requirement_error. original_document_type is not an SQP PSC01 to PSC09 form." } ] } }, "Params_uk_sqp_psc_statement_change": { "type": "object", "properties": { "update_type": { "type": "string", "enum": [ "partnership_statement_no_longer_true", "person_statement_no_longer_true", "reg10_notice_complied_with_late", "reg11_notice_complied_with_late", "restrictions_withdrawn_by_notice", "restrictions_lifted_by_court_order" ], "description": "What changed." }, "statement": { "type": "string", "enum": [ "no_registrable_person_or_rle", "reasonable_steps_not_completed", "unidentified_registrable_person", "identified_person_particulars_not_confirmed" ], "description": "Required for the two no_longer_true types: which statement stopped being true." }, "relevant_date": { "type": "string", "format": "date", "description": "Date the statement stopped being true, the withdrawal notice was given, or the court order took effect." }, "statement_date": { "type": "string", "format": "date", "description": "Optional." } }, "required": [ "update_type", "relevant_date" ], "description": "Files form SQP PSC09 when a statement previously given on a PSC08 is no longer true, a reg 10 or reg 11 notice has been complied with after its deadline, or a restrictions notice has been withdrawn or lifted by a court. Each form carries." }, "Create_uk_sqp_psc_statement_change": { "type": "object", "properties": { "type": { "const": "uk.sqp_psc_statement.change" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_psc_statement_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a PSC statement for a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp_psc09_form", "title": "Form SQP PSC09", "source": "generated", "required": true }, { "key": "statement_truth_confirmation", "title": "Partner's confirmation of the update", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp_psc09_form", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_truth_confirmation", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP PSC09", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "statement_not_on_register", "type": null, "when": "invalid_request_error." }, { "code": "statement_required", "type": null, "when": "invalid_request_error. update_type is a no_longer_true type and statement is empty." }, { "code": "multiple_relevant_dates", "type": null, "when": "invalid_request_error." } ] } }, "Params_uk_sqp_psc_statement_notify": { "type": "object", "properties": { "statements": { "type": "array", "items": {}, "description": "Which apply: no_registrable_person_or_rle, reasonable_steps_not_completed, unidentified_registrable_person, identified_person_particulars_not_confirmed." }, "notices": { "type": "array", "items": {}, "description": "For the reg 10 and 11 statements: [{regulation, notice_date, addressee}]." }, "restrictions_notice": { "type": "object", "description": "Required for restrictions_notice_issued: {issued_on, relevant_interest, paragraph}." }, "investigation_summary": { "type": "string", "description": "What reasonable steps the partnership has taken to find its registrable persons." }, "statement_true_from": { "type": "string", "format": "date", "description": "The date the statement became true." } }, "required": [ "statements", "investigation_summary", "statement_true_from" ], "description": "Files form SQP PSC08 when the partnership cannot give the usual PSC information and must say why instead: it knows or believes there is no registrable person or RLE; it has not finished taking reasonable steps to find out; there is an." }, "Create_uk_sqp_psc_statement_notify": { "type": "object", "properties": { "type": { "const": "uk.sqp_psc_statement.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_psc_statement_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a PSC statement for a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp_psc08_form", "title": "Form SQP PSC08", "source": "generated", "required": true }, { "key": "investigation_record", "title": "Record of reasonable steps taken", "source": "generated", "required": true }, { "key": "statement_truth_confirmation", "title": "Partner's confirmation of the statement", "source": "generated", "required": true }, { "key": "notice_copy", "title": "Copy of the notice not complied with", "source": "uploaded", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp_psc08_form", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_truth_confirmation", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP PSC08", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "statement_conflict", "type": null, "when": "invalid_request_error." }, { "code": "notice_details_missing", "type": null, "when": "invalid_request_error." }, { "code": "investigation_summary_missing", "type": null, "when": "requirement_error." } ] } }, "Params_uk_sqp_registration_details_change": { "type": "object", "properties": { "partnership_name": { "type": "string", "description": "The new name of the partnership." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Address where documents can be delivered." }, "partner_changes": { "type": "array", "items": {}, "description": "[{change, partner_name, previous_name, register, registration_number}]. change: add, remove, rename, change_register." }, "date_became_aware": { "type": "string", "format": "date", "description": "The day the partnership became aware of the change." } }, "required": [ "date_became_aware" ], "description": "Files form SQP2 to tell Companies House about a change to the partnership's registration details other than PSC details: a new partnership name, a new service address, or a change to a partner." }, "Create_uk_sqp_registration_details_change": { "type": "object", "properties": { "type": { "const": "uk.sqp_registration_details.change" }, "params": { "$ref": "#/components/schemas/Params_uk_sqp_registration_details_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registration details of a Scottish qualifying partnership", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp2_form", "title": "Form SQP2", "source": "generated", "required": true }, { "key": "partner_registry_evidence", "title": "Registry extract of a new partner", "source": "uploaded", "required": false }, { "key": "partnership_agreement_amendment", "title": "Amendment to the partnership agreement", "source": "generated", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp2_form", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement_amendment", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP2", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "natural_person_partner", "type": null, "when": "requirement_error. partner_changes would make an individual a partner." }, { "code": "no_change_given", "type": null, "when": "invalid_request_error." }, { "code": "service_address_invalid", "type": null, "when": "invalid_request_error. new_service_address is a PO box, DX or Legal Post number." } ] } }, "Params_uk_subsidiary_audit_exemption_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's own value." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the subsidiary's financial year to which the exemption and the guarantee relate." }, "exemption": { "type": "string", "enum": [ "audit_s479a" ], "description": "audit_s479a only." }, "parent": { "type": "object", "description": "{name, registered_number, legal_form, country_of_establishment}. s479A: a parent established under the law of a part of the UK." }, "all_members_agree": { "type": "boolean", "description": "True only if every member of the subsidiary agrees to the exemption for this financial year (s479A)." }, "no_audit_requirement_notice": { "type": "boolean", "description": "True if no members holding 10% or more of the shares, or 10% of members, gave a s476 audit notice." }, "exclusions_confirmed": { "type": "object", "description": "{not_traded_company, not_financial_or_pensions_entity, not_trade_union_or_employers_association}, all true." }, "included_in_consolidated_accounts": { "type": "boolean", "description": "The subsidiary is included in the parent's consolidated accounts for the year (s479A)." }, "exemption_disclosed_in_parent_notes": { "type": "boolean", "description": "The parent's consolidated accounts disclose in the notes that the subsidiary is exempt (s479A)." }, "parent_consolidated_accounts": { "type": "string", "pattern": "^doc_", "description": "Copy of the parent's consolidated accounts for the year." }, "parent_auditor_report": { "type": "string", "pattern": "^doc_", "description": "Copy of the auditor's report on the consolidated accounts." }, "parent_consolidated_annual_report": { "type": "string", "pattern": "^doc_", "description": "Copy of the consolidated annual report." }, "parent_signatory": { "type": "string", "pattern": "^per_", "description": "Representative who signs AA06 section 5 on behalf of the parent undertaking." }, "subsidiary_director": { "type": "string", "pattern": "^per_", "description": "Director of the subsidiary who signs AA06 section 6." } }, "required": [ "financial_year_end", "exemption", "parent", "all_members_agree", "no_audit_requirement_notice", "exclusions_confirmed", "included_in_consolidated_accounts", "exemption_disclosed_in_parent_notes", "parent_consolidated_accounts", "parent_auditor_report", "parent_consolidated_annual_report", "parent_signatory", "subsidiary_director" ], "description": "Delivers the papers a private company needs to claim the subsidiary audit exemption under CA 2006 s479A: the AA06 statement of guarantee by the parent undertaking, written notice that all members agree, and the parent's consolidated." }, "Create_uk_subsidiary_audit_exemption_file": { "type": "object", "properties": { "type": { "const": "uk.subsidiary_audit_exemption.file" }, "params": { "$ref": "#/components/schemas/Params_uk_subsidiary_audit_exemption_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the parent guarantee for a subsidiary's audit exemption", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "aa06_statement", "title": "Form AA06", "source": "generated", "required": true }, { "key": "members_agreement_notice", "title": "Notice that all members agree", "source": "generated", "required": true }, { "key": "parent_board_resolution", "title": "Parent's board resolution", "source": "generated", "required": true }, { "key": "parent_consolidated_accounts", "title": "Parent's consolidated accounts", "source": "uploaded", "required": true }, { "key": "parent_auditor_report", "title": "Auditor's report on the consolidated accounts", "source": "uploaded", "required": true }, { "key": "parent_consolidated_annual_report", "title": "Consolidated annual report", "source": "uploaded", "required": true }, { "key": "registry_acknowledgement", "title": "Companies House filing confirmation", "source": "registry_issued", "required": true }, { "key": "subsidiary_accounts_balance_sheet", "title": "Subsidiary accounts balance sheet", "source": "generated", "required": true }, { "key": "companies_house_delivery", "title": "Companies house delivery", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "aa06_statement", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "aa06_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_agreement_notice", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "parent_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "subsidiary_accounts_balance_sheet", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_delivery", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AA06", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "member_agreement_incomplete", "type": null, "when": "requirement_error." }, { "code": "audit_notice_received", "type": null, "when": "requirement_error." }, { "code": "company_excluded_from_exemption", "type": null, "when": "requirement_error." } ] } }, "Params_uk_uk_establishment_address_change": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date the UK establishment's details changed." }, "address": { "$ref": "#/components/schemas/Address", "description": "New address of the UK establishment.", "examples": [ "{\"line1\":\"22 Bishopsgate\",\"city\":\"London\",\"postcode\":\"EC2N 4BQ\",\"country\":\"GB\"}" ] }, "establishment_name": { "type": "string", "description": "New name of the UK establishment, where it differs from the overseas company's name." }, "nature_of_business": { "type": "string", "description": "New description of the business carried on at the UK establishment." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Director, permanent representative or authorised person who signs for the overseas company." } }, "required": [ "effective_date", "signatory" ], "description": "Notifies Companies House of a change to a UK establishment's address, name or nature of business on form OS CH01, within 21 days of the change." }, "Create_uk_uk_establishment_address_change": { "type": "object", "properties": { "type": { "const": "uk.uk_establishment_address.change" }, "params": { "$ref": "#/components/schemas/Params_uk_uk_establishment_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the details of a UK establishment of an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "authority_letter", "title": "Overseas company's written authority for the change", "source": "uploaded", "required": true }, { "key": "new_address_evidence", "title": "Evidence of the new UK establishment address", "source": "uploaded", "required": false }, { "key": "os_ch01_form", "title": "OS CH01 change of UK establishment details", "source": "generated", "required": true }, { "key": "filing_proof", "title": "Proof of delivery and any registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "os_ch01_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "authority_letter", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS CH01", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_provided", "type": null, "when": "[invalid_request_error] None of new_address, new_establishment_name or new_nature_of_business is set." }, { "code": "director_not_verified", "type": null, "when": "[requirement_error] A director of the overseas company has not completed Companies House identity verification." }, { "code": "name_not_permitted", "type": null, "when": "[invalid_request_error] The new establishment name breaches name restrictions." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to sign as the human_only_electronic signatory." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the OS CH01." } ] } }, "Params_uk_uk_establishment_service_agent_change": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "appoint", "change_details", "terminate" ], "description": "appoint files OS AP07. change_details files OS CH09. terminate files OS TM03.", "examples": [ "appoint" ] }, "provider": { "type": "string", "enum": [ "entiva", "nominated_person" ], "description": "Required for appoint. entiva: Entiva is the person authorised to accept service at its UK address. nominated_person: the customer's own nominee." }, "person": { "type": "string", "pattern": "^per_", "description": "Required for appoint with a nominated individual, and for change_details or terminate to identify the existing appointee." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "UK address where documents can be served." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment, change or termination takes effect." }, "replacement_confirmed": { "type": "boolean", "description": "Required for terminate." } }, "required": [ "operation", "effective_date" ], "description": "Appoints a person authorised to accept service of documents for a UK establishment, changes their details or terminates the appointment. Entiva can act as the UK service contact." }, "Create_uk_uk_establishment_service_agent_change": { "type": "object", "properties": { "type": { "const": "uk.uk_establishment_service_agent.change" }, "params": { "$ref": "#/components/schemas/Params_uk_uk_establishment_service_agent_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint, change or end a person authorised to accept service for a UK establishment", "x-entiva": { "jurisdiction": "uk", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "authority_letter", "title": "Overseas company's written authority", "source": "uploaded", "required": true }, { "key": "appointee_consent", "title": "Appointee's consent and identity record", "source": "generated", "required": false }, { "key": "os_service_form", "title": "OS AP07, OS CH09 or OS TM03, as the operation requires", "source": "generated", "required": true }, { "key": "filing_proof", "title": "Proof of delivery and any registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "other", "verification_level": "identity" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "os_service_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "appointee_consent", "signer_role": "appointee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Companies House", "form": "OS AP07", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_service_contact_remaining", "type": null, "when": "[requirement_error] operation is terminate and replacement_confirmed is false." }, { "code": "appointee_not_verified", "type": null, "when": "[requirement_error] A nominated individual has not completed identity verification." }, { "code": "invalid_operation_params", "type": null, "when": "[invalid_request_error] Required fields for the chosen operation are missing." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tries to give the appointee's consent." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejects the form." } ] } }, "Params_uk_agm_hold": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year whose accounts are laid.", "examples": [ "2026-06-30" ] }, "accounting_reference_date": { "type": "string", "format": "date", "description": "Defaults to the entity's." }, "meeting_date": { "type": "string", "format": "date", "description": "Must fall within 6 months beginning the day after the accounting reference date.", "examples": [ "2026-12-10" ] }, "meeting_time": { "type": "string", "description": "HH:MM, UK local time.", "examples": [ "11:00" ] }, "meeting_venue": { "$ref": "#/components/schemas/Address", "description": "Place of the meeting; the notice must state it (s311)." }, "meeting_format": { "type": "string", "enum": [ "in_person", "hybrid" ], "description": "hybrid needs articles allowing electronic attendance." }, "notice_given_date": { "type": "string", "format": "date", "description": "Date notice is sent.", "examples": [ "2026-11-12" ] }, "short_notice_consent": { "type": "boolean", "description": "All members entitled to attend and vote agree to shorter notice (s337); not for traded companies." }, "traded_company": { "type": "boolean", "description": "Adds the statements in s311 and s337." }, "resolutions": { "type": "array", "items": {}, "description": "Items of {title, text, type ordinary|special}." }, "accounts_circulation_date": { "type": "string", "format": "date", "description": "Date accounts and reports go to members; at least 21 days before the meeting unless all members entitled to vote agree (s424-).", "examples": [ "2026-11-12" ] }, "proxy_notification_address": { "type": "string", "description": "Where proxy notices are received; the notice names it (public model art 39).", "examples": [ "proxies@northgate-resources.example" ] }, "notice_delivery": { "type": "string", "enum": [ "electronic", "hard_copy", "website", "mixed" ], "description": "Manner of notice." }, "chair": { "type": "string", "pattern": "^per_", "description": "Defaults to the chairman of the board." }, "member_resolution_requests": { "type": "array", "items": {}, "description": "Document ids of members' requests to add a resolution: 5% of votes, or 100 members averaging GBP 100 paid up; received 6 weeks before the AGM or, if later." } }, "required": [ "financial_year_end", "meeting_date", "meeting_time", "meeting_venue", "meeting_format", "notice_given_date", "resolutions", "accounts_circulation_date", "proxy_notification_address" ], "description": "Calls a PLC's AGM: checks the six-month window and 21 clear days' notice, prepares the notice with the proxy-rights statement, makes sure accounts reach members 21 days before, and sends the pack to members, directors and the auditor.." }, "Create_uk_agm_hold": { "type": "object", "properties": { "type": { "const": "uk.agm.hold" }, "params": { "$ref": "#/components/schemas/Params_uk_agm_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convene a public company's annual general meeting", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_accounts_and_reports", "title": "Signed accounts and reports to be laid", "source": "uploaded", "required": true }, { "key": "board_resolution_approving_notice", "title": "Board resolution approving the AGM", "source": "generated", "required": true }, { "key": "notice_of_agm", "title": "Notice of annual general meeting", "source": "generated", "required": true }, { "key": "proxy_form", "title": "Form of proxy", "source": "generated", "required": false }, { "key": "short_notice_consent", "title": "Members' agreement to shorter notice", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_approving_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_agm", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "short_notice_consent", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "None: an AGM is not filed", "form": "None. Special resolutions passed are filed via uk.resolution.file", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "meeting_date_outside_agm_window", "type": null, "when": "meeting_date is after the 6-month period; proceeds only after the approver acknowledges the offence by every officer in default (s336)." }, { "code": "notice_period_too_short", "type": null, "when": "Fewer than 21 clear days and no short_notice_consent (s307, s360)." }, { "code": "short_notice_not_available", "type": null, "when": "Set for a traded company, or a member entitled to vote has not consented (s337)." }, { "code": "accounts_circulation_too_late", "type": null, "when": "Accounts sent under 21 days before the meeting without every member's agreement (s424-)." }, { "code": "entity_type_not_supported", "type": null, "when": "Not a public company." }, { "code": "director_not_verified", "type": null, "when": "A director who must approve has no Companies House identity verification on record." } ] } }, "Params_uk_board_meeting_record": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "meeting_date": { "type": "string", "format": "date", "description": "Date held.", "examples": [ "2026-10-15" ] }, "meeting_time": { "type": "string", "description": "HH:MM, UK local time." }, "meeting_format": { "type": "string", "enum": [ "in_person", "video_or_phone", "hybrid" ], "description": "Directors take part when they can each communicate to the others, wherever they are." }, "location": { "type": "string", "description": "Place, or where the meeting is treated as held." }, "directors_present": { "type": "array", "items": {}, "description": "person_refs of directors who took part." }, "apologies": { "type": "array", "items": {}, "description": "person_refs who gave apologies." }, "in_attendance": { "type": "array", "items": {}, "description": "Names and roles of others present." }, "chair": { "type": "string", "pattern": "^per_", "description": "Appointed by the directors; if absent after ten minutes those present choose one." }, "quorum_confirmed": { "type": "boolean", "description": "Quorum throughout: two unless the directors fix more." }, "notice_given": { "type": "string", "enum": [ "given", "waived", "not_required_sole_director" ], "description": "Notice given to each director, waived (public: within 7 days after the meeting, art 8; private art 9), or not needed for a sole director." }, "decisions": { "type": "array", "items": {}, "description": "Per decision: title, text, category, votes_for, votes_against, abstained, passed, interests_declared." }, "minutes_text": { "type": "string", "description": "Free-text minutes; otherwise drafted from the other params." }, "related_actions": { "type": "array", "items": {}, "description": "Action types to raise from the decisions, each with its own deadline and fee basis." } }, "required": [ "meeting_date", "meeting_format", "directors_present", "chair", "quorum_confirmed", "decisions" ], "description": "Records a meeting of the directors: attendance, quorum, declared interests and each decision with its vote. Drafts minutes for the chair to approve and sign, keeps them at least 10 years and raises any filings the decisions trigger." }, "Create_uk_board_meeting_record": { "type": "object", "properties": { "type": { "const": "uk.board_meeting.record" }, "params": { "$ref": "#/components/schemas/Params_uk_board_meeting_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the minutes of a directors' meeting", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "minutes_of_meeting", "title": "Minutes of the directors' meeting", "source": "generated", "required": true }, { "key": "notice_of_meeting", "title": "Notice of the meeting", "source": "uploaded", "required": false }, { "key": "board_papers", "title": "Board papers", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes_of_meeting", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None: internal company record", "form": "None. A decision that triggers a filing is filed", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "quorum_not_confirmed", "type": null, "when": "quorum_confirmed is false; decisions voted without a quorum are not recorded, except a proposal to call another meeting." }, { "code": "chair_not_a_director", "type": null, "when": "The chair is not a director on the register at the meeting date." }, { "code": "director_not_in_office", "type": null, "when": "A person listed as present was not a director on meeting_date." }, { "code": "decision_not_carried", "type": null, "when": "votes_for does not exceed votes_against for a decision marked passed, allowing for the casting vote." }, { "code": "meeting_date_in_future", "type": null, "when": "meeting_date is after today." }, { "code": "minutes_not_statutory_llp", "type": null, "when": "The entity is an LLP: s248 does not apply, so the 10-year rule is Entiva's own policy and the LLP agreement governs." } ] } }, "Params_uk_board_resolution_pass": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "decision_type": { "type": "string", "enum": [ "unanimous_written", "sole_director", "llp_members_decision" ], "description": "unanimous_written, sole_director (private art 7), or llp_members_decision." }, "title": { "type": "string", "description": "Short heading for the record.", "examples": [ "Move registered office" ] }, "resolutions": { "type": "array", "items": {}, "description": "Items of {text, category}." }, "decision_date": { "type": "string", "format": "date", "description": "Effective date." }, "eligible_decision_makers": { "type": "array", "items": {}, "description": "person_refs entitled to vote." }, "interests_declared": { "type": "array", "items": {}, "description": "Items of {person, nature}." }, "supporting_documents": { "type": "array", "items": {}, "description": "Document ids of papers the decision-makers must see." }, "related_actions": { "type": "array", "items": {}, "description": "Action types to raise once the decision is made, each with its own deadline and fee basis." } }, "required": [ "decision_type", "title", "resolutions" ], "description": "Records a decision taken without a meeting: a unanimous written resolution of all eligible directors, a sole director's decision, or for an LLP a members' decision under the LLP agreement. Collects each approval and signature, checks." }, "Create_uk_board_resolution_pass": { "type": "object", "properties": { "type": { "const": "uk.board_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_uk_board_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass a directors' written resolution", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' written resolution", "source": "generated", "required": true }, { "key": "supporting_papers", "title": "Papers placed before the directors", "source": "uploaded", "required": false }, { "key": "constitution", "title": "Articles or LLP agreement", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None: internal company record", "form": "None. A decision that triggers a filing", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_unanimous", "type": null, "when": "An eligible director declines or has not signed." }, { "code": "quorum_not_formed", "type": null, "when": "The eligible directors who would sign would not form a quorum (private art 8; public art 18)." }, { "code": "interest_not_resolved", "type": null, "when": "A declared interest bars a director from voting and the rest do not form a quorum." }, { "code": "articles_require_meeting", "type": null, "when": "The filed articles bar written decisions or reserve the matter to a meeting." }, { "code": "director_not_verified", "type": null, "when": "A director who must sign has no Companies House identity verification on record." }, { "code": "llp_agreement_missing", "type": null, "when": "llp_members_decision with no LLP agreement on file; Entiva applies the SI 2001/1090 reg 7 defaults and warns." } ] } }, "Params_uk_company_records_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "destination": { "type": "string", "enum": [ "sail", "registered_office" ], "description": "sail: to the registered SAIL. registered_office: back." }, "records": { "type": "array", "items": {}, "description": "Records moved." }, "effective_date": { "type": "string", "format": "date", "description": "Date the records are kept at the new place; the 14 days run from the change.", "examples": [ "2026-10-26" ] }, "reason": { "type": "string", "description": "Why the records move." }, "inspection_arrangements": { "type": "string", "description": "Contact and hours at the new place." }, "custodian": { "type": "string", "enum": [ "entiva", "company", "third_party" ], "description": "Who holds the records at the new place." } }, "required": [ "destination", "records", "effective_date" ], "description": "Tells Companies House which statutory records are now kept at the registered SAIL, or that they are back at the registered office. Entiva records the move, updates the inspection arrangements and files within 14 days." }, "Create_uk_company_records_change": { "type": "object", "properties": { "type": { "const": "uk.company_records.change" }, "params": { "$ref": "#/components/schemas/Params_uk_company_records_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Move statutory records to the SAIL or back to the registered office", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_moving_records", "title": "Directors' resolution moving the records", "source": "generated", "required": true }, { "key": "records_inventory", "title": "Inventory of records moved", "source": "generated", "required": true }, { "key": "ad03_or_ad04_notification", "title": "AD03 or AD04 notification", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_moving_records", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ad03_or_ad04_notification", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AD03 'Move your company's records to the single alternative inspection location' or AD04 '", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_sail_registered", "type": null, "when": "destination is sail but no SAIL is registered; file uk.sail.register first." }, { "code": "records_already_at_destination", "type": null, "when": "Every listed record is already at the destination." }, { "code": "record_not_eligible_for_sail", "type": null, "when": "A listed record is not one s1136 allows at a SAIL, for example directors' meeting minutes or accounting records." }, { "code": "partial_move_not_allowed", "type": null, "when": "Only part of one record is moved; each record required to be open for inspection must be kept wholly at the place specified." }, { "code": "company_authentication_code_required", "type": null, "when": "Entiva holds no authentication code for the entity." }, { "code": "registry_rejected", "type": null, "when": "Companies House rejects the filing; the reason is returned in requirements[]." } ] } }, "Params_uk_dividend_declare": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "dividend_type": { "type": "string", "enum": [ "interim", "final" ], "description": "interim: directors decide to pay. final: members declare by ordinary resolution on the directors' recommendation." }, "total_amount": { "$ref": "#/components/schemas/Money", "description": "Total to distribute across all shares." }, "amount_per_share": { "$ref": "#/components/schemas/Money", "description": "Per-share amount for one class; for several use class_allocations." }, "class_allocations": { "type": "array", "items": {}, "description": "Items of {share_class, amount_per_share, shares_in_class}." }, "declaration_date": { "type": "string", "format": "date", "description": "Date of the directors' decision or members' resolution.", "examples": [ "2026-10-19" ] }, "record_date": { "type": "string", "format": "date", "description": "Holdings are taken on the date of the resolution or decision unless it or the share terms say otherwise (private art 30; public art 70)." }, "payment_date": { "type": "string", "format": "date", "description": "The dividend must be lawful on the day it is paid.", "examples": [ "2026-10-30" ] }, "relevant_accounts": { "type": "string", "enum": [ "last_annual_accounts", "interim_accounts", "initial_accounts" ], "description": "Accounts justifying the distribution (s836)." }, "relevant_accounts_document": { "type": "string", "pattern": "^doc_", "description": "The accounts relied on." }, "distributable_profits": { "$ref": "#/components/schemas/Money", "description": "Accumulated realised profits less accumulated realised losses (s830), per the relevant accounts, less distributions since." }, "directors_recommendation": { "$ref": "#/components/schemas/Money", "description": "Required for a final dividend, which cannot exceed it (private art 30; public art 70)." }, "members_resolution_route": { "type": "string", "enum": [ "written_resolution", "general_meeting", "already_passed" ], "description": "How a final dividend is declared; Entiva raises the matching action. written_resolution is private companies only." }, "plc_net_asset_test": { "type": "object", "description": "Required for a PLC: net_assets, called_up_share_capital, undistributable_reserves." }, "cic_details": { "type": "object", "description": "Required for a CIC: articles_type, profits for the cap, dividends already paid in the period, which recipients are asset-locked bodies." }, "waiver_documents": { "type": "array", "items": {}, "description": "Document ids of members' written waivers." }, "payment_method": { "type": "string", "enum": [ "bank_transfer", "cheque", "other" ], "description": "Entiva prepares the payment schedule; it does not move money." }, "issue_vouchers": { "type": "boolean", "description": "Produce a voucher per recipient." } }, "required": [ "dividend_type", "total_amount", "declaration_date", "payment_date", "relevant_accounts", "relevant_accounts_document", "distributable_profits" ], "description": "Checks a proposed interim or final dividend is lawful, prepares the directors' minutes or resolution, the members' resolution for a final dividend and a voucher for each recipient, and keeps the records. Companies House is involved only." }, "Create_uk_dividend_declare": { "type": "object", "properties": { "type": { "const": "uk.dividend.declare" }, "params": { "$ref": "#/components/schemas/Params_uk_dividend_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a dividend and issue dividend vouchers", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "plc", "private_unlimited", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "relevant_accounts", "title": "Accounts justifying the dividend", "source": "uploaded", "required": true }, { "key": "directors_minutes_or_resolution", "title": "Directors' minutes or written resolution", "source": "generated", "required": true }, { "key": "members_ordinary_resolution", "title": "Members' ordinary resolution", "source": "generated", "required": false }, { "key": "distributable_profits_worksheet", "title": "Distributable profits and net asset worksheet", "source": "generated", "required": true }, { "key": "dividend_vouchers", "title": "Dividend vouchers", "source": "generated", "required": true }, { "key": "waiver_notices", "title": "Waiver notices", "source": "uploaded", "required": false }, { "key": "interim_accounts_for_registrar", "title": "Interim or initial accounts for the registrar", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "directors_minutes_or_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_ordinary_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "waiver_notices", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "dividend_vouchers", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "interim_accounts_for_registrar", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House, only for a PLC relying on interim or initial accounts", "form": "Copy of the interim or initial accounts", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insufficient_distributable_profits", "type": null, "when": "total_amount exceeds distributable_profits (s830)." }, { "code": "net_asset_test_failed", "type": null, "when": "A PLC's net assets after the dividend would fall below called-up capital plus undistributable reserves (s831)." }, { "code": "relevant_accounts_not_acceptable", "type": null, "when": "Accounts fail ss837-839: last annual accounts not circulated, improperly prepared, audit report missing or qualified without the auditor's statement; or a PLC's interim or initial." }, { "code": "final_dividend_exceeds_recommendation", "type": null, "when": "total_amount is above directors_recommendation (private art 30; public art 70)." }, { "code": "not_in_accordance_with_rights", "type": null, "when": "class_allocations conflict with share rights, or an interim dividend on deferred shares while a preferential dividend is in arrear (private art 30,; public art 70,)." }, { "code": "cic_dividend_cap_exceeded", "type": null, "when": "CIC dividends would exceed the 35% aggregate cap or go to a body the articles bar without Regulator consent." }, { "code": "cic_guarantee_company_cannot_pay", "type": null, "when": "The CIC is limited by guarantee; the dividend guidance covers only CICs with share capital." }, { "code": "payment_date_before_declaration", "type": null, "when": "payment_date is earlier than declaration_date." } ] } }, "Params_uk_general_meeting_hold": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "meeting_type": { "type": "string", "enum": [ "general_meeting", "class_meeting", "agm_required_by_articles" ], "description": "General meeting, class meeting, or an AGM that a private company's articles require." }, "convened_by": { "type": "string", "enum": [ "directors", "members_requisition" ], "description": "members_requisition when members holding 5% of paid-up voting capital required it." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting.", "examples": [ "2026-11-06" ] }, "meeting_time": { "type": "string", "description": "HH:MM, UK local time.", "examples": [ "10:30" ] }, "meeting_venue": { "$ref": "#/components/schemas/Address", "description": "Place of the meeting; the notice must state it (s311)." }, "meeting_format": { "type": "string", "enum": [ "in_person", "hybrid" ], "description": "hybrid needs articles allowing electronic attendance." }, "notice_given_date": { "type": "string", "format": "date", "description": "Date notice is sent.", "examples": [ "2026-10-20" ] }, "resolutions": { "type": "array", "items": {}, "description": "Items of {title, text, type ordinary|special, requires_special_notice}." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Required for a class meeting." }, "short_notice_consent": { "type": "boolean", "description": "Members agree to shorter notice (s307-): majority in number holding 90% of nominal value or 95%." }, "traded_company": { "type": "boolean", "description": "21 days' notice unless s307A conditions A to C are met." }, "proxy_notification_address": { "type": "string", "description": "Where proxy notices are received.", "examples": [ "company@fernhill-analytics.example" ] }, "requisition_documents": { "type": "array", "items": {}, "description": "Document ids of the members' request (s303,)." }, "notice_delivery": { "type": "string", "enum": [ "electronic", "hard_copy", "website", "mixed" ], "description": "Manner of notice." } }, "required": [ "meeting_type", "convened_by", "meeting_date", "meeting_time", "meeting_venue", "meeting_format", "notice_given_date", "resolutions", "proxy_notification_address" ], "description": "Calls a general meeting that is not a PLC's statutory AGM: applies the notice period for the company type, special notice and members' requisitions, and sends the notice with the proxy statement. Also used for class meetings and for a." }, "Create_uk_general_meeting_hold": { "type": "object", "properties": { "type": { "const": "uk.general_meeting.hold" }, "params": { "$ref": "#/components/schemas/Params_uk_general_meeting_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Call a general meeting of members", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_approving_notice", "title": "Board resolution calling the meeting", "source": "generated", "required": true }, { "key": "notice_of_general_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "proxy_form", "title": "Form of proxy", "source": "generated", "required": false }, { "key": "members_requisition", "title": "Members' request for a meeting", "source": "uploaded", "required": false }, { "key": "special_notice_of_intention", "title": "Special notice of intention to move a resolution", "source": "uploaded", "required": false }, { "key": "short_notice_consent", "title": "Members' agreement to shorter notice", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 90, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_approving_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_general_meeting", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "members_requisition", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "short_notice_consent", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "None: calling a meeting is not filed", "form": "None. Special resolutions passed are filed via uk.resolution.file", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_period_too_short", "type": null, "when": "Fewer clear days than the company type requires and no valid short_notice_consent." }, { "code": "special_notice_period_too_short", "type": null, "when": "A requires_special_notice resolution lacks proof of notice 28 days before; a meeting called within 28 days of that notice is treated as properly noticed (s312)." }, { "code": "requisition_deadline_missed", "type": null, "when": "Members' requisition: call is later than 21 days, or the meeting is over 28 days after the notice (s304)." }, { "code": "special_resolution_not_flagged", "type": null, "when": "The notice would not state the text and intention to propose a special resolution (s283)." }, { "code": "class_of_shares_required", "type": null, "when": "meeting_type is class_meeting and class_of_shares is missing." } ] } }, "Params_uk_general_meeting_record": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "meeting_type": { "type": "string", "enum": [ "agm", "general_meeting", "class_meeting", "serious_loss_of_capital" ], "description": "Kind of meeting held." }, "convening_action": { "type": "string", "description": "Id of the action that called the meeting; pre-fills notice, resolutions and recipients." }, "meeting_date": { "type": "string", "format": "date", "description": "Date held.", "examples": [ "2026-10-14" ] }, "chair": { "type": "string", "pattern": "^per_", "description": "Person who chaired." }, "attendance": { "type": "object", "description": "members_in_person, proxies, corporate_representatives; directors_present; auditor_present." }, "quorum_confirmed": { "type": "boolean", "description": "Quorum throughout: two qualifying persons unless the articles say otherwise, one if there is one member." }, "results": { "type": "array", "items": {}, "description": "Per resolution: title, text, type, vote_method, votes_for, votes_against, votes_withheld, passed." }, "poll_demanded": { "type": "boolean", "description": "A poll was demanded on any resolution." }, "adjourned": { "type": "boolean", "description": "Meeting adjourned; record the continuation separately." }, "accounts_laid": { "type": "boolean", "description": "PLC accounts meeting: accounts and reports laid." }, "auditor_appointed": { "type": "object", "description": "firm_name and term, if an auditor was appointed (public company: before the end of the accounts meeting, s489)." }, "officer_changes": { "type": "array", "items": {}, "description": "Appointments, retirements or removals resolved: person, change, effective_date." }, "file_resolutions_with_companies_house": { "type": "boolean", "description": "Create a uk.resolution.file action for each resolution caught by s29." } }, "required": [ "meeting_type", "meeting_date", "chair", "attendance", "quorum_confirmed", "results" ], "description": "Records a general meeting already held: checks the resolutions were validly passed, produces minutes for the chair to sign, keeps them 10 years, and starts the filing of copies of resolutions that go to Companies House within 15 days." }, "Create_uk_general_meeting_record": { "type": "object", "properties": { "type": { "const": "uk.general_meeting.record" }, "params": { "$ref": "#/components/schemas/Params_uk_general_meeting_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the minutes and results of a general meeting", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "minutes_of_meeting", "title": "Minutes of the general meeting", "source": "generated", "required": true }, { "key": "attendance_register", "title": "Attendance register", "source": "uploaded", "required": false }, { "key": "poll_results", "title": "Poll results", "source": "uploaded", "required": false }, { "key": "resolution_copies", "title": "Copies of resolutions to file", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "proxy", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes_of_meeting", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_copies", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Copy of each s29 resolution", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "quorum_not_confirmed", "type": null, "when": "quorum_confirmed is false; resolutions are not recorded as passed." }, { "code": "resolution_not_validly_passed", "type": null, "when": "Notice omitted the resolution, a special resolution's notice lacked its text and intention (s283), or the vote was under 75%." }, { "code": "convening_action_not_found", "type": null, "when": "convening_action matches no action on this entity." }, { "code": "meeting_date_in_future", "type": null, "when": "meeting_date is after today." }, { "code": "s30_deadline_at_risk", "type": null, "when": "Over 15 days since passing; Entiva still files, but filing does not cure the s30 offence." } ] } }, "Params_uk_interests_register_record": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "notice_date": { "type": "string", "format": "date", "description": "Date the s793 notice was served; entered as the date the requirement was imposed (s808).", "examples": [ "2026-09-28" ] }, "respondent": { "type": "string", "pattern": "^per_", "description": "Person or entity that received the notice and answered." }, "response_received_date": { "type": "string", "format": "date", "description": "Date the company received the information; starts the 3 days (s808).", "examples": [ "2026-10-14" ] }, "response_outcome": { "type": "string", "enum": [ "interest_confirmed", "interest_denied", "further_information_provided" ], "description": "What the reply says." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class of shares the notice concerned.", "examples": [ "Ordinary" ] }, "present_holder": { "type": "string", "pattern": "^per_", "description": "Registered holder." }, "interested_persons": { "type": "array", "items": {}, "description": "Items of {name, address, nature_of_interest, shares, period}; for a past interest, who held it next (s793-)." }, "agreements_disclosed": { "type": "object", "description": "Flags and description of any s824 share acquisition agreement or agreement on exercising rights reported (s793)." }, "response_document": { "type": "string", "pattern": "^doc_", "description": "The respondent's reply as received." }, "notice_document": { "type": "string", "pattern": "^doc_", "description": "Copy of the notice served." }, "records_location": { "type": "string", "enum": [ "registered_office", "sail" ], "description": "Where the register is kept for inspection." } }, "required": [ "notice_date", "respondent", "response_received_date", "response_outcome", "share_class", "interested_persons", "response_document" ], "description": "A public company that has served a notice under s793 asking who is interested in its shares must enter each answer in its register of interests disclosed within 3 days, against the present holder's name and in date order, and keep an." }, "Create_uk_interests_register_record": { "type": "object", "properties": { "type": { "const": "uk.interests_register.record" }, "params": { "$ref": "#/components/schemas/Params_uk_interests_register_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a response to a section 793 notice in the register of interests", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "plc", "uk_societas" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "response_document", "title": "Respondent's reply", "source": "uploaded", "required": true }, { "key": "notice_copy", "title": "Copy of the s793 notice", "source": "uploaded", "required": false }, { "key": "register_entry", "title": "Register entry", "source": "generated", "required": true }, { "key": "index_entry", "title": "Index entry", "source": "generated", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "recipient", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "register_entry", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "index_entry", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None: internal statutory register", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "three_day_period_missed", "type": null, "when": "The action is created over 3 days after response_received_date; Entiva makes the entry, records the actual date and flags the s808 offence exposure." }, { "code": "not_a_public_company", "type": null, "when": "The entity is not a public company or UK Societas; only a public company may serve a s793 notice." }, { "code": "respondent_response_incomplete", "type": null, "when": "The reply omits what the notice asked for; the company may apply to the court for a restrictions order if information is not given in time." }, { "code": "register_location_not_notified", "type": null, "when": "The register is kept away from the registered office with no AD02/AD03 on file (s809,)." }, { "code": "notice_not_found", "type": null, "when": "notice_date matches no notice on the entity and notice_document is missing." } ] } }, "Params_uk_register_of_members_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "operation": { "type": "string", "enum": [ "add_member", "amend_member_details", "record_cessation", "remove_former_member_entry", "establish_local_register" ], "description": "add_member; amend_member_details; record_cessation; remove_former_member_entry; establish_local_register." }, "member": { "type": "string", "pattern": "^per_", "description": "The member concerned." }, "effective_date": { "type": "string", "format": "date", "description": "Date registered, ceased, or changed.", "examples": [ "2026-10-12" ] }, "shares": { "type": "array", "items": {}, "description": "Share companies: items of {share_class, number_of_shares, distinguishing_numbers, amount_paid}." }, "member_class": { "type": "string", "description": "Company without share capital and with more than one class of member (s113)." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Guarantee company: amount the member undertakes to contribute." }, "name": { "type": "string", "description": "For amend_member_details." }, "address": { "$ref": "#/components/schemas/Address", "description": "For amend_member_details." }, "reason": { "type": "string", "description": "Why the entry changes, for example change of name by deed poll." }, "register_source": { "type": "string", "enum": [ "uploaded_register", "companies_house_extract" ], "description": "For establish_local_register: where the data comes from." }, "records_location": { "type": "string", "enum": [ "registered_office", "sail" ], "description": "Where the register will be available for inspection." } }, "required": [ "operation" ], "description": "Updates the register of members, which since 26 January 2026 must be held locally and cannot be kept on the central register. Enters a new member, amends particulars, records a member ceasing, removes a former member's entry after ten." }, "Create_uk_register_of_members_change": { "type": "object", "properties": { "type": { "const": "uk.register_of_members.change" }, "params": { "$ref": "#/components/schemas/Params_uk_register_of_members_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Maintain the register of members", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_members_extract", "title": "Register of members after the change", "source": "generated", "required": true }, { "key": "member_change_request", "title": "Member's notice of change", "source": "uploaded", "required": false }, { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "existing_register", "title": "Existing register of members", "source": "uploaded", "required": false } ], "people": [ { "role": "member", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "member_change_request", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_members_extract", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None: the register is held", "form": "None. A change in where the register is kept is notified on AD02/AD03/AD04", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_location_not_notified", "type": null, "when": "The register is kept away from the registered office with no AD02/AD03 on file; 14 days' default is an offence (s114,)." }, { "code": "member_not_found", "type": null, "when": "member is not on the register for amend_member_details or record_cessation." }, { "code": "entry_not_old_enough", "type": null, "when": "remove_former_member_entry before ten years have passed since the person ceased to be a member." }, { "code": "member_still_holds_shares", "type": null, "when": "record_cessation while shares are still held." }, { "code": "court_order_required", "type": null, "when": "The correction would rectify a disputed entry; that needs a court order." }, { "code": "share_details_inconsistent", "type": null, "when": "Share numbers, classes or amounts paid do not reconcile with issued capital." } ] } }, "Params_uk_resolution_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "resolution_category": { "type": "string", "enum": [ "special", "unanimous_members", "unanimous_class", "binding_class", "other_enactment" ], "description": "Why s29 catches it: special; unanimous members' agreement that would otherwise need a special resolution; unanimous class agreement; class-binding resolution." }, "resolution_text": { "type": "string", "description": "Full wording." }, "resolution_date": { "type": "string", "format": "date", "description": "Date passed or agreed; starts the 15 days.", "examples": [ "2026-10-14" ] }, "passed_by": { "type": "string", "enum": [ "general_meeting", "written_resolution", "unanimous_informal_agreement", "class_meeting" ], "description": "How it was passed." }, "statutory_basis": { "type": "string", "description": "Provision requiring it, for example 's551'." }, "source_action": { "type": "string", "description": "Id of the uk.general_meeting.record or uk.written_resolution.pass action that produced it." }, "copy_document": { "type": "string", "pattern": "^doc_", "description": "Signed copy." } }, "required": [ "resolution_category", "resolution_text", "resolution_date", "passed_by" ], "description": "Sends the registrar a copy of a special resolution, or any other resolution or agreement caught by s29, within 15 days of its passing. Use it for resolutions passed outside Entiva's meeting and written-resolution actions, or to re-file." }, "Create_uk_resolution_file": { "type": "object", "properties": { "type": { "const": "uk.resolution.file" }, "params": { "$ref": "#/components/schemas/Params_uk_resolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a copy of a resolution with Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_copy", "title": "Copy of the resolution", "source": "generated", "required": true }, { "key": "evidence_of_passing", "title": "Minutes or written-resolution record", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Upload acknowledgement and filing-history entry", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "resolution_copy", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Copy of resolution. No form number", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "resolution_not_uploadable", "type": null, "when": "It changes the company name or converts the company to or from a CIC or charity; Companies House does not take these by upload." }, { "code": "filing_overdue", "type": null, "when": "Over 15 days since resolution_date." }, { "code": "file_too_large", "type": null, "when": "PDF is 4MB or more, or continuation pages are not merged into one file." }, { "code": "signature_certificate_attached", "type": null, "when": "A digitally signed PDF carries a signature certificate; Companies House rejects it." }, { "code": "resolution_not_caught_by_s29", "type": null, "when": "resolution_category matches no category in s29; nothing needs filing under s30." }, { "code": "registry_rejected", "type": null, "when": "Companies House rejects the upload; the reason is returned in requirements[]." } ] } }, "Params_uk_sail_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "sail_address": { "$ref": "#/components/schemas/Address", "description": "Must be in the part of the UK where the company is registered." }, "previous_sail_address": { "$ref": "#/components/schemas/Address", "description": "Set when replacing a SAIL." }, "custodian": { "type": "string", "enum": [ "entiva", "company", "third_party" ], "description": "Who holds the records at the address." }, "inspection_arrangements": { "type": "string", "description": "Contact and hours." }, "effective_date": { "type": "string", "format": "date", "description": "Defaults to the filing date." }, "reason": { "type": "string", "description": "Why a SAIL is used, for the record." } }, "required": [ "sail_address" ], "description": "Notifies Companies House of a single alternative inspection location where the company or LLP will keep its statutory records open to inspection instead of its registered office. Records are not moved until uk.company_records.move is filed." }, "Create_uk_sail_register": { "type": "object", "properties": { "type": { "const": "uk.sail.register" }, "params": { "$ref": "#/components/schemas/Params_uk_sail_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a single alternative inspection location", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_approving_sail", "title": "Directors' resolution approving the SAIL", "source": "generated", "required": true }, { "key": "custodian_confirmation", "title": "Custodian's confirmation", "source": "uploaded", "required": false }, { "key": "ad02_notification", "title": "AD02 notification", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_approving_sail", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ad02_notification", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AD02 'Register a single alternative inspection location'", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "sail_in_wrong_part_of_uk", "type": null, "when": "sail_address is outside the part of the UK where the company is registered: England and Wales, Scotland, or Northern Ireland." }, { "code": "sail_is_registered_office", "type": null, "when": "sail_address matches the registered office; a SAIL is an alternative to it." }, { "code": "company_authentication_code_required", "type": null, "when": "Entiva holds no authentication code for the entity; the customer supplies it or Entiva requests one by post." }, { "code": "sail_already_registered", "type": null, "when": "The same address is already the registered SAIL." }, { "code": "registry_rejected", "type": null, "when": "Companies House rejects the filing; the reason is returned in requirements[]." } ] } }, "Params_uk_serious_loss_meeting_hold": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "date_director_learned": { "type": "string", "format": "date", "description": "Earliest day any director knew net assets were half or less of called-up capital (s656).", "examples": [ "2026-10-09" ] }, "net_assets": { "$ref": "#/components/schemas/Money", "description": "Net assets from the accounts relied on." }, "called_up_share_capital": { "$ref": "#/components/schemas/Money", "description": "Called-up share capital at the same date." }, "basis_of_calculation": { "type": "string", "description": "Which accounts or management information the figures come from." }, "meeting_date": { "type": "string", "format": "date", "description": "No later than 56 days after date_director_learned (s656).", "examples": [ "2026-11-26" ] }, "meeting_time": { "type": "string", "description": "HH:MM, UK local time.", "examples": [ "14:00" ] }, "meeting_venue": { "$ref": "#/components/schemas/Address", "description": "Place of the meeting (s311)." }, "meeting_format": { "type": "string", "enum": [ "in_person", "hybrid" ], "description": "hybrid needs articles allowing electronic attendance." }, "notice_given_date": { "type": "string", "format": "date", "description": "No later than 28 days after date_director_learned.", "examples": [ "2026-11-05" ] }, "proposed_steps": { "type": "array", "items": {}, "description": "Options for the meeting to consider, as strings." }, "traded_company": { "type": "boolean", "description": "21 days' notice unless s307A conditions A-C are met." }, "proxy_notification_address": { "type": "string", "description": "Where proxy notices are received.", "examples": [ "proxies@northgate-resources.example" ] } }, "required": [ "date_director_learned", "net_assets", "called_up_share_capital", "meeting_date", "meeting_time", "meeting_venue", "meeting_format", "notice_given_date", "proxy_notification_address" ], "description": "When a public company's net assets fall to half or less of its called-up share capital, the directors must call a general meeting within 28 days of the day a director learns it, to be held within 56 days of that day. The action fixes both." }, "Create_uk_serious_loss_meeting_hold": { "type": "object", "properties": { "type": { "const": "uk.serious_loss_meeting.hold" }, "params": { "$ref": "#/components/schemas/Params_uk_serious_loss_meeting_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Call the serious loss of capital meeting of a public company", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "plc", "uk_societas" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "accounts_or_management_accounts", "title": "Accounts showing net assets", "source": "uploaded", "required": true }, { "key": "board_resolution_calling_meeting", "title": "Board resolution calling the meeting", "source": "generated", "required": true }, { "key": "notice_of_general_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "directors_statement_to_members", "title": "Directors' statement", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_calling_meeting", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_general_meeting", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None: the meeting is not filed", "form": "None. Any special resolution passed is filed via uk.resolution.file", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "threshold_not_met", "type": null, "when": "net_assets is more than half of called_up_share_capital, so s656 is not triggered." }, { "code": "calling_deadline_missed", "type": null, "when": "notice_given_date is over 28 days after date_director_learned (s656)." }, { "code": "meeting_date_too_late", "type": null, "when": "meeting_date is over 56 days after date_director_learned (s656)." }, { "code": "notice_period_too_short", "type": null, "when": "Under 14 clear days with no valid short-notice consent." }, { "code": "entity_type_not_supported", "type": null, "when": "Not a public company or UK Societas." } ] } }, "Params_uk_share_transfer_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "transferor": { "type": "string", "pattern": "^per_", "description": "Current holder on the register; remains the holder until the transferee is entered (private art 26; public art 63)." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Person or entity receiving the shares." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "One class only (public art 63).", "examples": [ "Ordinary" ] }, "number_of_shares": { "type": "integer", "description": "Shares transferred." }, "distinguishing_numbers": { "type": "string", "description": "Share numbers, if numbered (s113)." }, "fully_paid": { "type": "boolean", "description": "False if partly paid: the simplified stock transfer form is unavailable (Stock Transfer Act 1963 s1), the transferee must also execute (public art 63) and the." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price paid, for Stamp Duty: 0.5% rounded up to the nearest GBP 5 above GBP 1,000." }, "instrument_signed_date": { "type": "string", "format": "date", "description": "Date the form was signed and dated; starts the 30 days to send it to HMRC and pay.", "examples": [ "2026-10-12" ] }, "lodged_with_company_date": { "type": "string", "format": "date", "description": "Date lodged with the company; starts the two months to register or refuse (s771) and have certificates ready (s776).", "examples": [ "2026-10-14" ] }, "certificate_surrendered": { "type": "boolean", "description": "The transferor's certificate is lodged." }, "transfer_restrictions_cleared": { "type": "boolean", "description": "Pre-emption, consents and shareholders'-agreement conditions are met or waived." }, "directors_decision": { "type": "string", "enum": [ "register", "refuse" ], "description": "register or refuse." }, "refusal_reasons": { "type": "string", "description": "Required if refusing; sent with the notice of refusal (s771)." }, "issue_new_certificates": { "type": "boolean", "description": "Certificates for the transferee and the transferor's balance." } }, "required": [ "transferor", "transferee", "share_class", "number_of_shares", "fully_paid", "consideration", "instrument_signed_date", "lodged_with_company_date", "certificate_surrendered", "transfer_restrictions_cleared", "directors_decision" ], "description": "Takes a signed stock transfer form, sends it to HMRC for Stamp Duty and, once HMRC confirms it is duly stamped, enters the transferee on the register of members and issues new certificates. The directors approve registration, or refuse it." }, "Create_uk_share_transfer_register": { "type": "object", "properties": { "type": { "const": "uk.share_transfer.register" }, "params": { "$ref": "#/components/schemas/Params_uk_share_transfer_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a share transfer on the register of members", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "stock_transfer_form", "title": "Stock transfer form", "source": "uploaded", "required": true }, { "key": "share_certificate_surrendered", "title": "Transferor's share certificate", "source": "uploaded", "required": false }, { "key": "stamp_duty_calculation", "title": "Stamp Duty calculation", "source": "generated", "required": true }, { "key": "hmrc_stamping_letter", "title": "HMRC letter confirming the form is duly stamped", "source": "registry_issued", "required": true }, { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "new_share_certificates", "title": "New share certificates", "source": "generated", "required": false }, { "key": "notice_of_refusal", "title": "Notice of refusal with reasons", "source": "generated", "required": false }, { "key": "evidence_of_authority", "title": "Evidence of an agent's authority", "source": "uploaded", "required": false } ], "people": [ { "role": "member", "verification_level": "none" }, { "role": "shareholder", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "authorised_signatory", "verification_level": "identity" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "stock_transfer_form", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "new_share_certificates", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_refusal", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC Stamp Taxes", "form": "Stock transfer form", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "shares_not_held_by_transferor", "type": null, "when": "The transferor is not on the register for at least number_of_shares of that class." }, { "code": "transfer_instrument_invalid", "type": null, "when": "The form is not executed by or for the transferor, or for partly paid shares the transferee." }, { "code": "stamp_duty_unpaid", "type": null, "when": "30 days from instrument_signed_date have run without payment; HMRC may charge a penalty and interest." }, { "code": "hmrc_letter_pending", "type": null, "when": "No HMRC letter yet: the register cannot be updated and the s771 two months keep running." }, { "code": "transfer_restrictions_not_cleared", "type": null, "when": "transfer_restrictions_cleared is false." }, { "code": "certificate_missing", "type": null, "when": "certificate_surrendered is false though certificates were issued; the directors may refuse (public art 63)." }, { "code": "screening_alert_open", "type": null, "when": "A sanctions alert is open on the transferor or transferee; live actions involving that person are paused." }, { "code": "refusal_reasons_required", "type": null, "when": "directors_decision is refuse with no refusal_reasons (s771)." } ] } }, "Params_uk_written_resolution_pass": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Defaults to the entity's." }, "proposed_by": { "type": "string", "enum": [ "directors", "members" ], "description": "directors or members who required circulation." }, "resolutions": { "type": "array", "items": {}, "description": "Items of {title, text, type ordinary|special}." }, "circulation_date": { "type": "string", "format": "date", "description": "Date copies are sent.", "examples": [ "2026-10-19" ] }, "lapse_period_days": { "type": "integer", "description": "Period set by the articles." }, "circulation_method": { "type": "string", "enum": [ "electronic", "hard_copy", "website", "mixed" ], "description": "Hard copy, electronic or website (s291); a website copy must stay up until the lapse date." }, "members_statement": { "type": "string", "description": "Statement of up to 1,000 words members required to be circulated (s292)." }, "members_request_documents": { "type": "array", "items": {}, "description": "Document ids of requests from members holding the requisite percentage (s292-)." }, "eligible_members": { "type": "array", "items": {}, "description": "Defaults to members entitled to vote on the circulation date." }, "file_with_companies_house": { "type": "boolean", "description": "Raise uk.resolution.file for a special or other s29 resolution once passed." } }, "required": [ "proposed_by", "resolutions" ], "description": "Circulates a proposed ordinary or special resolution to every eligible member, collects each member's agreement, tracks the 28-day lapse date, records the result and, for a special resolution, starts the filing of a copy at Companies House." }, "Create_uk_written_resolution_pass": { "type": "object", "properties": { "type": { "const": "uk.written_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_uk_written_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass a members' written resolution", "x-entiva": { "jurisdiction": "uk", "stage": "governance", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "written_resolution", "title": "Proposed written resolution", "source": "generated", "required": true }, { "key": "members_request", "title": "Members' request to circulate", "source": "uploaded", "required": false }, { "key": "member_agreements", "title": "Members' agreements", "source": "generated", "required": true }, { "key": "resolution_record", "title": "Record of the resolution passed", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity" }, { "role": "member", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "member_agreements", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "written_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_record", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Copy of the resolution", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_permitted", "type": null, "when": "It would remove a director or auditor early (s288), or the entity is a public company or community interest PLC." }, { "code": "special_resolution_not_flagged", "type": null, "when": "A resolution meant to be special is not marked special (s283)." }, { "code": "members_request_below_threshold", "type": null, "when": "proposed_by is members and requests fall short of the requisite percentage (s292-)." }, { "code": "resolution_lapsed", "type": null, "when": "The majority was not reached by the lapse date (s297); the action fails and nothing is recorded." }, { "code": "agreement_after_lapse", "type": null, "when": "A member's agreement arrives after the lapse date and has no effect (s297)." } ] } }, "Params_uk_auditor_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "appointment_basis": { "type": "string", "enum": [ "first_auditor", "annual_appointment", "casual_vacancy", "after_exempt_period", "deemed_reappointment_record" ], "description": "deemed_reappointment_record records s487 re-appointment; no resolution." }, "appointed_by": { "type": "string", "enum": [ "directors", "members_ordinary_resolution", "not_applicable" ], "description": "Directors where the Act gives them the power (s485, s489); otherwise members by ordinary resolution." }, "auditor": { "type": "object", "description": "firm_name, registered_auditor_number, address, senior statutory auditor." }, "financial_year_end": { "type": "string", "format": "date", "description": "Year-end the appointment covers." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect; not before the previous auditor ceases (s487)." }, "remuneration": { "$ref": "#/components/schemas/Money", "description": "Fee or basis, if recorded." } }, "required": [ "appointment_basis", "appointed_by", "auditor", "financial_year_end", "effective_date" ], "description": "Records the appointment or re-appointment of the statutory auditor by the directors or members and checks the auditor is registered. Nothing is filed at Companies House." }, "Create_uk_auditor_appoint": { "type": "object", "properties": { "type": { "const": "uk.auditor.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_auditor_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint or re-appoint the statutory auditor", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointment_resolution", "title": "Directors' decision or members' ordinary resolution", "source": "generated", "required": true }, { "key": "auditor_consent", "title": "Auditor's acceptance and engagement letter", "source": "uploaded", "required": true }, { "key": "register_check", "title": "Register of auditors check", "source": "generated", "required": true } ], "people": [ { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "auditor_consent", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Companies House", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_not_registered", "type": null, "when": "[requirement_error] Not on the register of auditors." }, { "code": "appointment_window_missed", "type": null, "when": "[requirement_error] Window passed; the Secretary of State's default power may apply." }, { "code": "plc_requires_meeting", "type": null, "when": "[invalid_request_error] A PLC's members cannot use a written resolution." } ] } }, "Params_uk_auditor_remove": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "auditor_id": { "type": "string", "description": "Auditor record id being removed." }, "proposer": { "type": "string", "pattern": "^per_", "description": "Member who gives special notice." }, "special_notice_received_date": { "type": "string", "format": "date", "description": "Date special notice was received." }, "meeting_date": { "type": "string", "format": "date", "description": "General meeting, at least 28 days after special notice unless called for an earlier date." }, "auditor_representations": { "type": "object", "description": "received, document_id, received_in_time." }, "replacement_auditor": { "type": "object", "description": "Optional replacement; creates a linked uk.auditor.appoint." }, "votes": { "type": "object", "description": "votes_for, votes_against, abstentions, quorum_met." } }, "required": [ "auditor_id", "proposer", "special_notice_received_date", "meeting_date" ], "description": "Runs the removal route: special notice, copy to the auditor, representations, general meeting and ordinary resolution, and links a replacement appointment." }, "Create_uk_auditor_remove": { "type": "object", "properties": { "type": { "const": "uk.auditor.remove" }, "params": { "$ref": "#/components/schemas/Params_uk_auditor_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove the statutory auditor by members' resolution", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_notice", "title": "Member's special notice", "source": "uploaded", "required": true }, { "key": "copy_to_auditor", "title": "Prompt copy of the notice sent to the auditor", "source": "generated", "required": true }, { "key": "notice_of_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes recording the resolution", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting" } ], "signatures": [ { "document_key": "special_notice", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_meeting", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_permitted", "type": null, "when": "[invalid_request_error] Removal by written resolution is not allowed (s288)." }, { "code": "special_notice_period_not_met", "type": null, "when": "[requirement_error] Meeting under 28 days after notice and not called for an earlier date." }, { "code": "copy_to_auditor_missing", "type": null, "when": "[requirement_error] No prompt copy sent to the auditor." } ] } }, "Params_uk_auditor_resign": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "auditor_id": { "type": "string", "description": "Auditor record id." }, "reason": { "type": "string", "enum": [ "resignation", "not_seeking_reappointment", "term_ended", "removed", "other" ], "description": "Why the auditor ceases." }, "effective_date": { "type": "string", "format": "date", "description": "Date the term of office ends." }, "statement_type": { "type": "string", "enum": [ "matters_to_report", "no_matters_to_report", "not_required_end_of_appointing_period", "not_required_exempt_reasons" ], "description": "What the auditor's s519 statement is." }, "statement_document_id": { "type": "string", "pattern": "^doc_", "description": "The auditor's signed statement; required unless not_required_*." }, "public_interest_company": { "type": "boolean", "description": "True: the notice is only effective with the statement (s516) and a copy goes to the audit authority." }, "court_application_notice": { "type": "object", "description": "s520 notice: received, date, outcome." }, "registrar_copy_route": { "type": "string", "enum": [ "auditor_files", "entiva_relays_for_auditor" ], "description": "Who sends the s521 copy to Companies House." } }, "required": [ "auditor_id", "reason", "effective_date", "statement_type" ], "description": "Records that the auditor resigned or otherwise ceased, tracks the auditor's s519 statement and the copy to the registrar, and prompts a replacement." }, "Create_uk_auditor_resign": { "type": "object", "properties": { "type": { "const": "uk.auditor.resign" }, "params": { "$ref": "#/components/schemas/Params_uk_auditor_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record an auditor's resignation or cessation and the s519 statement", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "auditor_notice", "title": "Resignation notice or letter of cessation", "source": "uploaded", "required": true }, { "key": "s519_statement", "title": "Auditor's statement on ceasing to hold office", "source": "uploaded", "required": false }, { "key": "board_minute", "title": "Board minute noting the cessation", "source": "generated", "required": true } ], "people": [ { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "auditor_notice", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "s519_statement", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_minute", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "None identified", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "statement_missing", "type": null, "when": "[requirement_error] A s519 statement is required and not supplied." }, { "code": "registrar_copy_not_required", "type": null, "when": "[invalid_request_error] Non-public-interest company and the statement reports nothing (s519, s521)." }, { "code": "replacement_needed", "type": null, "when": "[requirement_error] No replacement auditor and the company is not audit-exempt." } ] } }, "Params_uk_director_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "appointment_type": { "type": "string", "enum": [ "individual", "corporate" ], "description": "individual: AP01. corporate: AP02." }, "person": { "type": "string", "pattern": "^per_", "description": "Individual director's per_ record." }, "corporate_director": { "type": "object", "description": "Corporate: name, principal_office, service_address, legal_form, governing_law, register_name, registration_number, acting_person_id." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Service address, or \"registered_office\"." }, "effective_date": { "type": "string", "format": "date", "description": "Date appointed; starts the 14-day clock." }, "appointed_by": { "type": "string", "enum": [ "board_decision", "ordinary_resolution", "other_under_articles" ], "description": "Organ that appointed." }, "director_kind": { "type": "string", "enum": [ "standard", "alternate", "nominee" ], "description": "nominee also needs uk.nominee_director.arrange." }, "personal_code": { "type": "string", "description": "11-character Companies House personal code, write-only; omit if Entiva verifies the person." }, "disqualification_statement": { "type": "object", "description": "not_disqualified; court_permission {court, date}; sanctions_licence {issued_on, issued_by} (s167G-)." } }, "required": [ "appointment_type", "effective_date", "appointed_by" ], "description": "Appoints an individual or corporate director, collects Companies House identity verification and the personal code, and notifies Companies House within 14 days." }, "Create_uk_director_appoint": { "type": "object", "properties": { "type": { "const": "uk.director.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution appointing the director", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act and company statement", "source": "generated", "required": true }, { "key": "corporate_kyb_pack", "title": "Corporate director KYB pack", "source": "uploaded", "required": false }, { "key": "ap01_filing", "title": "AP01/AP02 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "alternate_director", "verification_level": "registry_idv" }, { "role": "director", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ap01_filing", "signer_role": "appointee", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ap01_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AP01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_identity_not_verified", "type": null, "when": "" }, { "code": "director_disqualified", "type": null, "when": "[requirement_error] Disqualification, bankruptcy or sanctions match without permission or licence; appointment void." }, { "code": "natural_person_director_required", "type": null, "when": "[requirement_error] No natural-person director would exist." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried the selfie, verification or consent." } ] } }, "Params_uk_director_remove": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "officer_id": { "type": "string", "description": "per_ id of the director to remove." }, "proposer": { "type": "string", "pattern": "^per_", "description": "Member who gives special notice." }, "special_notice_received_date": { "type": "string", "format": "date", "description": "Date the company received special notice." }, "meeting_date": { "type": "string", "format": "date", "description": "General meeting, at least 28 days after special notice unless called for an earlier date." }, "director_representations": { "type": "object", "description": "received, document_id, received_in_time; drives the s169 circulation or reading-out step." }, "replacement_director": { "type": "object", "description": "Optional appointment at the same meeting: person_id, appointment_type." }, "votes": { "type": "object", "description": "votes_for, votes_against, abstentions, quorum_met; required before filing." } }, "required": [ "officer_id", "proposer", "special_notice_received_date", "meeting_date" ], "description": "Runs the statutory removal route: special notice, copy to the director, general meeting, ordinary resolution, then TM01 within 14 days." }, "Create_uk_director_remove": { "type": "object", "properties": { "type": { "const": "uk.director.remove" }, "params": { "$ref": "#/components/schemas/Params_uk_director_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a director by members' resolution, then file TM01", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_notice", "title": "Member's special notice", "source": "uploaded", "required": true }, { "key": "notice_of_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes recording the ordinary resolution", "source": "generated", "required": true }, { "key": "tm01_filing", "title": "TM01 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting" } ], "signatures": [ { "document_key": "special_notice", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_meeting", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "tm01_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "TM01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "written_resolution_not_permitted", "type": null, "when": "[invalid_request_error] Removal by written resolution is not allowed (s288)." }, { "code": "special_notice_period_not_met", "type": null, "when": "[requirement_error] Meeting under 28 days after notice and not called for an earlier date." }, { "code": "director_representations_pending", "type": null, "when": "[requirement_error] Representations not yet circulated or read out." }, { "code": "natural_person_director_required", "type": null, "when": "[requirement_error] No natural-person director would remain." } ] } }, "Params_uk_disclosure_protection_apply": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "protection_type": { "type": "string", "enum": [ "s243", "s790ZF", "s790ZG", "s790ZF_and_s790ZG", "s243_by_s790ZF_beneficiary", "s790ZF_by_s243_beneficiary", "s1088_register_removal" ], "description": "s243: director's home address withheld from credit reference agencies. s790ZF: same for a PSC. s790ZG: PSC's secured information kept off the register.." }, "register_kind": { "type": "string", "enum": [ "company", "llp", "eligible_scottish_partnership" ], "description": "Register the person is on; Scottish partnerships use SI 2017/694 regs 48-50." }, "applicant_kind": { "type": "string", "enum": [ "individual", "entity_on_behalf", "subscriber" ], "description": "An entity or subscriber applies only with the individual's consent." }, "beneficiary": { "type": "string", "pattern": "^per_", "description": "The director or PSC." }, "ground": { "type": "string", "enum": [ "serious_risk", "relevant_employment", "earlier_determination" ], "description": "serious_risk: reasonable belief of serious risk of violence or intimidation. relevant_employment: s243 only. earlier_determination: a s243 or s790ZF decision." }, "statement_of_grounds": { "type": "string", "description": "Statement of grounds." }, "linked_entities": { "type": "array", "items": {}, "description": "Each company, LLP or partnership concerned." }, "evidence_documents": { "type": "array", "items": {}, "description": "Required for serious_risk and relevant_employment." }, "register_documents": { "type": "array", "items": {}, "description": "For s1088_register_removal: each document, the address, and a replacement service address where the address must stay on the register." } }, "required": [ "protection_type", "register_kind", "applicant_kind", "beneficiary", "ground", "statement_of_grounds", "linked_entities" ], "description": "Applies to the registrar to withhold a director's or PSC's home address from credit reference agencies, keep a PSC's secured information off the register, or remove an address from filed documents." }, "Create_uk_disclosure_protection_apply": { "type": "object", "properties": { "type": { "const": "uk.disclosure_protection.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_disclosure_protection_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Protect a residential address or PSC information from disclosure", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_of_grounds", "title": "Statement of grounds", "source": "generated", "required": true }, { "key": "application", "title": "Application", "source": "generated", "required": true }, { "key": "evidence", "title": "Supporting evidence", "source": "uploaded", "required": false }, { "key": "decision_notice", "title": "Registrar's decision notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_grounds", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application", "signer_role": "incorporator", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "s243, s790ZF, s790ZG and personal-details removal applications", "channel": "both", "government_fee": { "amount": 100, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ground_not_supported", "type": null, "when": "[requirement_error] Evidence does not support the ground." }, { "code": "consent_missing", "type": null, "when": "[requirement_error] Entity or subscriber application without the individual's consent." }, { "code": "address_required_on_register", "type": null, "when": "[requirement_error] s1088: the address is a current address the company must keep and no service address replaces it (reg 9)." } ] } }, "Params_uk_limited_partnership_particulars_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "entity_type": { "type": "string", "enum": [ "lp", "pflp", "slp" ], "description": "Defaults to the entity's type; PFLPs notify fewer changes." }, "change_type": { "type": "string", "enum": [ "firm_name", "principal_place_of_business", "general_nature_of_business", "term_or_character", "limited_partner_contribution" ], "description": "What changed." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; starts the 7-day clock." }, "firm_name": { "type": "string", "description": "Must end 'limited partnership' or 'LP'." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "New principal place of business." }, "general_nature": { "type": "string", "description": "General nature of the business." }, "term": { "type": "string", "description": "New term, or 'indefinite'." }, "contribution_change": { "type": "object", "description": "limited_partner_id and new_contribution." } }, "required": [ "change_type", "effective_date" ], "description": "Notifies Companies House within 7 days of a change to the firm name, principal place of business, nature of business, term or a limited partner's contribution." }, "Create_uk_limited_partnership_particulars_change": { "type": "object", "properties": { "type": { "const": "uk.limited_partnership_particulars.change" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_partnership_particulars_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a limited partnership's name, place of business, nature of business, term or contributions", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partner_decision", "title": "Partners' decision", "source": "generated", "required": true }, { "key": "amended_agreement", "title": "Amended partnership agreement", "source": "uploaded", "required": false }, { "key": "lp6_statement", "title": "LP6 statement of change", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partner_decision", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp6_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP6", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "firm_name_invalid_ending", "type": null, "when": "[invalid_request_error] Name lacks the required ending." }, { "code": "not_notifiable_for_pflp", "type": null, "when": "[invalid_request_error] Nature, term and contribution changes are not notifiable for a PFLP (s9)." }, { "code": "principal_place_moves_jurisdiction", "type": null, "when": "" } ] } }, "Params_uk_limited_partnership_partner_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "entity_type": { "type": "string", "enum": [ "lp", "pflp", "slp" ], "description": "Defaults to the entity's type; PFLPs and SLPs have different rules." }, "change_type": { "type": "string", "enum": [ "general_partner_added", "general_partner_ceased", "limited_partner_added", "limited_partner_ceased", "partner_name_changed", "general_became_limited", "limited_became_general" ], "description": "What changed (s9)." }, "partner": { "type": "string", "pattern": "^per_", "description": "Individual partner's per_ record." }, "partner_entity": { "type": "object", "description": "Corporate partner: name, registered_number, legal_form, governing_law, principal_office, acting_person_id." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; starts the 7-day clock." }, "contribution": { "$ref": "#/components/schemas/Money", "description": "New limited partner's contribution." }, "partner_name": { "type": "string", "description": "For partner_name_changed." } }, "required": [ "change_type", "effective_date" ], "description": "Notifies Companies House within 7 days of a new or departing general or limited partner, a partner's name change, or a partner switching between general and limited status." }, "Create_uk_limited_partnership_partner_change": { "type": "object", "properties": { "type": { "const": "uk.limited_partnership_partner.change" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_partnership_partner_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the partners of a limited partnership", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partner_decision", "title": "Partners' decision", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice", "source": "generated", "required": false }, { "key": "lp6_statement", "title": "LP6 statement of change", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partner_decision", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp6_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP6", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "general_partner_required", "type": null, "when": "[requirement_error] No general partner would remain (s4)." }, { "code": "limited_partner_required", "type": null, "when": "[requirement_error] No limited partner would remain (s4)." }, { "code": "gazette_advertisement_pending", "type": null, "when": "[requirement_error] A status change has no effect until advertised in the Gazette (s10)." } ] } }, "Params_uk_nominee_director_hold": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "provider": { "type": "string", "enum": [ "customer_supplied", "entiva_partner" ], "description": "customer_supplied: customer's own nominee. entiva_partner: Entiva individual acts." }, "nominee": { "type": "string", "pattern": "^per_", "description": "Nominee director's per_ record." }, "nominator": { "type": "object", "description": "person_id or entity details of who instructs the nominee, plus relationship and reason." }, "start_date": { "type": "string", "format": "date", "description": "Date the arrangement starts." }, "nominee_agreement_document_id": { "type": "string", "pattern": "^doc_", "description": "Nominee or service agreement." }, "nominator_controls_board_or_votes": { "type": "boolean", "description": "True raises a PSC assessment for the nominator." } }, "required": [ "provider", "nominator", "start_date", "nominee_agreement_document_id" ], "description": "The UK needs no resident or nominee director. If the customer uses one, this records the arrangement and runs enhanced due diligence on nominee and nominator." }, "Create_uk_nominee_director_hold": { "type": "object", "properties": { "type": { "const": "uk.nominee_director.hold" }, "params": { "$ref": "#/components/schemas/Params_uk_nominee_director_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a nominee director arrangement", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nominee_agreement", "title": "Nominee or service agreement", "source": "uploaded", "required": true }, { "key": "nominator_wealth_evidence", "title": "Nominator source of wealth and funds evidence", "source": "uploaded", "required": true }, { "key": "edd_decision", "title": "EDD decision and senior-management approval", "source": "generated", "required": true } ], "people": [ { "role": "nominee_director", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nominee_agreement", "signer_role": "nominator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "edd_decision", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None: UK law has no register entry for a nominee arrangement", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "edd_not_approved", "type": null, "when": "[requirement_error] Senior-management approval missing." }, { "code": "nominator_unverified", "type": null, "when": "[requirement_error] Nominator identity, wealth or funds evidence incomplete." }, { "code": "provider_not_licensed", "type": null, "when": "[jurisdiction_error] No AML-supervised partner available (MLR reg 12)." } ] } }, "Params_uk_officer_remove": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "office": { "type": "string", "enum": [ "director", "llp_member", "secretary" ], "description": "director: TM01. llp_member: LL TM01. secretary: TM02." }, "officer_id": { "type": "string", "description": "per_ id of the individual, or the corporate officer's id." }, "termination_date": { "type": "string", "format": "date", "description": "Date the person ceased; starts the 14-day clock." }, "reason": { "type": "string", "enum": [ "resignation", "removal_by_members", "removal_by_directors", "expulsion", "disqualification", "bankruptcy_or_composition", "incapacity", "death", "not_reappointed", "other" ], "description": "Removal of a director by members goes through uk.director.remove." }, "resignation_notice_document_id": { "type": "string", "pattern": "^doc_", "description": "Signed notice; required for resignation." }, "successor_action_id": { "type": "string", "description": "act_ id of the appointment that fills the gap." } }, "required": [ "office", "officer_id", "termination_date", "reason" ], "description": "Records that a director, LLP member or secretary resigned, died or otherwise ceased, and notifies Companies House within 14 days." }, "Create_uk_officer_remove": { "type": "object", "properties": { "type": { "const": "uk.officer.remove" }, "params": { "$ref": "#/components/schemas/Params_uk_officer_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Terminate a director's, LLP member's or secretary's appointment", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Notice of resignation", "source": "uploaded", "required": false }, { "key": "board_minute", "title": "Board minute noting the cessation", "source": "generated", "required": true }, { "key": "tm01_filing", "title": "TM01/LL TM01/TM02 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resignation_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_minute", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "tm01_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "TM01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "natural_person_director_required", "type": null, "when": "[requirement_error] No natural-person director would remain." }, { "code": "plc_requires_secretary", "type": null, "when": "[requirement_error] A PLC must always have a secretary." }, { "code": "llp_minimum_members", "type": null, "when": "[requirement_error] Fewer than two members or no designated member would remain." }, { "code": "use_removal_action", "type": null, "when": "[invalid_request_error] Use uk.director.remove for removal by members." } ] } }, "Params_uk_officer_details_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "office": { "type": "string", "enum": [ "director", "llp_member", "secretary" ], "description": "director: CH01/CH02. llp_member: LL CH01/LL CH02. secretary: CH03/CH04." }, "officer_id": { "type": "string", "description": "per_ id of the individual, or the corporate officer's id." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change occurred; starts the 14-day clock." }, "changes": { "type": "object", "description": "New values only." }, "name_change_evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Deed poll or marriage certificate; required when a name changes." } }, "required": [ "office", "officer_id", "effective_date", "changes" ], "description": "Notifies Companies House of a change to an officer's name, addresses, nationality or country of residence, or a corporate officer's particulars, within 14 days." }, "Create_uk_officer_details_change": { "type": "object", "properties": { "type": { "const": "uk.officer_details.change" }, "params": { "$ref": "#/components/schemas/Params_uk_officer_details_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the details of a director, LLP member or secretary", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "name_change_evidence", "title": "Name-change evidence", "source": "uploaded", "required": false }, { "key": "proof_of_address", "title": "Proof of address dated within 3 months", "source": "uploaded", "required": false }, { "key": "change_filing", "title": "CH01-CH04/LL CH01/LL CH02 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "change_filing", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "change_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "CH01/CH02", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_changes_supplied", "type": null, "when": "[invalid_request_error] changes is empty or repeats current values." }, { "code": "name_change_evidence_required", "type": null, "when": "[requirement_error] Name changed with no evidence." }, { "code": "immutable_field", "type": null, "when": "[invalid_request_error] Date of birth sent; use the register-correction action." } ] } }, "Params_uk_officer_identity_verify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "person": { "type": "string", "pattern": "^per_", "description": "The individual to verify." }, "role": { "type": "string", "enum": [ "director", "llp_member" ], "description": "Role the verification supports." }, "purpose": { "type": "string", "enum": [ "new_appointment", "existing_officer" ], "description": "new_appointment: before AP01/LL AP01. existing_officer: code goes in the next confirmation statement." }, "route": { "type": "string", "enum": [ "entiva_acsp", "existing_personal_code" ], "description": "entiva_acsp or existing_personal_code." }, "personal_code": { "type": "string", "description": "For existing_personal_code; write-only." }, "appointment_action_id": { "type": "string", "description": "Linked appointment action." } }, "required": [ "person", "role", "purpose" ], "description": "Entiva, as registered ACSP, verifies the person and tells Companies House, which emails the 11-character code used on appointments and confirmation statements." }, "Create_uk_officer_identity_verify": { "type": "object", "properties": { "type": { "const": "uk.officer_identity.verify" }, "params": { "$ref": "#/components/schemas/Params_uk_officer_identity_verify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Verify a director's or LLP member's identity and obtain their Companies House personal code", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "photo_id", "title": "Photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of address / 12-month address history", "source": "uploaded", "required": false }, { "key": "acsp_confirmation", "title": "Companies House confirmation page, kept 7 years", "source": "registry_issued", "required": true }, { "key": "verification_record", "title": "Entiva verification record", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "verification_record", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "verification_record", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "acsp_confirmation", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House: ACSP service 'Tell Companies House you have verified someone's identity'", "form": "ACSP verification notification", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried the selfie, document check or consent." }, { "code": "verification_failed", "type": null, "when": "[requirement_error] Checks failed; last_error says why and the person can retry." }, { "code": "already_verified", "type": null, "when": "[invalid_request_error] Person already holds a code; Companies House says do not verify again unless asked." } ] } }, "Params_uk_overseas_company_officer_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "establishment_numbers": { "type": "array", "items": {}, "description": "BR numbers of the affected UK establishments; one return can cover several." }, "role": { "type": "string", "enum": [ "director", "corporate_director", "secretary", "corporate_secretary", "permanent_representative", "service_agent" ], "description": "OS AP01 director, AP02 corporate director, AP03 secretary, AP04 corporate secretary, AP05 permanent representative, AP07 service agent." }, "person": { "type": "string", "pattern": "^per_", "description": "Individual officer." }, "corporate_officer": { "type": "object", "description": "name, principal_office, legal_form, governing_law, register_name, registration_number, acting_person_id." }, "effective_date": { "type": "string", "format": "date", "description": "Date appointed; starts the 21-day clock." }, "representation_powers": { "type": "object", "description": "Extent of powers to represent the company; alone or jointly; names of any joint persons." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "A UK service agent's address must show the company's name and country of incorporation." }, "personal_code": { "type": "string", "description": "Director's 11-character personal code, write-only." } }, "required": [ "role", "effective_date", "representation_powers" ], "description": "Notifies Companies House of a new director, secretary, permanent representative or person authorised to accept service of a UK establishment." }, "Create_uk_overseas_company_officer_appoint": { "type": "object", "properties": { "type": { "const": "uk.overseas_company_officer.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_company_officer_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an officer or representative of an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "home_resolution", "title": "Overseas company resolution", "source": "uploaded", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "os_filing", "title": "OS AP form filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "home_resolution", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "os_filing", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "os_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS AP01, AP02, AP03, AP04, AP05 or AP07", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_identity_not_verified", "type": null, "when": "" }, { "code": "representation_powers_missing", "type": null, "when": "[requirement_error] Extent of powers or alone/jointly not stated." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried the verification or consent." } ] } }, "Params_uk_overseas_company_officer_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "establishment_numbers": { "type": "array", "items": {}, "description": "BR numbers of the affected UK establishments; one return can cover several." }, "change_type": { "type": "string", "enum": [ "change_details", "terminate" ], "description": "change_details: OS CH03 director, CH04 corporate director, CH05 secretary, CH06 corporate secretary, CH07 representative, CH09 service agent. terminate: OS." }, "role": { "type": "string", "enum": [ "director", "corporate_director", "secretary", "corporate_secretary", "permanent_representative", "service_agent" ], "description": "Role of the officer." }, "officer_id": { "type": "string", "description": "per_ id or corporate officer id." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change or termination; starts the 21-day clock." }, "changes": { "type": "object", "description": "For change_details: new values only, including representation_powers where they change." }, "successor_action_id": { "type": "string", "description": "For terminate: linked appointment." } }, "required": [ "change_type", "role", "officer_id", "effective_date" ], "description": "Notifies Companies House of changed details of, or the end of, a director, secretary, representative or service agent of a UK establishment, within 21 days." }, "Create_uk_overseas_company_officer_change": { "type": "object", "properties": { "type": { "const": "uk.overseas_company_officer.change" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_company_officer_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change details of, or end the appointment of, an officer or representative of an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence", "title": "Supporting evidence or home-law resolution", "source": "uploaded", "required": false }, { "key": "os_filing", "title": "OS CH/TM form filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "os_filing", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "os_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS CH03-CH07 or CH09", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_changes_supplied", "type": null, "when": "[invalid_request_error] change_details without changes." }, { "code": "last_service_agent", "type": null, "when": "[requirement_error] The establishment would have no person authorised to accept service." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the return." } ] } }, "Params_uk_overseas_company_verification_statement_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "establishment_numbers": { "type": "array", "items": {}, "description": "BR numbers of the affected UK establishments; one return can cover several." }, "directors": { "type": "array", "items": {}, "description": "Each director: person_id and personal_code." }, "anniversary_date": { "type": "string", "format": "date", "description": "Deadline: anniversary of the establishment's opening or registration." } }, "required": [ "directors" ], "description": "Confirms to Companies House that every director of the overseas company has verified their identity, with their personal codes, by the establishment's anniversary." }, "Create_uk_overseas_company_verification_statement_file": { "type": "object", "properties": { "type": { "const": "uk.overseas_company_verification_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_company_verification_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the directors' identity verification statement for an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "vs01_filing", "title": "OS VS01 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "vs01_filing", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "vs01_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS VS01", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_unverified", "type": null, "when": "[requirement_error] A director has not completed verification; see uk.officer_identity.verify." }, { "code": "director_code_mismatch", "type": null, "when": "[requirement_error] A personal code does not match the director." }, { "code": "statement_not_due", "type": null, "when": "[requirement_error] Codes were already given on a return." } ] } }, "Params_uk_plc_secretary_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "secretary_type": { "type": "string", "enum": [ "individual", "corporate" ], "description": "individual: AP03. corporate: AP04." }, "person": { "type": "string", "pattern": "^per_", "description": "Individual secretary's per_ record." }, "corporate_secretary": { "type": "object", "description": "Corporate secretary particulars." }, "effective_date": { "type": "string", "format": "date", "description": "Date appointed; starts the 14-day clock." }, "qualification_basis": { "type": "string", "enum": [ "held_plc_secretary_3_of_5_years", "professional_body_member", "barrister_advocate_solicitor", "directors_opinion_other" ], "description": "s273 route to qualification." }, "qualifying_body": { "type": "string", "enum": [ "icaew", "icas", "chartered_accountants_ireland", "acca", "cgi_icsa", "cima", "cipfa" ], "description": "Required for professional_body_member (s273)." }, "membership_number": { "type": "string", "description": "Membership, practising or admission number." }, "directors_reasonable_steps_confirmed": { "type": "boolean", "description": "Directors took all reasonable steps to ensure the s273 conditions." } }, "required": [ "secretary_type", "effective_date", "qualification_basis", "directors_reasonable_steps_confirmed" ], "description": "Appoints or replaces the mandatory secretary of a PLC after checking the s273 qualification route, and notifies Companies House within 14 days." }, "Create_uk_plc_secretary_appoint": { "type": "object", "properties": { "type": { "const": "uk.plc_secretary.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_plc_secretary_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a qualified secretary of a public company", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "qualification_evidence", "title": "Evidence of the s273 qualification", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution recording the s273 steps", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "ap03_filing", "title": "AP03/AP04 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ap03_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AP03", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "secretary_not_qualified", "type": null, "when": "[requirement_error] Evidence supports no s273 route." }, { "code": "directors_confirmation_missing", "type": null, "when": "[requirement_error] Reasonable-steps confirmation not given." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried the consent to act." } ] } }, "Params_uk_secretarial_service_engage": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "mode": { "type": "string", "enum": [ "entiva_as_secretary", "records_only" ], "description": "entiva_as_secretary: Entiva's UK entity is corporate secretary. records_only: no appointment; Entiva keeps the records." }, "services": { "type": "array", "items": {}, "description": "Any of: registers, minutes_and_resolutions, statutory_filings, sail_custody, execution_support." }, "start_date": { "type": "string", "format": "date", "description": "Date the service and any appointment starts." }, "instructing": { "type": "string", "pattern": "^per_", "description": "Director or authorised person who instructs Entiva." } }, "required": [ "mode", "services", "start_date", "instructing" ], "description": "Starts the optional secretarial service for a private company, CIC or charitable company: Entiva as corporate secretary or as records keeper only." }, "Create_uk_secretarial_service_engage": { "type": "object", "properties": { "type": { "const": "uk.secretarial_service.engage" }, "params": { "$ref": "#/components/schemas/Params_uk_secretarial_service_engage" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Engage Entiva for company secretarial service", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_terms", "title": "Secretarial engagement terms", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution appointing Entiva and fixing record locations", "source": "generated", "required": true }, { "key": "cdd_pack", "title": "Customer CDD pack: certificate, constitution, register of members, ownership chart", "source": "uploaded", "required": true }, { "key": "ap04_filing", "title": "AP04 filing data", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "engagement_terms", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ap04_filing", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ap04_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AP04", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "cdd_incomplete", "type": null, "when": "[requirement_error] Customer or beneficial-owner CDD incomplete; Entiva cannot start." }, { "code": "llp_appointment_not_available", "type": null, "when": "[jurisdiction_error] LLPs have no secretary; only records_only applies." }, { "code": "plc_requires_qualified_secretary", "type": null, "when": "[requirement_error] Entity is a PLC; use uk.plc_secretary.appoint." } ] } }, "Params_uk_secretary_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "secretary_type": { "type": "string", "enum": [ "individual", "corporate" ], "description": "individual: AP03. corporate: AP04." }, "person": { "type": "string", "pattern": "^per_", "description": "Individual secretary's per_ record." }, "corporate_secretary": { "type": "object", "description": "Corporate: name, principal_office, service_address, legal_form, governing_law, register_name, registration_number, acting_person_id." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Service address, or \"registered_office\"." }, "effective_date": { "type": "string", "format": "date", "description": "Date appointed; starts the 14-day clock." }, "joint_secretary": { "type": "boolean", "description": "True for one of joint secretaries." } }, "required": [ "secretary_type", "effective_date" ], "description": "Appoints an individual or corporate secretary of a private company, CIC or charitable company and notifies Companies House within 14 days." }, "Create_uk_secretary_appoint": { "type": "object", "properties": { "type": { "const": "uk.secretary.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_secretary_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a company secretary", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "cic", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution appointing the secretary", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act and company statement", "source": "generated", "required": true }, { "key": "ap03_filing", "title": "AP03/AP04 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ap03_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AP03", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_plc_secretary_action", "type": null, "when": "[invalid_request_error] Entity is a PLC; use uk.plc_secretary.appoint." }, { "code": "llp_has_no_secretary", "type": null, "when": "[jurisdiction_error] LLPs have no secretary office." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried the consent to act." } ] } }, "Params_uk_ukeig_documents_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "document_type": { "type": "string", "enum": [ "name_change", "formation_contract_amendment", "official_address_transfer", "other_article_7_document" ], "description": "What is being notified." }, "event_date": { "type": "string", "format": "date", "description": "Date of the event; starts the 15-day clock." }, "name": { "type": "string", "description": "For name_change; must meet reg 10." }, "documents": { "type": "array", "items": {}, "description": "Amended contract or other document; non-English documents need a certified English translation." } }, "required": [ "document_type", "event_date", "documents" ], "description": "Delivers an amended formation contract, official-address transfer or name change to Companies House within 15 days." }, "Create_uk_ukeig_documents_notify": { "type": "object", "properties": { "type": { "const": "uk.ukeig_documents.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_ukeig_documents_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give notice of documents and particulars of a UKEIG, including a name change", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amended_contract", "title": "Amended formation contract or document", "source": "uploaded", "required": true }, { "key": "ee_mp01_filing", "title": "EE MP01 filing data", "source": "generated", "required": true }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "members_decision", "title": "Members' decision approving the change", "source": "generated", "required": true }, { "key": "altered_certificate", "title": "Altered certificate of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "members_decision", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ee_mp01_filing", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "EE MP01", "channel": "paper", "government_fee": { "amount": 30, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_not_permitted", "type": null, "when": "[requirement_error] The name fails reg 10 or the similar-name rules." }, { "code": "translation_missing", "type": null, "when": "[requirement_error] Non-English document without a certified translation." }, { "code": "fee_not_paid", "type": null, "when": "[registry_error] Name-change notice rejected without the GBP 30 fee." } ] } }, "Params_uk_ukeig_manager_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "manager_type": { "type": "string", "enum": [ "individual", "corporate" ], "description": "individual: EE AP01. corporate: EE AP02." }, "person": { "type": "string", "pattern": "^per_", "description": "Individual manager." }, "corporate_manager": { "type": "object", "description": "name, principal_office, service_address, legal_form, governing_law, register_name, registration_number." }, "representatives": { "type": "array", "items": {}, "description": "Natural persons a corporate manager designates; each is notified and carries manager liability (reg 5-)." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Or \"official_address\" (reg 5)." }, "effective_date": { "type": "string", "format": "date", "description": "Date appointed; starts the 15-day clock." } }, "required": [ "manager_type", "effective_date" ], "description": "Notifies Companies House of a new individual or corporate manager of a UK economic interest grouping within 15 days." }, "Create_uk_ukeig_manager_appoint": { "type": "object", "properties": { "type": { "const": "uk.ukeig_manager.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_ukeig_manager_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a UKEIG manager", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_decision", "title": "Members' decision appointing the manager", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "ee_filing", "title": "EE AP01/AP02 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "members_decision", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ee_filing", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "EE AP01", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "consent_missing", "type": null, "when": "[requirement_error] Manager has not consented to act." }, { "code": "representative_required", "type": null, "when": "[requirement_error] A corporate manager has no designated natural person (reg 5)." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried the consent to act." } ] } }, "Params_uk_ukeig_manager_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "From the entity; send only to assert it." }, "change_type": { "type": "string", "enum": [ "change_details", "terminate" ], "description": "change_details: EE CH01 individual, EE CH02 corporate. terminate: EE TM01." }, "manager_id": { "type": "string", "description": "per_ id or corporate manager id." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change or termination; starts the 15-day clock." }, "previous_registered_name": { "type": "string", "description": "For change_details: the name now on the register (reg 5)." }, "changes": { "type": "object", "description": "For change_details: new values only." }, "reason": { "type": "string", "enum": [ "resignation", "removal", "death", "other" ], "description": "For terminate." } }, "required": [ "change_type", "manager_id", "effective_date" ], "description": "Notifies Companies House of changed particulars of a UKEIG manager, or that the manager has ceased, within 15 days." }, "Create_uk_ukeig_manager_change": { "type": "object", "properties": { "type": { "const": "uk.ukeig_manager.change" }, "params": { "$ref": "#/components/schemas/Params_uk_ukeig_manager_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the details of, or end the appointment of, a UKEIG manager", "x-entiva": { "jurisdiction": "uk", "stage": "officers_and_people", "applies_to": [ "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence", "title": "Supporting evidence or resignation notice", "source": "uploaded", "required": false }, { "key": "ee_filing", "title": "EE CH01/CH02/TM01 filing data", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "ee_filing", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ee_filing", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "EE CH01, EE CH02 or EE TM01", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "previous_name_mismatch", "type": null, "when": "[requirement_error] previous_registered_name does not match the register." }, { "code": "no_changes_supplied", "type": null, "when": "[invalid_request_error] change_details without changes." }, { "code": "no_manager_remaining", "type": null, "when": "[requirement_error] The UKEIG would have no manager." } ] } }, "Params_uk_capital_payment_approve": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "cic" ], "description": "Private companies only." }, "route": { "type": "string", "enum": [ "chapter_5_directors_statement", "employee_share_scheme_solvency_statement" ], "description": "chapter_5_directors_statement: ss709-723. employee_share_scheme_solvency_statement: purchase for or under an employees' share scheme, special resolution." }, "purpose": { "type": "string", "enum": [ "purchase_of_own_shares", "redemption_of_redeemable_shares" ], "description": "The route employee_share_scheme_solvency_statement covers purchases only." }, "total_price": { "$ref": "#/components/schemas/Money", "description": "Price of the redemption or purchase." }, "available_profits": { "$ref": "#/components/schemas/Money", "description": "Available profits under ss711-712, taken from the relevant accounts." }, "fresh_issue_proceeds": { "$ref": "#/components/schemas/Money", "description": "Proceeds of any fresh issue made to fund the payment." }, "permissible_capital_payment": { "$ref": "#/components/schemas/Money", "description": "Total price less available profits less fresh issue proceeds." }, "relevant_accounts_date": { "type": "string", "format": "date", "description": "Date of the accounts used to measure available profits." }, "directors_statement_date": { "type": "string", "format": "date", "description": "Date the directors make the statement, or the solvency statement date for the s720A route." }, "resolution_date": { "type": "string", "format": "date", "description": "Chapter 5: the date of the statement or within the following week." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "Members whose shares are affected are not eligible members or cannot decide the vote." }, "proposed_payment_date": { "type": "string", "format": "date", "description": "Chapter 5: must fall from 5 weeks to 7 weeks after the resolution." }, "creditor_notice_method": { "type": "string", "enum": [ "national_newspaper", "written_notice_to_each_creditor" ], "description": "Chapter 5: alongside the Gazette notice, one of these within a week of the resolution." }, "inspection_location": { "$ref": "#/components/schemas/Address", "description": "Where the statement and report are kept for inspection." }, "auditor": { "type": "object", "description": "Chapter 5: {firm_name, contact_email}.", "examples": [ "{\"firm_name\":\"Calder Rowe LLP\",\"contact_email\":\"audit@calderrowe.example\"}" ] }, "shares_affected": { "type": "array", "items": {}, "description": "Items {holder, share_class, number_of_shares}." }, "cic_paid_up_value_confirmed": { "type": "boolean", "description": "Required for cic." } }, "required": [ "registration_jurisdiction", "entity_type", "route", "purpose", "total_price", "available_profits", "relevant_accounts_date", "directors_statement_date", "resolution_date", "resolution_method", "shares_affected" ], "description": "A private company that lacks enough distributable profits can fund a redemption or purchase out of capital. Entiva runs the Part 18 Chapter 5 procedure: directors' statement and auditor's report, special resolution, Gazette and creditor." }, "Create_uk_capital_payment_approve": { "type": "object", "properties": { "type": { "const": "uk.capital_payment.approve" }, "params": { "$ref": "#/components/schemas/Params_uk_capital_payment_approve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Authorise a payment out of capital to redeem or buy back own shares", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_statement", "title": "Directors' statement or solvency statement", "source": "generated", "required": true }, { "key": "auditors_report", "title": "Auditor's report on the directors' statement", "source": "uploaded", "required": false }, { "key": "special_resolution", "title": "Special resolution approving the payment", "source": "generated", "required": true }, { "key": "relevant_accounts", "title": "Accounts used to measure available profits", "source": "uploaded", "required": true }, { "key": "gazette_notice", "title": "Notice in The Gazette", "source": "generated", "required": false }, { "key": "creditor_or_newspaper_notice", "title": "Creditor letters or national newspaper notice", "source": "generated", "required": false }, { "key": "directors_confirmation_s720b", "title": "Directors' confirmation and statement of capital", "source": "generated", "required": false }, { "key": "companies_house_receipt", "title": "Companies House receipts", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "auditor", "verification_level": "none" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_statement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditors_report", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_confirmation_s720b", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "No numbered form identified: upload the s714 statement, auditor's report and special resol", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "articles_prohibit_capital_payment", "type": null, "when": "The articles restrict or prohibit payment out of capital." }, { "code": "permissible_payment_mismatch", "type": null, "when": "Supplied figures do not equal price minus available profits minus fresh issue proceeds." }, { "code": "resolution_outside_week", "type": null, "when": "The resolution is more than a week after the directors' statement date." }, { "code": "auditor_report_missing", "type": null, "when": "No auditor's report is annexed to the directors' statement (s714)." }, { "code": "affected_votes_counted", "type": null, "when": "A member whose shares are affected voted or counted as eligible." }, { "code": "notice_late", "type": null, "when": "Gazette and creditor or newspaper notices are not published within a week of the resolution." }, { "code": "payment_outside_window", "type": null, "when": "proposed_payment_date is earlier than 5 weeks or later than 7 weeks after the resolution." }, { "code": "creditor_objection_filed", "type": null, "when": "A member or creditor applied to court within 5 weeks; the action is held until the court rules." }, { "code": "solvency_statement_stale", "type": null, "when": "Employee scheme route: the solvency statement is more than 15 days before the resolution." } ] } }, "Params_uk_charge_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company or LLP is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "An llp uses the LL MR forms." }, "registration_basis": { "type": "string", "enum": [ "instrument", "no_instrument", "property_acquired", "property_acquired_no_instrument", "debenture_series", "debenture_series_no_instrument" ], "description": "Selects the form: instrument is MR01, no_instrument MR08, property_acquired MR02, property_acquired_no_instrument MR09, debenture_series MR03." }, "creation_date": { "type": "string", "format": "date", "description": "Date of creation under s859E: delivery of a deed, execution of other instruments, effect for charges without instrument; for a Scottish standard security, the." }, "acquisition_date": { "type": "string", "format": "date", "description": "Required for the property_acquired bases: date the company acquired the property or undertaking." }, "chargeholders": { "type": "array", "items": {}, "description": "Persons, security agents or trustees entitled to the charge: items {name, role}.", "examples": [ "[{\"name\":\"Meridian Growth Lending LLP\",\"role\":\"chargee\"}]" ] }, "more_than_four_chargeholders": { "type": "boolean", "description": "True if more than four persons are entitled." }, "registered_property_description": { "type": "string", "description": "Short description of any UK-registered or registrable land, ship, aircraft or intellectual property subject to a non-floating charge or fixed security." }, "other_fixed_security": { "type": "boolean", "description": "Does the instrument include a non-floating charge or fixed security over other tangible or intangible property not already described." }, "contains_floating_charge": { "type": "boolean", "description": "Is the instrument expressed to contain a floating charge." }, "floating_charge_covers_all_property": { "type": "boolean", "description": "Required when contains_floating_charge is true: covers all the property and undertaking." }, "negative_pledge": { "type": "boolean", "description": "Do the terms prohibit or restrict further security ranking equally with or ahead of this charge." }, "company_acts_as_trustee": { "type": "boolean", "description": "Company holds the charged property as trustee." }, "instrument_document_id": { "type": "string", "pattern": "^doc_", "description": "Signed instrument." }, "no_instrument_details": { "type": "object", "description": "For the no_instrument bases: {nature_of_charge, property_description, secured_obligations}.", "examples": [ "{\"nature_of_charge\":\"Equitable charge\",\"property_description\":\"Book debts\",\"secured_obligations\":\"All monies due under the facility letter\"}" ] }, "debenture_series": { "type": "object", "description": "For debenture_series bases: {trustees[], resolution_dates[], covering_instrument_date}." }, "extension_order_document_id": { "type": "string", "pattern": "^doc_", "description": "Court order extending time (s859F)." }, "filing_for": { "type": "string", "enum": [ "company", "chargee" ], "description": "Whose interest the filing serves." }, "lender_authentication_code": { "type": "string", "description": "Write-only." }, "authenticating_person_name": { "type": "string", "description": "Printed name in MR01 section 9." } }, "required": [ "registration_jurisdiction", "entity_type", "registration_basis", "creation_date", "chargeholders", "other_fixed_security", "contains_floating_charge", "negative_pledge", "authenticating_person_name" ], "description": "Registers a charge created by a company or LLP: a debenture, fixed or floating charge, charge over acquired property, or a series of debentures. Entiva prepares the statement of particulars, redacts and certifies the copy of the." }, "Create_uk_charge_register": { "type": "object", "properties": { "type": { "const": "uk.charge.register" }, "params": { "$ref": "#/components/schemas/Params_uk_charge_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charge at Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "charge_instrument", "title": "Executed charge instrument", "source": "uploaded", "required": false }, { "key": "certified_copy_instrument", "title": "Certified copy of the instrument", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Board resolution approving the charge", "source": "generated", "required": true }, { "key": "mr01_particulars", "title": "Statement of particulars", "source": "generated", "required": true }, { "key": "land_registration_evidence", "title": "Scottish standard security registration evidence", "source": "uploaded", "required": false }, { "key": "extension_order", "title": "Court order extending time", "source": "uploaded", "required": false }, { "key": "charge_certificate", "title": "Certificate of registration of the charge", "source": "registry_issued", "required": true }, { "key": "mr01_filing", "title": "Mr01 filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "chargee", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "charge_instrument", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_instrument", "signer_role": "company_secretary", "method": "qualified_electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_instrument", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "mr01_particulars", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "mr01_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House: online service or software filing", "form": "MR01", "channel": "online", "government_fee": { "amount": 14, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "charge_period_expired", "type": null, "when": "More than 21 days have passed since creation and no extension order is attached; the charge would be void against a liquidator, administrator and creditors." }, { "code": "certified_copy_missing", "type": null, "when": "The basis needs an instrument and no certified copy is attached." }, { "code": "chargeholder_missing", "type": null, "when": "No chargeholder, security agent or trustee is named." }, { "code": "creation_date_invalid", "type": null, "when": "The date does not follow s859E, for example a Scottish standard security dated before recording." }, { "code": "lender_authentication_code_required", "type": null, "when": "filing_for is chargee and software filing is chosen without a code." }, { "code": "pre_2013_charge", "type": null, "when": "The charge was created before 6 April 2013; MG01 is required and unsupported." }, { "code": "floating_charge_scope_missing", "type": null, "when": "contains_floating_charge is true and floating_charge_covers_all_property is absent." } ] } }, "Params_uk_charge_release": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company or LLP is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "An llp uses LL MR05." }, "charge_reference_type": { "type": "string", "enum": [ "charge_code", "legacy_charge" ], "description": "charge_code for charges created on or after 6 April 2013; legacy_charge for earlier ones." }, "charge_code": { "type": "string", "description": "Unique reference code from the certificate.", "examples": [ "1587 2304 0001" ] }, "legacy_charge": { "type": "object", "description": "Pre-6 April 2013: {creation_date, charge_number, instrument_description, short_particulars}." }, "scope": { "type": "string", "enum": [ "part", "all" ], "description": "Part or all of the property or undertaking charged." }, "release_basis": { "type": "string", "enum": [ "released_from_charge", "ceased_to_form_part_of_company_property", "both" ], "description": "MR05 section C1: released from the charge, no longer forms part of the company's property or undertaking, or both." }, "released_property_description": { "type": "string", "description": "Brief description of the assets released or no longer part of the company's property." }, "release_date": { "type": "string", "format": "date", "description": "Date of release or disposal." }, "evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Deed of release, chargee's consent letter or sale completion statement." }, "delivering_party": { "type": "object", "description": "Person delivering: {name, address, interest_in_charge}.", "examples": [ "{\"name\":\"Harbourline Software Ltd\",\"interest_in_charge\":\"chargor\"}" ] } }, "required": [ "registration_jurisdiction", "entity_type", "charge_reference_type", "scope", "release_basis", "release_date", "evidence_document_id", "delivering_party" ], "description": "Registers a statement that part or all of the property charged has been released from the charge, or has stopped being the company's property or undertaking. Entiva checks the release evidence, has a director confirm it, and files MR05." }, "Create_uk_charge_release": { "type": "object", "properties": { "type": { "const": "uk.charge.release" }, "params": { "$ref": "#/components/schemas/Params_uk_charge_release" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record release of charged property from a registered charge", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "release_evidence", "title": "Deed of release or chargee's consent", "source": "uploaded", "required": true }, { "key": "mr05_statement", "title": "MR05 statement of release", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true }, { "key": "release_confirmation", "title": "Release confirmation", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "release_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "mr05_statement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House: online service", "form": "MR05", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "charge_not_found", "type": null, "when": "The charge code or legacy details do not match a registered charge." }, { "code": "property_description_missing", "type": null, "when": "scope is part and no property description is given." }, { "code": "evidence_missing", "type": null, "when": "No release evidence is attached." }, { "code": "wrong_company_form", "type": null, "when": "An llp entity is filed on MR05 instead of LL MR05." } ] } }, "Params_uk_charge_satisfy": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company or LLP is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "An llp uses LL MR04." }, "charge_reference_type": { "type": "string", "enum": [ "charge_code", "legacy_charge" ], "description": "charge_code for charges created on or after 6 April 2013; legacy_charge for earlier charges." }, "charge_code": { "type": "string", "description": "Unique reference code from the certificate of registration.", "examples": [ "1587 2304 0001" ] }, "legacy_charge": { "type": "object", "description": "Pre-6 April 2013 charges: {creation_date, charge_number, instrument_description, short_particulars}." }, "satisfaction": { "type": "string", "enum": [ "full", "part" ], "description": "In full or in part." }, "part_satisfaction_details": { "type": "string", "description": "Entiva's own record of what part was satisfied." }, "satisfaction_date": { "type": "string", "format": "date", "description": "Date the debt was paid or satisfied." }, "evidence_document_id": { "type": "string", "pattern": "^doc_", "description": "Payoff or release letter from the chargee." }, "delivering_party": { "type": "object", "description": "Person delivering the statement: {name, address, interest_in_charge: chargor | chargee | other}.", "examples": [ "{\"name\":\"Harbourline Software Ltd\",\"interest_in_charge\":\"chargor\"}" ] } }, "required": [ "registration_jurisdiction", "entity_type", "charge_reference_type", "satisfaction", "satisfaction_date", "evidence_document_id", "delivering_party" ], "description": "Registers a statement that the debt secured by a registered charge has been paid or satisfied, in full or in part. Entiva checks the payoff or release evidence, has a director confirm the statement, and files MR04." }, "Create_uk_charge_satisfy": { "type": "object", "properties": { "type": { "const": "uk.charge.satisfy" }, "params": { "$ref": "#/components/schemas/Params_uk_charge_satisfy" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record satisfaction of a registered charge", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payoff_or_release_letter", "title": "Payoff or release letter", "source": "uploaded", "required": true }, { "key": "mr04_statement", "title": "MR04 statement of satisfaction", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true }, { "key": "satisfaction_confirmation", "title": "Satisfaction confirmation", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "satisfaction_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "mr04_statement", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House: online service", "form": "MR04", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "charge_not_found", "type": null, "when": "The charge code or legacy details do not match a registered charge for the company." }, { "code": "evidence_missing", "type": null, "when": "No payoff or release letter is attached." }, { "code": "wrong_company_form", "type": null, "when": "An llp entity is filed on MR04 instead of LL MR04." }, { "code": "already_satisfied", "type": null, "when": "The register already shows a full satisfaction for this charge." }, { "code": "form_rejected", "type": null, "when": "Companies House rejected the MR04 for errors; MR04 cannot be corrected informally under s1075." } ] } }, "Params_uk_class_name_assign": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_unlimited", "plc", "cic", "private_ltd_guarantee", "charitable_company" ], "description": "Entity type key." }, "capital_structure": { "type": "string", "enum": [ "share_capital", "no_share_capital" ], "description": "SH08 for classes of shares; SH13 for classes of members of a company without share capital." }, "assignment_date": { "type": "string", "format": "date", "description": "Date the name or designation is assigned." }, "assignments": { "type": "array", "items": {}, "description": "Items {existing_class_description, new_name_or_designation}.", "examples": [ "[{\"existing_class_description\":\"Ordinary\",\"new_name_or_designation\":\"A Ordinary\"}]" ] }, "rights_unchanged_confirmed": { "type": "boolean", "description": "A director confirms no right attached to the class changes." }, "articles_amendment_required": { "type": "boolean", "description": "True if the articles name the class and must be amended." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date of the special resolution amending the articles." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the form." } }, "required": [ "registration_jurisdiction", "entity_type", "capital_structure", "assignment_date", "assignments", "rights_unchanged_confirmed", "articles_amendment_required" ], "description": "A company gives a new or different name or designation to a class of shares or of members. Entiva records the board decision, handles any articles change, and files within one month." }, "Create_uk_class_name_assign": { "type": "object", "properties": { "type": { "const": "uk.class_name.assign" }, "params": { "$ref": "#/components/schemas/Params_uk_class_name_assign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Assign a name or designation to a class of shares or members", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "private_unlimited", "plc", "cic", "private_ltd_guarantee", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution assigning the name or designation", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution amending the articles", "source": "generated", "required": false }, { "key": "amended_articles", "title": "Amended articles of association", "source": "generated", "required": false }, { "key": "sh08_or_sh13_notice", "title": "SH08 or SH13 notice of name or designation", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House receipts", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh08_or_sh13_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH08", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "rights_changed", "type": null, "when": "rights_unchanged_confirmed is false or the new name implies different rights; use uk.class_rights.vary." }, { "code": "class_not_found", "type": null, "when": "The existing class description does not match a class on the register or in the articles." }, { "code": "articles_change_missing", "type": null, "when": "The articles name the class but articles_amendment_required is false." }, { "code": "wrong_form_for_structure", "type": null, "when": "capital_structure does not match the company's capital." } ] } }, "Params_uk_class_rights_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_unlimited", "plc", "cic", "private_ltd_guarantee", "charitable_company" ], "description": "Entity type key." }, "capital_structure": { "type": "string", "enum": [ "share_capital", "no_share_capital" ], "description": "Decides the form: SH10 for share capital, SH12 for a company without share capital." }, "class_name": { "type": "string", "description": "Name of the class whose rights are varied.", "examples": [ "A Ordinary" ] }, "variation_description": { "type": "string", "description": "Particulars of the variation, as they will appear on the public record." }, "variation_date": { "type": "string", "format": "date", "description": "Date the variation is made." }, "variation_route": { "type": "string", "enum": [ "articles_procedure", "three_quarters_written_consent", "class_meeting_special_resolution" ], "description": "s630 and s631: follow the articles' variation provision if there is one; if not, written consent of holders of at least three-quarters in nominal value of the." }, "class_holders": { "type": "array", "items": {}, "description": "Items {holder, shares_held, consented}.", "examples": [ "[{\"holder\":\"per_2Wn5YdK9cRh1Tb\",\"shares_held\":4100,\"consented\":true}]" ] }, "articles_amendment_required": { "type": "boolean", "description": "True if the articles must change." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date of the members' special resolution amending the articles." }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Amended articles, or leave empty and Entiva generates them from the variation text." }, "court_order_document_id": { "type": "string", "pattern": "^doc_", "description": "If dissenters applied to court and the court confirmed the variation, the order." }, "cic_regulator_review_confirmed": { "type": "boolean", "description": "cic only: confirms the variation, especially any preference or conversion right, was discussed with the CIC Regulator and does not breach the asset lock." }, "charity_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "charitable_company only: Charity Commission consent where the change is a regulated alteration." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH10 or SH12." } }, "required": [ "registration_jurisdiction", "entity_type", "capital_structure", "class_name", "variation_description", "variation_date", "variation_route", "class_holders", "articles_amendment_required" ], "description": "A company varies class rights through its articles' variation procedure, the written consent of holders of three-quarters of the class, or a special resolution of the class. Entiva runs the consents, amends the articles where needed." }, "Create_uk_class_rights_change": { "type": "object", "properties": { "type": { "const": "uk.class_rights.change" }, "params": { "$ref": "#/components/schemas/Params_uk_class_rights_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Vary the rights attached to a class of shares or members", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "private_unlimited", "plc", "cic", "private_ltd_guarantee", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing the variation", "source": "generated", "required": true }, { "key": "class_consent", "title": "Written consent of three-quarters of the class, or class-meeting special resolution", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution amending the articles", "source": "generated", "required": false }, { "key": "amended_articles", "title": "Amended articles of association", "source": "generated", "required": false }, { "key": "sh10_or_sh12_notice", "title": "SH10 or SH12 notice of variation of class rights", "source": "generated", "required": true }, { "key": "court_order", "title": "Court order on a class objection", "source": "uploaded", "required": false }, { "key": "companies_house_receipt", "title": "Companies House receipts", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "class_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh10_or_sh12_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH10", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "variation_route_invalid", "type": null, "when": "The articles contain a variation procedure and a different route was chosen (s630/s631)." }, { "code": "consent_below_three_quarters", "type": null, "when": "Consents cover less than 75% of the class by nominal value, excluding treasury shares." }, { "code": "court_application_pending", "type": null, "when": "Holders of 15% or more applied to court under s633; the variation has no effect until the court confirms it." }, { "code": "articles_change_missing", "type": null, "when": "The variation conflicts with the articles but articles_amendment_required is false." }, { "code": "cic_asset_lock_conflict", "type": null, "when": "A CIC variation breaches the asset lock or the dividend cap." }, { "code": "charity_consent_missing", "type": null, "when": "A charitable company needs Charity Commission consent and none is attached." }, { "code": "psc_change_detected", "type": null, "when": "The variation moves a person across a PSC threshold; a uk.psc.* action is raised." } ] } }, "Params_uk_emi_options_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "private_unlimited" ], "description": "Entity type key." }, "ers_scheme_reference": { "type": "string", "description": "HMRC ERS reference of the registered EMI scheme.", "examples": [ "XA12345" ] }, "tax_year_of_grant": { "type": "string", "description": "Tax year in which the options were granted.", "examples": [ "2026-27" ] }, "grants": { "type": "array", "items": {}, "description": "Items {optionee: person_ref, grant_date, share_class, number_of_shares, exercise_price_per_share, actual_market_value_per_share, exercise_period_years.", "examples": [ "[{\"optionee\":\"per_6Rk1ZnY8dWq3Ls\",\"grant_date\":\"2026-10-01\",\"share_class\":\"Ordinary\",\"number_of_shares\":20000,\"exercise_price_per_share\":{\"amount\":1.20,\"currency\":\"GBP\"},\"actual_market_value_per_share\":{\"amount\":1.20,\"currency\":\"GBP\"},\"exercise_period_years\":10,\"option_agreement_document_id\":\"doc_8Tb2LqK5nCw9\"}]" ] }, "submission_method": { "type": "string", "enum": [ "online_form", "template_upload" ], "description": "HMRC asks for the template when notifying more than 30 employees." }, "declarant": { "type": "string", "pattern": "^per_", "description": "A director or the secretary who makes the declaration that the requirements are met and the information is correct and complete." }, "company_eligibility_confirmed": { "type": "boolean", "description": "The declarant confirms the company and each employee meet the EMI conditions at grant." } }, "required": [ "registration_jurisdiction", "entity_type", "ers_scheme_reference", "tax_year_of_grant", "grants", "submission_method", "declarant", "company_eligibility_confirmed" ], "description": "Notifies HMRC of Enterprise Management Incentives options granted in a tax year, with the director's or secretary's declaration that the requirements are met. A grant is only a qualifying option once notice is given." }, "Create_uk_emi_options_notify": { "type": "object", "properties": { "type": { "const": "uk.emi_options.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_emi_options_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify HMRC of EMI option grants", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "emi_notification_data", "title": "EMI notification data or HMRC template", "source": "generated", "required": true }, { "key": "option_agreements", "title": "Option agreements for each grant", "source": "uploaded", "required": true }, { "key": "hmrc_notification_confirmation", "title": "HMRC confirmation of notification", "source": "registry_issued", "required": true }, { "key": "emi_declaration", "title": "Emi declaration", "source": "generated", "required": true }, { "key": "emi_notification", "title": "Emi notification", "source": "generated", "required": true } ], "people": [ { "role": "declarant", "verification_level": "registry_idv" }, { "role": "other", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "emi_declaration", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "emi_notification", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "HMRC: Employment related securities", "form": "EMI notification", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ers_scheme_not_registered", "type": null, "when": "No registered EMI scheme reference exists; the scheme must be registered first." }, { "code": "notification_deadline_passed", "type": null, "when": "The grant's 6 July deadline has passed; a late or missing notice means the option is not a qualifying option." }, { "code": "declaration_missing", "type": null, "when": "The director or secretary has not made the declaration." }, { "code": "template_required", "type": null, "when": "More than 30 employees are listed with submission_method online_form." }, { "code": "grant_not_emi_eligible", "type": null, "when": "The linked grant failed the EMI eligibility check." }, { "code": "ni_number_missing", "type": null, "when": "An optionee has no National Insurance number on file." } ] } }, "Params_uk_ers_return_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "private_unlimited" ], "description": "Entity type key." }, "ers_scheme_reference": { "type": "string", "description": "HMRC ERS scheme reference.", "examples": [ "XA12345" ] }, "scheme_type": { "type": "string", "enum": [ "emi", "csop", "saye", "sip", "non_tax_advantaged_share_option", "non_tax_advantaged_acquisition" ], "description": "Decides the template." }, "tax_year": { "type": "string", "description": "Tax year being reported, filed after the year ends.", "examples": [ "2025-26" ] }, "nil_return": { "type": "boolean", "description": "True when there were no reportable events." }, "reportable_events": { "type": "array", "items": {}, "description": "When nil_return is false: items {event_type, event_date, employee: person_ref, number_of_shares, market_value, amount_paid}." }, "template_document_id": { "type": "string", "pattern": "^doc_", "description": "Completed HMRC template, if the customer supplies its own." }, "scheme_ended": { "type": "boolean", "description": "True to file outstanding returns for a ceased scheme up to the end date." } }, "required": [ "registration_jurisdiction", "entity_type", "ers_scheme_reference", "scheme_type", "tax_year", "nil_return" ], "description": "Files the end-of-year ERS return, or a nil return, for each registered scheme. Entiva builds the return from the option ledger and exercises, checks the file with HMRC's spreadsheet checking service, takes the director's approval, and." }, "Create_uk_ers_return_file": { "type": "object", "properties": { "type": { "const": "uk.ers_return.file" }, "params": { "$ref": "#/components/schemas/Params_uk_ers_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual employment-related securities return", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ers_return_template", "title": "ERS end-of-year return template", "source": "generated", "required": true }, { "key": "hmrc_receipt", "title": "HMRC submission receipt", "source": "registry_issued", "required": true }, { "key": "agent_authorisation_record", "title": "Online Agent Authorisation record", "source": "registry_issued", "required": true }, { "key": "return_approval", "title": "Return approval", "source": "generated", "required": true }, { "key": "ers_return_submission", "title": "Ers return submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "return_approval", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ers_return_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC: Employment related securities", "form": "ERS end-of-year return or nil return", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agent_not_authorised", "type": null, "when": "The client has not completed Online Agent Authorisation for ERS." }, { "code": "scheme_not_registered", "type": null, "when": "The ERS scheme reference is unknown; register it first." }, { "code": "template_check_failed", "type": null, "when": "HMRC's ERS spreadsheet checking service rejects the file." }, { "code": "return_overdue", "type": null, "when": "The 6 July deadline has passed; the action continues and warns that penalties accrue." }, { "code": "prior_year_missing", "type": null, "when": "An earlier tax year has no filed return or nil return for the scheme." }, { "code": "events_missing", "type": null, "when": "nil_return is false but no reportable events are available." } ] } }, "Params_uk_ers_scheme_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "private_unlimited" ], "description": "Entity type key." }, "scheme_type": { "type": "string", "enum": [ "emi", "csop", "saye", "sip", "non_tax_advantaged_share_option", "non_tax_advantaged_acquisition" ], "description": "Tax-advantaged: SIP, SAYE, CSOP, EMI." }, "scheme_name": { "type": "string", "description": "Name used on the HMRC service and in Entiva." }, "employer_paye_reference": { "type": "string", "description": "Employer PAYE reference.", "examples": [ "123/AB45678" ] }, "accounts_office_reference": { "type": "string", "description": "Accounts Office reference from HMRC's registration letter.", "examples": [ "123PA00045678" ] }, "tax_year_set_up": { "type": "string", "description": "Tax year the scheme is set up, or the first reportable event for a non-tax-advantaged scheme.", "examples": [ "2026-27" ] }, "first_grant_or_event_date": { "type": "string", "format": "date", "description": "Date of the first EMI grant or reportable event, used to compute the deadline." }, "hmrc_user": { "type": "string", "pattern": "^per_", "description": "The officer who holds the company's HMRC online services for employers sign-in and will complete the registration." }, "agent_authorisation_requested": { "type": "boolean", "description": "Ask the client to authorise Entiva through Online Agent Authorisation so it can file annual returns." } }, "required": [ "registration_jurisdiction", "entity_type", "scheme_type", "scheme_name", "employer_paye_reference", "accounts_office_reference", "tax_year_set_up", "hmrc_user" ], "description": "Registers an EMI, CSOP, SAYE, SIP or non-tax-advantaged scheme or arrangement on HMRC's ERS online service so that EMI grants can be notified and annual returns filed. HMRC says an agent cannot register or end a scheme, so the employer." }, "Create_uk_ers_scheme_register": { "type": "object", "properties": { "type": { "const": "uk.ers_scheme.register" }, "params": { "$ref": "#/components/schemas/Params_uk_ers_scheme_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an employment-related securities scheme with HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "paye_registration_evidence", "title": "HMRC PAYE registration letter", "source": "uploaded", "required": true }, { "key": "scheme_documents", "title": "Scheme rules or first option agreement", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution adopting and registering the scheme", "source": "generated", "required": true }, { "key": "ers_registration_confirmation", "title": "HMRC ERS scheme reference", "source": "registry_issued", "required": true }, { "key": "ers_registration", "title": "Ers registration", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ers_registration", "signer_role": "director", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "HMRC: Employment related securities", "form": "ERS scheme registration", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "paye_not_registered", "type": null, "when": "No employer PAYE reference or online PAYE enrolment is available; HMRC will not let the scheme be registered." }, { "code": "agent_cannot_register", "type": null, "when": "A request tries to register through an agent connection; HMRC limits agents to viewing and filing returns." }, { "code": "scheme_already_registered", "type": null, "when": "A scheme with the same type and name is already registered." }, { "code": "registration_deadline_passed", "type": null, "when": "The 6 July deadline has passed; the action continues and warns of late-return penalties." }, { "code": "scheme_reference_not_supplied", "type": null, "when": "The employer completed HMRC registration but has not entered the scheme reference within 14 days." } ] } }, "Params_uk_limited_partner_interest_assign": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "lp", "pflp", "slp" ], "description": "Partnership type." }, "assignor": { "type": "string", "pattern": "^per_", "description": "Limited partner assigning.", "examples": [ "per_1NfL1aBcD2eFg" ] }, "assignee": { "type": "string", "pattern": "^per_", "description": "Person taking the interest as a limited partner.", "examples": [ "per_1NfL2hJkL3mNo" ] }, "interest_assigned": { "type": "string", "enum": [ "whole", "part" ], "description": "Whole or part of the assignor's interest." }, "capital_contribution_assigned": { "$ref": "#/components/schemas/Money", "description": "Part of the contributed sum that moves to the assignee.", "examples": [ "100000.00 GBP" ] }, "profit_share_assigned_percent": { "type": "number", "description": "Profit share assigned, in percent.", "examples": [ "12.5" ] }, "assignment_date": { "type": "string", "format": "date", "description": "Date of the assignment agreement.", "examples": [ "2026-10-21" ] }, "assignee_additional_contribution": { "$ref": "#/components/schemas/Money", "description": "Further sum the assignee contributes; a notifiable change for non-PFLPs (LPA 1907 s9)." }, "general_partner_consent": { "type": "boolean", "description": "The consent the partnership agreement requires has been given." }, "assignee_accepts_limited_partner_status": { "type": "boolean", "description": "Assignee accepts limited partner status: capital contributor, no part in management." }, "execution_form": { "type": "string", "enum": [ "under_hand", "deed" ], "description": "under_hand by default; deed if the partnership agreement requires it." } }, "required": [ "registration_jurisdiction", "entity_type", "assignor", "assignee", "interest_assigned", "capital_contribution_assigned", "profit_share_assigned_percent", "assignment_date", "general_partner_consent", "assignee_accepts_limited_partner_status" ], "description": "Assigns all or part of a limited partner's interest in an LP, PFLP or SLP. For LPs and SLPs Entiva advertises the assignment in the Gazette, since under LPA 1907 s10 it has no effect under the Act until advertised, and files LP6 within." }, "Create_uk_limited_partner_interest_assign": { "type": "object", "properties": { "type": { "const": "uk.limited_partner_interest.assign" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_partner_interest_assign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Assign a limited partner's interest", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "assignment_agreement", "title": "Assignment agreement or deed", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Current partnership agreement", "source": "uploaded", "required": true }, { "key": "general_partner_consent", "title": "General partner consent", "source": "generated", "required": true }, { "key": "lp6_statement", "title": "LP6 statement specifying the nature of the change", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of the assignment", "source": "generated", "required": false }, { "key": "gazette_proof_of_publication", "title": "Gazette proof of publication", "source": "registry_issued", "required": false }, { "key": "assignee_kyb_pack", "title": "Corporate assignee documents and ownership chart", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "other", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "assignment_agreement", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "assignment_agreement", "signer_role": "other", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "assignment_agreement", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "general_partner_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "lp6_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP6 Statement specifying the nature of a change in the limited partnership, plus Gazette n", "channel": "both", "government_fee": { "amount": 96.55, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "assignment_not_permitted_by_agreement", "type": "requirement_error", "when": "Partnership agreement prohibits or conditions the assignment and the condition is unmet." }, { "code": "general_partner_consent_missing", "type": "requirement_error", "when": "Required consent not recorded." }, { "code": "entity_type_jurisdiction_mismatch", "type": "invalid_request_error", "when": "slp outside Scotland, or an LP type unavailable in the jurisdiction." }, { "code": "gazette_publication_pending", "type": "requirement_error", "when": "Non-PFLP assignment not effective until published; LP6 held until proof arrives." }, { "code": "scottish_formal_writing_required", "type": "requirement_error", "when": "SLP assignation needs formal writing and an AES or QES, or paper execution." } ] } }, "Params_uk_llp_member_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "member_kind": { "type": "string", "enum": [ "individual", "corporate" ], "description": "individual files LL AP01; corporate files LL AP02." }, "member": { "type": "string", "pattern": "^per_", "description": "Incoming member.", "examples": [ "per_1NfM1aBcD2eFg" ] }, "acting_individual": { "type": "string", "pattern": "^per_", "description": "Required for a corporate member: the individual who acts for it." }, "effective_date": { "type": "string", "format": "date", "description": "Date membership starts; the 14-day notice runs from here.", "examples": [ "2026-10-20" ] }, "designated_member": { "type": "boolean", "description": "Whether the member is a designated member." }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Public service address of an individual member." }, "usual_residential_address": { "$ref": "#/components/schemas/Address", "description": "Private, protected." }, "date_of_birth": { "type": "string", "format": "date", "description": "Individual member." }, "nationality": { "type": "string", "description": "Individual member.", "examples": [ "British" ] }, "country_of_usual_residence": { "type": "string", "description": "Part of the UK or country where usually resident.", "examples": [ "England" ] }, "personal_code": { "type": "string", "description": "11-character Companies House personal code if already verified; otherwise Entiva verifies as ACSP and obtains it.", "examples": [ "7K4Q9XM2TP8" ] }, "corporate_member_particulars": { "type": "object", "description": "Corporate member: name, principal office, service address, legal form, governing law, registered number or foreign register." }, "profit_share_percent": { "type": "number", "description": "For the PSC assessment." }, "voting_rights_percent": { "type": "number", "description": "LLP PSC condition: more than 25%." }, "surplus_assets_percent": { "type": "number", "description": "Rights to surplus assets on winding up; PSC condition: more than 25%." }, "disqualification_exception": { "type": "object", "description": "Court permission or sanctions licence if the person is otherwise disqualified." }, "existing_members_consent": { "type": "boolean", "description": "All existing members consented (default rule, LLP Regulations 2001 reg 7) or the LLP agreement allows otherwise." } }, "required": [ "registration_jurisdiction", "member_kind", "member", "effective_date", "designated_member", "service_address", "usual_residential_address", "date_of_birth", "nationality", "country_of_usual_residence", "existing_members_consent" ], "description": "Admits an individual or corporate member to an LLP. Entiva obtains the existing members' consent, verifies an incoming individual with Companies House so the personal code can accompany the notice, records the member's consent to act." }, "Create_uk_llp_member_appoint": { "type": "object", "properties": { "type": { "const": "uk.llp_member.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_llp_member_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Admit a member to an LLP", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "llp_admission_agreement", "title": "LLP agreement amendment or deed of adherence", "source": "generated", "required": true }, { "key": "members_consent_resolution", "title": "Existing members' consent to admission", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Member's consent to act", "source": "generated", "required": true }, { "key": "ll_ap01_or_ap02", "title": "LL AP01 or LL AP02 data set", "source": "generated", "required": true }, { "key": "corporate_member_kyb_pack", "title": "Corporate member documents and ownership chart", "source": "uploaded", "required": false } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "llp_admission_agreement", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_consent_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ll_ap01_or_ap02", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "ll_ap01_or_ap02", "signer_role": "member", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LL AP01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "member_identity_not_verified", "type": "requirement_error", "when": "No personal code and registry_idv incomplete; the notice cannot state identity is verified." }, { "code": "member_disqualified", "type": "requirement_error", "when": "Disqualification or bankruptcy found with no permission or licence recorded." }, { "code": "existing_members_consent_missing", "type": "requirement_error", "when": "Required consent not recorded." }, { "code": "notice_overdue", "type": "requirement_error", "when": "Over 14 days since appointment_date; the person may not act as a member until notified." } ] } }, "Params_uk_llp_member_remove": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "member": { "type": "string", "pattern": "^per_", "description": "Member leaving.", "examples": [ "per_1NfM5xYzA6bCd" ] }, "termination_date": { "type": "string", "format": "date", "description": "Date membership ended; the 14-day notice runs from here.", "examples": [ "2026-10-31" ] }, "termination_reason": { "type": "string", "enum": [ "retirement_by_notice", "retirement_by_agreement", "expulsion", "death", "dissolution_of_corporate_member", "other" ], "description": "How membership ended (LLPA 2000 s4: death or dissolution, agreement, or reasonable notice)." }, "notice_given_date": { "type": "string", "format": "date", "description": "Date reasonable notice was given, for retirement_by_notice.", "examples": [ "2026-09-30" ] }, "redesignate_members": { "type": "array", "items": {}, "description": "per_ ids of designated members after the leaver goes." }, "members_remaining_acknowledged": { "type": "boolean", "description": "Required if fewer than two members remain: acknowledges the six-month rule in LLPA 2000 s4A." } }, "required": [ "registration_jurisdiction", "member", "termination_date", "termination_reason" ], "description": "Records that a member has ceased to be a member and files LL TM01 within 14 days. Prompt filing matters because until a third party has notice or the registrar does, the former member is still treated as a member (LLPA 2000 s6)." }, "Create_uk_llp_member_remove": { "type": "object", "properties": { "type": { "const": "uk.llp_member.remove" }, "params": { "$ref": "#/components/schemas/Params_uk_llp_member_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End an LLP member's membership", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "retirement_notice_or_termination_agreement", "title": "Retirement notice, termination agreement or expulsion resolution", "source": "uploaded", "required": true }, { "key": "death_certificate", "title": "Death certificate", "source": "uploaded", "required": false }, { "key": "dissolution_evidence", "title": "Evidence a corporate member was dissolved", "source": "uploaded", "required": false }, { "key": "settlement_deed", "title": "Settlement or exit deed", "source": "generated", "required": false }, { "key": "ll_tm01", "title": "LL TM01 data set", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "none" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "retirement_notice_or_termination_agreement", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "settlement_deed", "signer_role": "member", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "ll_tm01", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LL TM01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "expulsion_power_missing", "type": "requirement_error", "when": "Expulsion stated but the LLP agreement gives no power to expel." }, { "code": "fewer_than_two_members", "type": "requirement_error", "when": "One member would remain; acknowledge the s4A rule or add a member first." }, { "code": "notice_overdue", "type": "requirement_error", "when": "Over 14 days since termination_date; customer must acknowledge before filing." } ] } }, "Params_uk_member_class_create": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_guarantee", "private_unlimited", "cic", "charitable_company" ], "description": "Only companies without share capital." }, "class_name": { "type": "string", "description": "Name of the new class of members.", "examples": [ "Associate members" ] }, "creation_date": { "type": "string", "format": "date", "description": "Date the new class is created." }, "rights_description": { "type": "string", "description": "Particulars of the rights attached to the class, including voting, as they will appear on the public record." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date of the special resolution amending the articles to create the class." }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Amended articles, or leave empty and Entiva generates them." }, "cic_regulator_review_confirmed": { "type": "boolean", "description": "cic only: confirms the change was discussed with the CIC Regulator." }, "charity_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "charitable_company only: Charity Commission consent if required." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH11." } }, "required": [ "registration_jurisdiction", "entity_type", "class_name", "creation_date", "rights_description", "special_resolution_date" ], "description": "A company without share capital, such as a company limited by guarantee, creates a new class of members and notifies the registrar of its rights. Entiva drafts the articles change, runs the special resolution, and files SH11 within one." }, "Create_uk_member_class_create": { "type": "object", "properties": { "type": { "const": "uk.member_class.create" }, "params": { "$ref": "#/components/schemas/Params_uk_member_class_create" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Create a new class of members", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_guarantee", "private_unlimited", "cic", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution proposing the new class", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution amending the articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Amended articles of association", "source": "generated", "required": true }, { "key": "sh11_notice", "title": "SH11 notice of new class of members", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House receipts", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh11_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH11", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_has_share_capital", "type": null, "when": "The company has share capital; SH11 does not apply." }, { "code": "rights_description_missing", "type": null, "when": "No rights are described for the new class." }, { "code": "cic_asset_lock_conflict", "type": null, "when": "A CIC class gives distribution rights that breach the asset lock." }, { "code": "charity_consent_missing", "type": null, "when": "A charitable company needs Charity Commission consent and none is attached." } ] } }, "Params_uk_own_shares_repurchase": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic" ], "description": "Entity type key." }, "purchase_type": { "type": "string", "enum": [ "off_market", "market" ], "description": "off_market: a contract approved by resolution before the purchase or authorised under s693A. market: a purchase on a recognised investment exchange under a." }, "shares_treatment": { "type": "string", "enum": [ "cancel", "hold_in_treasury" ], "description": "Shares are treated as cancelled unless held in treasury." }, "payment_source": { "type": "string", "enum": [ "distributable_profits", "fresh_issue_proceeds", "small_payment_from_capital", "capital_chapter_5", "capital_employee_share_scheme" ], "description": "distributable_profits or fresh_issue_proceeds: s692. small_payment_from_capital: private company whose articles allow it, capped per financial year at the." }, "capital_payment_action_id": { "type": "string", "description": "act_ id of the completed uk.capital_payment.authorise action.", "examples": [ "act_2Pk9TxWb4HnZc7" ] }, "contract_date": { "type": "string", "format": "date", "description": "Date the purchase contract is made." }, "delivery_date": { "type": "string", "format": "date", "description": "Date the shares are delivered to the company." }, "member_approval_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "How members authorise the contract or the market-purchase authority." }, "purchases": { "type": "array", "items": {}, "description": "One item per seller and class: {seller: person_ref or entity_ref, share_class, number_of_shares, nominal_value_per_share, price_per_share, max_price_per_share.", "examples": [ "[{\"seller\":\"per_5Hc2Vn8QdWk1Lr\",\"share_class\":\"B Ordinary\",\"number_of_shares\":1000,\"nominal_value_per_share\":{\"amount\":0.01,\"currency\":\"GBP\"},\"price_per_share\":{\"amount\":42.00,\"currency\":\"GBP\"}}]" ] }, "total_consideration": { "$ref": "#/components/schemas/Money", "description": "Aggregate amount paid." }, "stamp_duty_basis": { "type": "string", "enum": [ "duty_payable", "certificate_1000_or_less", "qualifying_asset_holding_company" ], "description": "duty_payable: 0.5% of consideration over GBP 1,000, rounded up to the nearest GBP 5. certificate_1000_or_less: transaction is not part of a larger series above." }, "hmrc_authentication_code": { "type": "string", "description": "Code from HMRC's stamping confirmation, if the customer already stamped the SH03." }, "relevant_accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "Accounts showing distributable profits." }, "contract_document_id": { "type": "string", "pattern": "^doc_", "description": "Signed purchase contract, or leave empty and Entiva generates one from its template." }, "authority_expiry_date": { "type": "string", "format": "date", "description": "plc only: expiry of the buyback authority, no later than 5 years after the resolution." }, "financial_year_purchases_to_date": { "$ref": "#/components/schemas/Money", "description": "Purchases already made this financial year under the small-payments route." }, "employees_share_scheme_purchase": { "type": "boolean", "description": "True when the shares are bought for or under an employees' share scheme (relevant to s691 and the s720A route)." }, "cic_paid_up_value_confirmed": { "type": "boolean", "description": "Required for cic: confirms that the price per share does not exceed the paid-up value of the shares." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH03 and SH06." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "purchase_type", "shares_treatment", "payment_source", "contract_date", "delivery_date", "member_approval_method", "purchases", "total_consideration", "stamp_duty_basis" ], "description": "A limited company buys back its own shares out of distributable profits, fresh-issue proceeds or capital, then cancels them or holds them in treasury. Entiva drafts the approvals and contract, collects signatures, stamps the SH03 with." }, "Create_uk_own_shares_repurchase": { "type": "object", "properties": { "type": { "const": "uk.own_shares.repurchase" }, "params": { "$ref": "#/components/schemas/Params_uk_own_shares_repurchase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Purchase of own shares, with cancellation or treasury holding", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the buyback", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution authorising the contract or market purchase", "source": "generated", "required": true }, { "key": "share_purchase_contract", "title": "Share purchase contract", "source": "generated", "required": true }, { "key": "stock_transfer_form", "title": "Stock transfer form from each seller", "source": "generated", "required": true }, { "key": "share_certificate_surrender", "title": "Share certificate or indemnity from each seller", "source": "uploaded", "required": true }, { "key": "relevant_accounts", "title": "Accounts showing distributable profits", "source": "uploaded", "required": false }, { "key": "articles_of_association", "title": "Current articles of association", "source": "uploaded", "required": false }, { "key": "sh03_return", "title": "SH03 return of purchase of own shares", "source": "generated", "required": true }, { "key": "sh06_notice", "title": "SH06 notice of cancellation of shares", "source": "generated", "required": false }, { "key": "hmrc_stamp_duty_letter", "title": "HMRC stamp duty confirmation letter", "source": "registry_issued", "required": false }, { "key": "companies_house_receipt", "title": "Companies House filing receipts", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_purchase_contract", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stock_transfer_form", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh03_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "sh06_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH03", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "articles_prohibit_buyback", "type": null, "when": "The articles restrict or prohibit purchases of own shares." }, { "code": "insufficient_distributable_profits", "type": null, "when": "The accounts do not show enough distributable profits for the price (s692)." }, { "code": "shares_not_fully_paid", "type": null, "when": "Any share to be bought is not fully paid (s691)." }, { "code": "payment_deferred", "type": null, "when": "The terms defer payment past the purchase date and no employees' share scheme exception applies (s691-)." }, { "code": "no_remaining_ordinary_shares", "type": null, "when": "The purchase would leave only redeemable or treasury shares in issue (s690)." }, { "code": "seller_votes_not_excluded", "type": null, "when": "The authorising resolution counted the selling member's votes." }, { "code": "contract_not_approved_in_time", "type": null, "when": "The resolution came after the contract, or the contract was not shared with members." }, { "code": "treasury_not_available", "type": null, "when": "hold_in_treasury is chosen but payment_source is not distributable_profits (s724)." }, { "code": "small_payment_cap_exceeded", "type": null, "when": "The small-payments route would exceed the lower of GBP 15,000 and 5% of share capital, or the articles do not allow it (s692)." }, { "code": "cic_price_exceeds_paid_up_value", "type": null, "when": "A CIC would pay more than the paid-up value of the shares." }, { "code": "stamp_duty_unconfirmed", "type": null, "when": "Duty is payable and no HMRC letter is attached, so Companies House filing is held." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on the seller pauses the action." } ] } }, "Params_uk_redeemable_shares_redeem": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic" ], "description": "A plc may only have redeemable shares if its articles authorise them." }, "redemption_date": { "type": "string", "format": "date", "description": "Date the shares are redeemed." }, "shares_redeemed": { "type": "array", "items": {}, "description": "Items {holder, share_class, number_of_shares, nominal_value_per_share, redemption_price_per_share}.", "examples": [ "[{\"holder\":\"per_8Gd4RzV1nKc6Ws\",\"share_class\":\"Redeemable Preference\",\"number_of_shares\":500,\"nominal_value_per_share\":{\"amount\":1.00,\"currency\":\"GBP\"},\"redemption_price_per_share\":{\"amount\":1.00,\"currency\":\"GBP\"}}]" ] }, "redemption_terms_source": { "type": "string", "enum": [ "articles", "terms_of_issue_resolution", "directors_determination" ], "description": "Where the terms and manner of redemption come from." }, "payment_source": { "type": "string", "enum": [ "distributable_profits", "fresh_issue_proceeds", "capital_chapter_5" ], "description": "s687: distributable profits or fresh issue proceeds, or a private company's payment out of capital under Chapter 5." }, "capital_payment_action_id": { "type": "string", "description": "Completed uk.capital_payment.authorise action." }, "deferred_payment_date": { "type": "string", "format": "date", "description": "Later payment date if the terms and the holder agree." }, "premium_from_fresh_issue": { "$ref": "#/components/schemas/Money", "description": "Part of any premium paid from fresh issue proceeds under the s687 limits." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of any resolution under the articles or terms; appears on SH02 section 2." }, "relevant_accounts_document_id": { "type": "string", "pattern": "^doc_", "description": "Accounts showing distributable profits." }, "cic_paid_up_value_confirmed": { "type": "boolean", "description": "Required for cic." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH02." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "redemption_date", "shares_redeemed", "redemption_terms_source", "payment_source" ], "description": "A limited company redeems redeemable shares in accordance with its articles or the terms of issue. Entiva checks funding and terms, collects approvals and signatures, updates the register of members, and files SH02 at Companies House." }, "Create_uk_redeemable_shares_redeem": { "type": "object", "properties": { "type": { "const": "uk.redeemable_shares.redeem" }, "params": { "$ref": "#/components/schemas/Params_uk_redeemable_shares_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redeem redeemable shares", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the redemption", "source": "generated", "required": true }, { "key": "redemption_notice", "title": "Redemption notice from the company or holder", "source": "generated", "required": false }, { "key": "relevant_accounts", "title": "Accounts showing distributable profits", "source": "uploaded", "required": false }, { "key": "share_certificate_surrender", "title": "Share certificate or indemnity", "source": "uploaded", "required": true }, { "key": "sh02_notice", "title": "SH02 notice of redemption with statement of capital", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "redemption_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh02_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH02", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "shares_not_redeemable", "type": null, "when": "The class is not redeemable under the articles or terms of issue." }, { "code": "shares_not_fully_paid", "type": null, "when": "Shares to be redeemed are not fully paid." }, { "code": "insufficient_distributable_profits", "type": null, "when": "Accounts do not show enough distributable profits and no fresh issue or Chapter 5 route is supplied." }, { "code": "capital_payment_not_authorised", "type": null, "when": "payment_source is capital_chapter_5 but the referenced action is incomplete or outside its 5 to 7 week window." }, { "code": "premium_source_invalid", "type": null, "when": "A premium is paid from fresh issue proceeds beyond the s687 limits." }, { "code": "no_non_redeemable_shares_left", "type": null, "when": "The redemption would leave no non-redeemable shares in issue." }, { "code": "cic_price_exceeds_paid_up_value", "type": null, "when": "A CIC would pay more than paid-up value." } ] } }, "Params_uk_seis_eis_advance_assurance_request": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc" ], "description": "Entity type key." }, "scheme": { "type": "string", "enum": [ "seis", "eis", "seis_and_eis" ], "description": "Scheme or schemes the issue is meant to qualify for." }, "proposed_raise": { "$ref": "#/components/schemas/Money", "description": "Amount the company plans to raise." }, "proposed_issue_date": { "type": "string", "format": "date", "description": "Expected share issue date." }, "trade_description": { "type": "string", "description": "The qualifying trade and activities." }, "trade_start_date": { "type": "string", "format": "date", "description": "SEIS: the trade must not have been carried on for more than 3 years." }, "full_time_equivalent_employees": { "type": "integer", "description": "SEIS: fewer than 25." }, "gross_assets_before": { "$ref": "#/components/schemas/Money", "description": "Gross assets of company and subsidiaries before the issue." }, "gross_assets_after": { "$ref": "#/components/schemas/Money", "description": "EIS: gross assets immediately after the issue, limit GBP 35m." }, "prior_venture_funding": { "type": "array", "items": {}, "description": "Past investments under venture capital schemes: items {scheme, date, amount}." }, "knowledge_intensive": { "type": "boolean", "description": "EIS: knowledge-intensive company with different age and investor limits." }, "specified_company": { "type": "boolean", "description": "EIS: Northern Ireland registered office trading in certain goods or the wholesale electricity market; lower limits apply." }, "risk_to_capital_statement": { "type": "string", "description": "How the company meets the risk to capital condition." }, "growth_statement": { "type": "string", "description": "EIS and VCT: how the money supports growth." }, "use_of_funds": { "type": "array", "items": {}, "description": "Planned spending per activity and the companies that will use the funds." }, "potential_investors": { "type": "array", "items": {}, "description": "Investor details if the company has not used these schemes before, or raises directly from investors." } }, "required": [ "registration_jurisdiction", "entity_type", "scheme", "proposed_raise", "trade_description", "trade_start_date", "full_time_equivalent_employees", "gross_assets_before", "prior_venture_funding", "risk_to_capital_statement", "use_of_funds" ], "description": "Before a fundraise, the company asks HMRC whether the proposed share issue is likely to qualify for the Seed or Enterprise Investment Scheme. Entiva assembles the documents, checks the company against the scheme limits, has a director." }, "Create_uk_seis_eis_advance_assurance_request": { "type": "object", "properties": { "type": { "const": "uk.seis_eis_advance_assurance.request" }, "params": { "$ref": "#/components/schemas/Params_uk_seis_eis_advance_assurance_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request SEIS or EIS advance assurance from HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "business_plan", "title": "Business plan", "source": "uploaded", "required": true }, { "key": "financial_forecasts", "title": "Financial forecasts", "source": "uploaded", "required": true }, { "key": "latest_accounts", "title": "Latest accounts", "source": "uploaded", "required": false }, { "key": "articles_of_association", "title": "Current articles, and expected changes", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members from the application date", "source": "generated", "required": true }, { "key": "investor_documents_draft", "title": "Latest draft investor-facing documents", "source": "uploaded", "required": true }, { "key": "agent_authority_letter", "title": "Signed agent authority letter", "source": "generated", "required": true }, { "key": "hmrc_assurance_letter", "title": "HMRC advance assurance decision", "source": "registry_issued", "required": false }, { "key": "advance_assurance_application", "title": "Advance assurance application", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "agent_authority_letter", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "advance_assurance_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC Venture Capital Schemes", "form": "HMRC online advance assurance application", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "scheme_limits_exceeded", "type": null, "when": "The raise, gross assets, employee count or trade age exceed the scheme limits." }, { "code": "company_quoted", "type": null, "when": "The shares are or will be quoted on a recognised stock exchange." }, { "code": "risk_to_capital_unsupported", "type": null, "when": "The risk to capital statement is empty or contradicted by the documents." }, { "code": "agent_letter_expired", "type": null, "when": "The agent authority letter is older than 3 months or belongs to an earlier application." }, { "code": "documents_incomplete", "type": null, "when": "A required document is missing; HMRC may give no feedback on an incomplete application." }, { "code": "prior_funding_unreported", "type": null, "when": "Past venture capital funding is not listed." } ] } }, "Params_uk_seis_eis_compliance_statement_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc" ], "description": "Entity type key." }, "scheme": { "type": "string", "enum": [ "seis", "eis" ], "description": "One statement per share issue and scheme." }, "share_issue_date": { "type": "string", "format": "date", "description": "Date the shares were issued." }, "shares_issued": { "type": "object", "description": "{share_class, number_of_shares, subscription_price_per_share, total_raised, fully_paid_in_cash: true}." }, "qualifying_activity_start_date": { "type": "string", "format": "date", "description": "Date the qualifying business activity started." }, "seis_seventy_percent_spent_date": { "type": "string", "format": "date", "description": "SEIS alternative to the 4-month test: date at least 70% of the amount raised had been spent." }, "advance_assurance_reference": { "type": "string", "description": "HMRC advance assurance reference, if any." }, "investors": { "type": "array", "items": {}, "description": "Items {investor: person_ref or entity_ref, shares, subscription_amount, connected_with_company: boolean}." }, "full_time_equivalent_employees": { "type": "integer", "description": "At share issue." }, "gross_assets_before": { "$ref": "#/components/schemas/Money", "description": "Before the issue." }, "gross_assets_after": { "$ref": "#/components/schemas/Money", "description": "EIS: after the issue, limit GBP 35m." }, "funding_last_12_months": { "$ref": "#/components/schemas/Money", "description": "Funding received in the 12 months to the issue, across EIS, VCT, SEIS and SITR." }, "funding_lifetime": { "$ref": "#/components/schemas/Money", "description": "Lifetime funding." }, "knowledge_intensive": { "type": "boolean", "description": "EIS: knowledge-intensive status, with evidence." }, "specified_company": { "type": "boolean", "description": "Northern Ireland registered office trading in certain goods or the wholesale electricity market." }, "changes_since_assurance": { "type": "string", "description": "Describe documents or facts that changed since HMRC gave advance assurance." } }, "required": [ "registration_jurisdiction", "entity_type", "scheme", "share_issue_date", "shares_issued", "qualifying_activity_start_date", "investors", "full_time_equivalent_employees", "gross_assets_before", "funding_last_12_months", "funding_lifetime" ], "description": "After shares are issued and the company has met the 4-month activity condition, the company files a compliance statement for that issue. HMRC then sends an authorisation letter, a unique investment reference number and SEIS3 or EIS3." }, "Create_uk_seis_eis_compliance_statement_file": { "type": "object", "properties": { "type": { "const": "uk.seis_eis_compliance_statement.file" }, "params": { "$ref": "#/components/schemas/Params_uk_seis_eis_compliance_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the SEIS1 or EIS1 compliance statement with HMRC", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "compliance_statement", "title": "SEIS1 or EIS1 compliance statement", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Supporting documents", "source": "uploaded", "required": true }, { "key": "agent_authority_letter", "title": "Signed agent authority letter", "source": "generated", "required": true }, { "key": "hmrc_authorisation_letter", "title": "HMRC authorisation letter and investment reference number", "source": "registry_issued", "required": true }, { "key": "compliance_certificates", "title": "SEIS3 or EIS3 compliance certificates", "source": "registry_issued", "required": true }, { "key": "compliance_statement_approval", "title": "Compliance statement approval", "source": "generated", "required": true }, { "key": "compliance_statement_submission", "title": "Compliance statement submission", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "agent_authority_letter", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "compliance_statement_approval", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "compliance_statement_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC Venture Capital Schemes", "form": "SEIS1 or EIS1 compliance statement", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "four_month_condition_not_met", "type": null, "when": "Fewer than 4 months of qualifying activity at submission." }, { "code": "shares_not_issued", "type": null, "when": "Shares have not been issued; the statement can only follow the issue." }, { "code": "scheme_limits_exceeded", "type": null, "when": "Raise, gross assets, employees or funding exceed the scheme limits." }, { "code": "share_terms_ineligible", "type": null, "when": "Shares are not fully paid in cash, full-risk ordinary shares, or are redeemable or carry special asset rights." }, { "code": "agent_letter_expired", "type": null, "when": "The agent authority letter is older than 3 months." }, { "code": "deadline_passed", "type": null, "when": "The submission window has closed; investors cannot claim relief." }, { "code": "hmrc_disagrees", "type": null, "when": "HMRC declines; the response carries appeal details." } ] } }, "Params_uk_share_allot": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "description": "An unlimited company files only when it allots a new class." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class of the new shares.", "examples": [ "Ordinary" ] }, "number_of_shares": { "type": "integer", "description": "Total new shares; must equal the sum over allottees.", "examples": [ "1000" ] }, "nominal_value_per_share": { "$ref": "#/components/schemas/Money", "description": "Nominal value of each share.", "examples": [ "1.00 GBP" ] }, "amount_paid_per_share": { "$ref": "#/components/schemas/Money", "description": "Paid per share including premium.", "examples": [ "20.00 GBP" ] }, "amount_unpaid_per_share": { "$ref": "#/components/schemas/Money", "description": "Unpaid per share including premium; default 0." }, "payment_form": { "type": "string", "enum": [ "cash", "non_cash", "bonus_issue" ], "description": "cash, non_cash or bonus_issue." }, "non_cash_consideration": { "type": "string", "description": "Required for non_cash and bonus_issue, as the SH01 states it." }, "allottees": { "type": "array", "items": {}, "description": "Per allottee: person, number_of_shares, register_address.", "examples": [ "[{\"person\":\"per_1NfN1aBcD2eFg\",\"number_of_shares\":1000,\"register_address\":{\"line1\":\"9 Mill Lane\",\"city\":\"Leeds\",\"postal_code\":\"LS1 4DY\",\"country\":\"GB\"}}]" ] }, "allotment_date": { "type": "string", "format": "date", "description": "When the allottee gains the unconditional right to be registered.", "examples": [ "2026-10-26" ] }, "authority_basis": { "type": "string", "enum": [ "s550_directors_power", "articles_authority", "ordinary_resolution" ], "description": "s550, articles, or an s551 ordinary resolution." }, "pre_emption_treatment": { "type": "string", "enum": [ "offer_made_to_existing_holders", "waived_by_all_holders", "excluded_by_private_company_articles", "disapplied_by_special_resolution", "statutory_exception" ], "description": "How the s561 right of pre-emption on cash allotments of equity securities is handled." }, "class_rights": { "type": "object", "description": "Required for a new class: voting, dividend, capital and redemption rights." }, "valuation_report": { "type": "string", "pattern": "^doc_", "description": "PLC non-cash allotment: independent valuer's report made within 6 months before the allotment." } }, "required": [ "registration_jurisdiction", "entity_type", "share_class", "number_of_shares", "nominal_value_per_share", "amount_paid_per_share", "payment_form", "allottees", "allotment_date", "authority_basis", "pre_emption_treatment" ], "description": "Allots new shares to one or more allottees. Entiva checks the directors' authority and pre-emption, collects the board and any members' resolutions, enters the allottees in the register of members, issues certificates and files the." }, "Create_uk_share_allot": { "type": "object", "properties": { "type": { "const": "uk.share.allot" }, "params": { "$ref": "#/components/schemas/Params_uk_share_allot" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Allot new shares", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_allotment", "title": "Directors' resolution to allot", "source": "generated", "required": true }, { "key": "allotment_authority_resolution", "title": "Ordinary resolution giving authority to allot", "source": "generated", "required": false }, { "key": "pre_emption_disapplication_resolution", "title": "Special resolution disapplying pre-emption, or holders' waiver", "source": "generated", "required": false }, { "key": "subscription_letter", "title": "Subscription letter or share application", "source": "generated", "required": true }, { "key": "valuation_report", "title": "Independent valuation report", "source": "uploaded", "required": false }, { "key": "sh01_return", "title": "Return of allotment with statement of capital", "source": "generated", "required": true }, { "key": "share_certificate", "title": "Share certificates", "source": "generated", "required": true }, { "key": "allottee_kyb_pack", "title": "Corporate allottee documents and ownership chart", "source": "uploaded", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "none" }, { "role": "shareholder", "verification_level": "registry_idv" }, { "role": "nominee", "verification_level": "identity" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_allotment", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "allotment_authority_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "pre_emption_disapplication_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "subscription_letter", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sh01_return", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH01 Return of allotment with statement of capital", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "allotment_authority_missing", "type": "requirement_error", "when": "No s550 power, articles authority or unexpired s551 resolution covers the allotment." }, { "code": "authority_exceeded", "type": "invalid_request_error", "when": "Shares exceed the maximum number in the authority." }, { "code": "pre_emption_not_addressed", "type": "requirement_error", "when": "Cash allotment of equity securities with no offer, waiver, disapplication or exception." }, { "code": "allotment_at_discount", "type": "invalid_request_error", "when": "Paid per share is below nominal value." }, { "code": "plc_payment_rules", "type": "invalid_request_error", "when": "PLC: under one quarter of nominal paid, or an undertaking to do work or services." }, { "code": "plc_valuation_report_missing", "type": "requirement_error", "when": "PLC non-cash allotment without a valuation report within 6 months." } ] } }, "Params_uk_share_transfer": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "description": "Entity type key of the company." }, "transferor": { "type": "string", "pattern": "^per_", "description": "Registered holder.", "examples": [ "per_1NfK4aBcD9eFg" ] }, "transferee": { "type": "string", "pattern": "^per_", "description": "Person to be entered in the register.", "examples": [ "per_1NfK5hJkL2mNo" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class as named in the register.", "examples": [ "Ordinary" ] }, "number_of_shares": { "type": "integer", "description": "Shares transferred.", "examples": [ "3000" ] }, "share_numbers": { "type": "string", "description": "Distinguishing numbers, if shares are numbered (s113).", "examples": [ "1001-4000" ] }, "shares_fully_paid": { "type": "boolean", "description": "False means the transferee must also sign the instrument; the transferor-only form works only for fully paid shares." }, "amount_paid_per_share": { "$ref": "#/components/schemas/Money", "description": "Required when not fully paid." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Total consideration; 0 for a gift.", "examples": [ "62500.00 GBP" ] }, "stamp_duty_treatment": { "type": "string", "enum": [ "duty_payable", "certificate_1_consideration_1000_or_less", "certificate_2_exempt_category", "no_consideration", "relief_claimed" ], "description": "Checked against the consideration; a mismatch is refused." }, "part_of_larger_transaction": { "type": "boolean", "description": "True if part of a series over GBP 1,000; Certificate 1 is then unavailable." }, "relief_description": { "type": "string", "description": "Required for certificate_2_exempt_category or relief_claimed." }, "instrument_date": { "type": "string", "format": "date", "description": "Date the form is signed and dated; the 30-day HMRC clock starts here.", "examples": [ "2026-10-19" ] }, "lodged_date": { "type": "string", "format": "date", "description": "Date the signed form and certificate reach the company.", "examples": [ "2026-10-19" ] }, "transferee_address": { "$ref": "#/components/schemas/Address", "description": "Name-and-address details for the register; a service address once ss113A-113B commence." }, "certificate_numbers": { "type": "array", "items": {}, "description": "Certificates surrendered.", "examples": [ "[\"C-0004\"]" ] } }, "required": [ "registration_jurisdiction", "entity_type", "transferor", "transferee", "share_class", "number_of_shares", "shares_fully_paid", "consideration", "stamp_duty_treatment", "instrument_date", "transferee_address" ], "description": "Registers a transfer of shares from one registered holder to another. Entiva prepares the stock transfer form, submits it to HMRC and pays any stamp duty within 30 days of signing, registers the transfer in the register of members." }, "Create_uk_share_transfer": { "type": "object", "properties": { "type": { "const": "uk.share.transfer" }, "params": { "$ref": "#/components/schemas/Params_uk_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer shares between holders", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "stock_transfer_form", "title": "Stock transfer form signed by the transferor", "source": "generated", "required": true }, { "key": "instrument_of_transfer_partly_paid", "title": "Instrument of transfer for partly paid shares", "source": "generated", "required": false }, { "key": "share_certificate_surrendered", "title": "Share certificate being transferred", "source": "uploaded", "required": true }, { "key": "board_resolution_transfer", "title": "Directors' resolution approving registration", "source": "generated", "required": false }, { "key": "transferee_kyb_pack", "title": "Corporate transferee documents and ownership chart", "source": "uploaded", "required": false }, { "key": "hmrc_stamping_letter", "title": "HMRC letter confirming the form is duly stamped", "source": "registry_issued", "required": false }, { "key": "new_share_certificate", "title": "Certificate for the transferee", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "none" }, { "role": "shareholder", "verification_level": "registry_idv" }, { "role": "nominee", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "stock_transfer_form", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "instrument_of_transfer_partly_paid", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_transfer", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "new_share_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "HMRC Stamp Taxes", "form": "Stock transfer form", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "transferor_not_registered_holder", "type": "invalid_request_error", "when": "Transferor lacks enough shares of the class, or share numbers do not match the register." }, { "code": "transfer_restricted_by_articles", "type": "requirement_error", "when": "Articles require a pre-emption offer, consent or board approval not yet recorded." }, { "code": "stamp_duty_treatment_mismatch", "type": "invalid_request_error", "when": "Declared treatment contradicts the consideration." }, { "code": "transferee_register_details_incomplete", "type": "requirement_error", "when": "Company lacks register information on the transferee, so may not register (s771)." }, { "code": "uncertificated_shares_unsupported", "type": "jurisdiction_error", "when": "CREST or other uncertificated shares are outside this action." }, { "code": "stamp_duty_overdue", "type": "requirement_error", "when": "Form is over 30 days old and unsubmitted; penalties and interest may apply; customer must acknowledge." } ] } }, "Params_uk_share_capital_consolidate": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class being consolidated.", "examples": [ "Ordinary" ] }, "shares_before": { "type": "integer", "description": "Shares in the class before; checked against the register.", "examples": [ "1000000" ] }, "consolidation_ratio": { "type": "integer", "description": "This many existing shares become one.", "examples": [ "100" ] }, "nominal_value_per_share": { "$ref": "#/components/schemas/Money", "description": "Must equal the old value multiplied by the ratio.", "examples": [ "1.00 GBP" ] }, "fractional_entitlements": { "type": "string", "enum": [ "none_arise", "round_down_with_cash_payment", "round_up_by_allotment", "aggregate_and_sell_fractions" ], "description": "Treatment of holdings that do not divide evenly; must be authorised by the articles or resolution." }, "rights_attached_unchanged": { "type": "boolean", "description": "Every new share carries the rights of the shares it replaces." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members' resolution is passed (s618).", "examples": [ "2026-11-03" ] }, "resolution_type": { "type": "string", "enum": [ "ordinary", "special" ], "description": "Ordinary unless the articles require more; special if the articles must change." } }, "required": [ "registration_jurisdiction", "entity_type", "share_class", "shares_before", "consolidation_ratio", "nominal_value_per_share", "fractional_entitlements", "rights_attached_unchanged", "resolution_date" ], "description": "Consolidates shares of a class into fewer shares of larger nominal value with the same rights, keeping the paid-to-unpaid proportion (s618). Entiva settles how fractional entitlements are handled, collects the authorising resolution." }, "Create_uk_share_capital_consolidate": { "type": "object", "properties": { "type": { "const": "uk.share_capital.consolidate" }, "params": { "$ref": "#/components/schemas/Params_uk_share_capital_consolidate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Consolidate shares into a larger nominal value", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution_consolidation", "title": "Members' resolution authorising the consolidation", "source": "generated", "required": true }, { "key": "board_resolution_consolidation", "title": "Directors' resolution implementing it", "source": "generated", "required": true }, { "key": "special_resolution_articles", "title": "Special resolution and amended articles", "source": "generated", "required": false }, { "key": "sh02_notice", "title": "SH02 with statement of capital", "source": "generated", "required": true }, { "key": "fractions_schedule", "title": "Schedule of fractional entitlements and payments", "source": "generated", "required": false }, { "key": "replacement_share_certificate", "title": "Replacement share certificates", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution_consolidation", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_consolidation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh02_notice", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "replacement_share_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House: 'Upload a document' service", "form": "SH02", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "articles_exclude_consolidation", "type": "requirement_error", "when": "Articles exclude or restrict consolidation (s618)." }, { "code": "ratio_value_mismatch", "type": "invalid_request_error", "when": "New nominal value is not old value multiplied by the ratio." }, { "code": "fractions_not_authorised", "type": "requirement_error", "when": "Holdings do not divide evenly and the articles or resolution do not authorise the chosen treatment." }, { "code": "different_rights_unsupported", "type": "invalid_request_error", "when": "Rights would differ; use the class-rights variation action." }, { "code": "notice_overdue", "type": "requirement_error", "when": "Over one month since the consolidation; offence under s619; customer must acknowledge." } ] } }, "Params_uk_share_capital_redenominate": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ] }, "scope": { "type": "string", "enum": [ "all_share_capital", "single_class" ], "description": "All share capital or one class (s622)." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Required when scope is single_class.", "examples": [ "Ordinary" ] }, "target_currency": { "type": "string", "description": "ISO 4217 code of the new currency.", "examples": [ "USD" ] }, "rate_basis": { "type": "string", "enum": [ "spot_on_day", "average_over_period" ], "description": "Spot rate on a specified day, or the average of daily rates over a specified period (s622)." }, "exchange_rate": { "type": "number", "description": "Units of the new currency per unit of the old, as stated in the resolution.", "examples": [ "1.305" ] }, "rate_date": { "type": "string", "format": "date", "description": "For spot_on_day; within the 28 days ending the day before the resolution (s622).", "examples": [ "2026-10-16" ] }, "rate_period_start": { "type": "string", "format": "date", "description": "For average_over_period.", "examples": [ "2026-09-28" ] }, "rate_period_end": { "type": "string", "format": "date", "description": "For average_over_period; within the same 28-day window.", "examples": [ "2026-10-16" ] }, "rate_source": { "type": "string", "description": "Where the rate comes from; the Act asks for an 'appropriate' rate and names no source.", "examples": [ "Published central bank spot rate for 2026-10-16" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members' resolution is passed.", "examples": [ "2026-10-20" ] }, "effective_date": { "type": "string", "format": "date", "description": "Resolution date or later.", "examples": [ "2026-10-20" ] }, "plan_reduction_s626": { "type": "boolean", "description": "Company intends a follow-up rounding reduction; see notes." } }, "required": [ "registration_jurisdiction", "entity_type", "scope", "target_currency", "rate_basis", "exchange_rate", "rate_source", "resolution_date" ], "description": "Converts the nominal value of all shares, or one class, into another currency at a spot rate stated in the members' resolution. Entiva checks the rate falls in the 28 days before the resolution, collects the resolution, updates the." }, "Create_uk_share_capital_redenominate": { "type": "object", "properties": { "type": { "const": "uk.share_capital.redenominate" }, "params": { "$ref": "#/components/schemas/Params_uk_share_capital_redenominate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redenominate share capital into another currency", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "redenomination_resolution", "title": "Members' resolution to redenominate", "source": "generated", "required": true }, { "key": "exchange_rate_evidence", "title": "Evidence of the spot rate used", "source": "uploaded", "required": true }, { "key": "board_resolution_redenomination", "title": "Directors' resolution implementing it", "source": "generated", "required": true }, { "key": "sh14_notice", "title": "SH14 with statement of capital", "source": "generated", "required": true }, { "key": "replacement_share_certificate", "title": "Replacement share certificates", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "redenomination_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_redenomination", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh14_notice", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "replacement_share_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House: 'Upload a document' service", "form": "SH14", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "rate_outside_window", "type": "invalid_request_error", "when": "Rate date or period is outside the 28 days ending the day before the resolution (s622)." }, { "code": "articles_prohibit_redenomination", "type": "requirement_error", "when": "Articles prohibit or restrict redenomination (s622)." }, { "code": "resolution_lapsed", "type": "requirement_error", "when": "Not effective within 28 days beginning with the day passed (s622); a new resolution is needed." }, { "code": "notice_overdue", "type": "requirement_error", "when": "Over one month since redenominating; offence under s625; customer must acknowledge." } ] } }, "Params_uk_share_capital_reduce_court": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Decides the court: High Court for England and Wales (s641). s1156 names the Court of Session or sheriff court and the High Court; the Chapter 10 court there is." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ] }, "reductions": { "type": "array", "items": {}, "description": "Per class: share_class, method, shares_affected, new_nominal_value_per_share, amount_returned_per_share.", "examples": [ "[{\"share_class\":\"Ordinary\",\"method\":\"reduce_nominal_value\",\"shares_affected\":20000000,\"new_nominal_value_per_share\":\"0.10 GBP\"}]" ] }, "reserve_treatment": { "type": "string", "enum": [ "credit_to_distributable_reserves", "return_to_members", "write_off_losses" ], "description": "What happens to the amount cancelled." }, "involves_diminution_of_unpaid_liability": { "type": "boolean", "description": "Triggers the creditors' right to object unless the court directs otherwise." }, "involves_repayment_to_members": { "type": "boolean", "description": "Repayment of paid-up capital also triggers the creditor procedure unless dispensed." }, "seek_creditor_dispensation": { "type": "boolean", "description": "Ask the court to dispense with the creditor procedure for some or all creditors." }, "below_authorised_minimum": { "type": "boolean", "description": "PLC falling below the authorised minimum: registrar registers only on court direction or after re-registration as private." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution is passed; copy to the registrar within 15 days.", "examples": [ "2026-11-10" ] }, "reason_for_reduction": { "type": "string", "description": "Reasons put to the court; the court may order them published (s648).", "examples": [ "Create distributable reserves to permit a dividend." ] }, "solicitor_instruction_accepted": { "type": "boolean", "description": "Customer accepts the partner solicitors' engagement; court fees and costs are quoted separately." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "reductions", "reserve_treatment", "involves_diminution_of_unpaid_liability", "involves_repayment_to_members", "special_resolution_date", "reason_for_reduction", "solicitor_instruction_accepted" ], "description": "Reduces share capital by special resolution confirmed by the court, the route for PLCs and any company not using the solvency statement. Partner solicitors run the court application and creditor process; Entiva prepares the resolution." }, "Create_uk_share_capital_reduce_court": { "type": "object", "properties": { "type": { "const": "uk.share_capital.reduce_court" }, "params": { "$ref": "#/components/schemas/Params_uk_share_capital_reduce_court" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reduce share capital with court confirmation", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_reduction", "title": "Directors' resolution proposing the reduction and instructing solicitors", "source": "generated", "required": true }, { "key": "special_resolution_reduction", "title": "Special resolution to reduce share capital", "source": "generated", "required": true }, { "key": "solicitor_engagement", "title": "Engagement letter with the partner solicitors", "source": "generated", "required": true }, { "key": "court_application_papers", "title": "Claim form or petition, evidence and draft order", "source": "uploaded", "required": true }, { "key": "witness_statement_or_affidavit", "title": "Director's witness statement or affidavit", "source": "generated", "required": true }, { "key": "creditor_list_and_notices", "title": "Creditor list and notices", "source": "uploaded", "required": false }, { "key": "court_order", "title": "Court order confirming the reduction", "source": "uploaded", "required": true }, { "key": "sh19_statement_of_capital", "title": "SH19 statement of capital approved by the court", "source": "generated", "required": true }, { "key": "registrar_certificate", "title": "Registrar's certificate of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "special_resolution_reduction", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_reduction", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "solicitor_engagement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "witness_statement_or_affidavit", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "witness_statement_or_affidavit", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "sh19_statement_of_capital", "signer_role": "lawyer", "method": "wet_ink", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH19 statement of capital approved", "channel": "paper", "government_fee": { "amount": 20, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "articles_prohibit_reduction", "type": "requirement_error", "when": "Articles restrict or prohibit a reduction (s641)." }, { "code": "creditor_process_incomplete", "type": "requirement_error", "when": "Creditor list unsettled or a listed creditor neither consented nor paid or secured (ss646, 648)." }, { "code": "below_authorised_minimum_unresolved", "type": "requirement_error", "when": "PLC below the authorised minimum with no court direction or re-registration." }, { "code": "licensed_professional_unavailable", "type": "jurisdiction_error", "when": "No partner solicitor engaged for the chosen court." }, { "code": "cic_distribution_exceeds_paid_up", "type": "requirement_error", "when": "CIC would repay more than the paid-up value." } ] } }, "Params_uk_share_capital_reduce_solvency": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "cic" ], "description": "Public companies cannot use this route." }, "reductions": { "type": "array", "items": {}, "description": "Per class: share_class, method, shares_affected, new_nominal_value_per_share, amount_returned_per_share.", "examples": [ "[{\"share_class\":\"Ordinary\",\"method\":\"reduce_nominal_value\",\"shares_affected\":100000,\"new_nominal_value_per_share\":\"0.10 GBP\"}]" ] }, "reserve_treatment": { "type": "string", "enum": [ "credit_to_distributable_reserves", "return_to_members", "write_off_losses" ], "description": "What happens to the amount cancelled." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "How members pass the special resolution." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution is passed; the 15-day deadline runs from here.", "examples": [ "2026-10-28" ] }, "solvency_statement_date": { "type": "string", "format": "date", "description": "Date the directors make the statement; at most 15 days before resolution_date (s642).", "examples": [ "2026-10-26" ] }, "winding_up_planned_within_12_months": { "type": "boolean", "description": "Selects the second opinion in s643: debts paid in full within 12 months of winding up, or as they fall due over the next year." }, "liabilities_reviewed": { "type": "boolean", "description": "Directors confirm they weighed all liabilities including contingent and prospective ones (s643)." }, "affects_class_rights": { "type": "boolean", "description": "True if class rights are varied; adds a class-consent requirement." }, "same_day": { "type": "boolean", "description": "Same-day Companies House service; needs SH19, resolution and statement uploaded by 11am." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "reductions", "reserve_treatment", "resolution_method", "resolution_date", "solvency_statement_date", "winding_up_planned_within_12_months", "liabilities_reviewed" ], "description": "Reduces the share capital of a private company limited by shares, or a CIC, by special resolution supported by a solvency statement signed by every director. Entiva sequences the statement before the resolution, delivers it to members." }, "Create_uk_share_capital_reduce_solvency": { "type": "object", "properties": { "type": { "const": "uk.share_capital.reduce_solvency" }, "params": { "$ref": "#/components/schemas/Params_uk_share_capital_reduce_solvency" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reduce share capital by solvency statement", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution_reduction", "title": "Directors' resolution proposing the reduction", "source": "generated", "required": true }, { "key": "solvency_statement", "title": "Solvency statement", "source": "generated", "required": true }, { "key": "special_resolution_reduction", "title": "Special resolution to reduce share capital", "source": "generated", "required": true }, { "key": "directors_statement_s644", "title": "Directors' statement that the solvency statement was made within 15 days before the resolution and.", "source": "generated", "required": true }, { "key": "sh19_statement_of_capital", "title": "SH19 statement of capital after the reduction", "source": "generated", "required": true }, { "key": "solvency_basis_papers", "title": "Accounts and forecasts supporting the directors' opinion", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "solvency_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_statement_s644", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution_reduction", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_reduction", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh19_statement_of_capital", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House: 'Upload a document' service", "form": "SH19 with the solvency statement, directors' statement and special resolution", "channel": "online", "government_fee": { "amount": 20, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "solvency_statement_stale", "type": "requirement_error", "when": "Statement is dated more than 15 days before, or after, the resolution (s642)." }, { "code": "directors_signature_missing", "type": "requirement_error", "when": "Not every director has signed the solvency statement." }, { "code": "no_non_redeemable_shares_remaining", "type": "invalid_request_error", "when": "No member would hold non-redeemable shares (s641)." }, { "code": "articles_prohibit_reduction", "type": "requirement_error", "when": "Articles restrict or prohibit a reduction (s641)." }, { "code": "public_company_not_eligible", "type": "jurisdiction_error", "when": "PLCs cannot use this route; use uk.share_capital.reduce_court." }, { "code": "cic_distribution_exceeds_paid_up", "type": "requirement_error", "when": "CIC would repay more than the paid-up value." }, { "code": "filing_window_missed", "type": "requirement_error", "when": "Over 15 days since the resolution; offence under s644; customer must acknowledge." } ] } }, "Params_uk_share_capital_subdivide": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class being sub-divided.", "examples": [ "Ordinary" ] }, "shares_before": { "type": "integer", "description": "Shares in the class before; checked against the register.", "examples": [ "1000" ] }, "subdivision_ratio": { "type": "integer", "description": "Each existing share becomes this many.", "examples": [ "100" ] }, "nominal_value_per_share": { "$ref": "#/components/schemas/Money", "description": "Must equal the old value divided by the ratio.", "examples": [ "0.01 GBP" ] }, "rights_attached_unchanged": { "type": "boolean", "description": "Every new share carries the rights of the share it came from." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members' resolution is passed (s618).", "examples": [ "2026-10-22" ] }, "resolution_type": { "type": "string", "enum": [ "ordinary", "special" ], "description": "Ordinary unless the articles require more; special if the articles must change." } }, "required": [ "registration_jurisdiction", "entity_type", "share_class", "shares_before", "subdivision_ratio", "nominal_value_per_share", "rights_attached_unchanged", "resolution_date" ], "description": "Sub-divides shares of a class into more shares of smaller nominal value with the same rights, keeping the paid-to-unpaid proportion on each new share (s618). Entiva collects the authorising resolution, updates the register, issues." }, "Create_uk_share_capital_subdivide": { "type": "object", "properties": { "type": { "const": "uk.share_capital.subdivide" }, "params": { "$ref": "#/components/schemas/Params_uk_share_capital_subdivide" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Sub-divide shares into a smaller nominal value", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution_subdivision", "title": "Members' resolution authorising the sub-division", "source": "generated", "required": true }, { "key": "board_resolution_subdivision", "title": "Directors' resolution implementing it", "source": "generated", "required": true }, { "key": "special_resolution_articles", "title": "Special resolution and amended articles", "source": "generated", "required": false }, { "key": "sh02_notice", "title": "SH02 with statement of capital", "source": "generated", "required": true }, { "key": "replacement_share_certificate", "title": "Replacement share certificates", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution_subdivision", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution_subdivision", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh02_notice", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "replacement_share_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House: 'Upload a document' service", "form": "SH02", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "articles_exclude_subdivision", "type": "requirement_error", "when": "Articles exclude or restrict sub-division (s618)." }, { "code": "ratio_value_mismatch", "type": "invalid_request_error", "when": "New nominal value is not old value divided by the ratio." }, { "code": "different_rights_unsupported", "type": "invalid_request_error", "when": "Rights would differ; use the class-rights variation action." }, { "code": "notice_overdue", "type": "requirement_error", "when": "Over one month since the sub-division; offence under s619; customer must acknowledge." } ] } }, "Params_uk_share_option_exercise": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc" ], "description": "Entity type key." }, "option_ledger_id": { "type": "string", "description": "Entiva option ledger id from uk.share_option.grant, or a ledger id created for an option granted earlier.", "examples": [ "opt_3Ck8WrQ5tNd2" ] }, "optionee": { "type": "string", "pattern": "^per_", "description": "Person exercising." }, "exercise_date": { "type": "string", "format": "date", "description": "Date the optionee gives notice and pays." }, "allotment_date": { "type": "string", "format": "date", "description": "Date the company allots the shares." }, "number_of_shares": { "type": "integer", "description": "Shares allotted on this exercise." }, "exercise_price_paid": { "$ref": "#/components/schemas/Money", "description": "Cash paid." }, "payment_received_date": { "type": "string", "format": "date", "description": "Date cleared funds reach the company." }, "tax_treatment": { "type": "string", "enum": [ "emi_qualifying", "emi_disqualifying_event", "other_option" ], "description": "emi_disqualifying_event and other_option may create PAYE and NIC for the employer; Entiva does not run payroll." }, "payroll_confirmed": { "type": "boolean", "description": "Required for emi_disqualifying_event and other_option: confirms the payroll provider has been told." }, "allotment_authority_basis": { "type": "string", "enum": [ "existing_right_to_subscribe", "employees_share_scheme", "directors_authority_s550_or_s551" ], "description": "Basis for the directors' power to allot." }, "pre_emption_position": { "type": "string", "enum": [ "employees_share_scheme_exception", "disapplied_by_articles_or_resolution", "offered_to_existing_holders" ], "description": "Allotments under an employees' share scheme are excepted from pre-emption." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH01." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "option_ledger_id", "optionee", "exercise_date", "allotment_date", "number_of_shares", "exercise_price_paid", "payment_received_date", "tax_treatment", "allotment_authority_basis", "pre_emption_position" ], "description": "An optionee exercises an option, pays the price, and the company allots the shares. Entiva checks vesting and tax treatment, records the board allotment, issues the certificate, updates the register of members, and files SH01 with a." }, "Create_uk_share_option_exercise": { "type": "object", "properties": { "type": { "const": "uk.share_option.exercise" }, "params": { "$ref": "#/components/schemas/Params_uk_share_option_exercise" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Exercise a share option and allot the shares", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exercise_notice", "title": "Exercise notice from the optionee", "source": "uploaded", "required": true }, { "key": "payment_evidence", "title": "Evidence of payment", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board resolution allotting the shares", "source": "generated", "required": true }, { "key": "sh01_return", "title": "SH01 return of allotment with statement of capital", "source": "generated", "required": true }, { "key": "share_certificate", "title": "Share certificate", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "none" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "exercise_notice", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_certificate", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sh01_return", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "option_not_exercisable", "type": null, "when": "The option has not vested, has lapsed, or the exercise event has not occurred." }, { "code": "exercise_exceeds_balance", "type": null, "when": "number_of_shares exceeds the vested, unexercised balance." }, { "code": "payment_not_received", "type": null, "when": "Cleared funds for the exercise price are not confirmed." }, { "code": "price_mismatch", "type": null, "when": "exercise_price_paid does not equal price per share times shares." }, { "code": "payroll_not_confirmed", "type": null, "when": "tax_treatment is emi_disqualifying_event or other_option and payroll_confirmed is not true." }, { "code": "allotment_authority_missing", "type": null, "when": "No authority basis is recorded for the allotment." }, { "code": "psc_threshold_crossed", "type": null, "when": "The allotment takes the optionee over a PSC threshold; a uk.psc.* action is raised." } ] } }, "Params_uk_share_option_grant": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc" ], "description": "Entity type key." }, "scheme_type": { "type": "string", "enum": [ "emi", "csop", "unapproved" ], "description": "Only EMI eligibility is checked." }, "optionee": { "type": "string", "pattern": "^per_", "description": "Employee receiving the option." }, "grant_date": { "type": "string", "format": "date", "description": "Date the option is granted." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class of shares under option." }, "number_of_shares": { "type": "integer", "description": "Number, or maximum number, of shares that may be acquired." }, "exercise_price_per_share": { "$ref": "#/components/schemas/Money", "description": "Price payable by the employee, or set the method in exercise_conditions." }, "actual_market_value_per_share": { "$ref": "#/components/schemas/Money", "description": "Market value at grant." }, "market_value_basis": { "type": "string", "enum": [ "hmrc_agreed_valuation", "independent_valuation", "company_assessment" ], "description": "How the market value was fixed." }, "exercise_conditions": { "type": "object", "description": "When and how the option may be exercised, plus any vesting or performance conditions: {vesting_schedule, performance_conditions[], exercise_events[]." }, "exercise_period_years": { "type": "string", "enum": [ "10", "15" ], "description": "emi only. 15 years is available where the higher limits apply and the option is exercised on or after 6 April 2026." }, "employee_works_required_hours": { "type": "boolean", "description": "emi only: employee works at least 25 hours a week or 75% of working time for the company." }, "employer_eligibility": { "type": "object", "description": "emi only: {gross_assets, full_time_equivalent_employees, unexercised_emi_options_value, qualifying_trade_confirmed, excluded_activity: false}." }, "employee_options_value_3yr": { "$ref": "#/components/schemas/Money", "description": "emi only: value of options held by the employee in the 3-year period." }, "ni_goods_or_electricity": { "type": "boolean", "description": "emi only: registered office in Northern Ireland and trade in goods or electricity, which excludes the higher limits." }, "interested_director_declared": { "type": "boolean", "description": "Confirms any director who is the optionee has declared their interest." }, "create_emi_notification": { "type": "boolean", "description": "Default true for emi: creates a draft uk.emi_options.notify action linked to this grant." } }, "required": [ "registration_jurisdiction", "entity_type", "scheme_type", "optionee", "grant_date", "share_class", "number_of_shares", "exercise_price_per_share", "exercise_conditions", "interested_director_declared" ], "description": "The company grants options over its shares. Entiva checks Enterprise Management Incentives eligibility when the scheme is EMI, drafts the option agreement with the terms the ITEPA 2003 Sch 5 requires, collects the board approval and." }, "Create_uk_share_option_grant": { "type": "object", "properties": { "type": { "const": "uk.share_option.grant" }, "params": { "$ref": "#/components/schemas/Params_uk_share_option_grant" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Grant share options to an employee", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "option_agreement", "title": "Option agreement", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution granting the option", "source": "generated", "required": true }, { "key": "emi_eligibility_checklist", "title": "EMI eligibility checklist", "source": "generated", "required": false }, { "key": "valuation_evidence", "title": "Valuation evidence", "source": "uploaded", "required": false }, { "key": "option_scheme_rules", "title": "Option scheme rules", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "none" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "option_agreement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "option_agreement", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None at grant. EMI notification to HMRC is uk.emi_options.notify", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "emi_company_limit_exceeded", "type": null, "when": "Gross assets exceed GBP 120m, full-time employees reach 500, or unexercised EMI options exceed GBP 6m." }, { "code": "emi_employee_limit_exceeded", "type": null, "when": "The employee would hold options over GBP 250,000 in a 3-year period." }, { "code": "emi_working_time_not_met", "type": null, "when": "The employee does not work 25 hours a week or 75% of working time for the company." }, { "code": "emi_excluded_activity", "type": null, "when": "The company carries on an excluded activity such as banking, farming, property development, legal services or ship building." }, { "code": "exercise_period_invalid", "type": null, "when": "15 years chosen where the higher limits do not apply, for example a Northern Ireland goods or electricity company." }, { "code": "agreement_terms_incomplete", "type": null, "when": "The agreement lacks a term required by Sch 5 para 37." }, { "code": "insufficient_shares_available", "type": null, "when": "The option shares exceed unissued capacity or the articles do not allow the issue." } ] } }, "Params_uk_treasury_share_cancel": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic" ], "description": "Entity type key." }, "cancellations": { "type": "array", "items": {}, "description": "Items {share_class, number_of_shares, nominal_value_per_share, cancellation_date}.", "examples": [ "[{\"share_class\":\"Ordinary\",\"number_of_shares\":300,\"nominal_value_per_share\":{\"amount\":0.01,\"currency\":\"GBP\"},\"cancellation_date\":\"2026-10-16\"}]" ] }, "statement_of_capital_confirmed": { "type": "boolean", "description": "A director confirms the statement of capital Entiva builds from the register is right immediately after the cancellation." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH05." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "cancellations", "statement_of_capital_confirmed" ], "description": "A company cancels shares it holds in treasury. The directors may take the steps needed without a capital-reduction procedure." }, "Create_uk_treasury_share_cancel": { "type": "object", "properties": { "type": { "const": "uk.treasury_share.cancel" }, "params": { "$ref": "#/components/schemas/Params_uk_treasury_share_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel treasury shares", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution cancelling treasury shares", "source": "generated", "required": true }, { "key": "sh05_notice", "title": "SH05 notice of cancellation of treasury shares", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh05_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH05", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "shares_not_in_treasury", "type": null, "when": "The company does not hold the stated number of shares in treasury." }, { "code": "statement_of_capital_mismatch", "type": null, "when": "The confirmed statement of capital does not match the register after cancellation." }, { "code": "cancellation_date_in_future", "type": null, "when": "cancellation_date is after today." } ] } }, "Params_uk_treasury_share_transfer": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "plc", "cic" ], "description": "Entity type key." }, "disposal_type": { "type": "string", "enum": [ "sale_for_cash", "transfer_for_employees_share_scheme" ], "description": "A treasury share may be sold for cash consideration, or transferred only for the purposes of or under an employees' share scheme." }, "disposals": { "type": "array", "items": {}, "description": "Items {buyer: person_ref or entity_ref, share_class, number_of_shares, nominal_value_per_share, price_per_share, disposal_date}.", "examples": [ "[{\"buyer\":\"per_2Wn5YdK9cRh1Tb\",\"share_class\":\"Ordinary\",\"number_of_shares\":200,\"nominal_value_per_share\":{\"amount\":0.01,\"currency\":\"GBP\"},\"price_per_share\":{\"amount\":12.50,\"currency\":\"GBP\"},\"disposal_date\":\"2026-10-16\"}]" ] }, "employees_share_scheme_reference": { "type": "string", "description": "Scheme name or ID." }, "pre_emption_position": { "type": "string", "enum": [ "offered_to_existing_holders", "disapplied_by_articles_or_resolution", "employees_share_scheme_exception" ], "description": "How pre-emption rights were dealt with." }, "stamp_duty_basis": { "type": "string", "enum": [ "duty_payable", "certificate_1000_or_less", "other_exemption_claimed" ], "description": "Stock transfer form duty at 0.5% over GBP 1,000." }, "takeover_notice_checked": { "type": "boolean", "description": "Confirms no s979 squeeze-out notice restricts the sale (s727)." }, "signatory": { "type": "string", "enum": [ "director", "secretary", "person_authorised" ], "description": "Who signs the SH04." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "registration_jurisdiction", "entity_type", "disposal_type", "disposals", "pre_emption_position", "takeover_notice_checked" ], "description": "A company sells treasury shares for cash, or transfers them for an employees' share scheme. Entiva checks the shares are held in treasury, handles the transfer form and any stamp duty, updates the register of members and files SH04." }, "Create_uk_treasury_share_transfer": { "type": "object", "properties": { "type": { "const": "uk.treasury_share.transfer" }, "params": { "$ref": "#/components/schemas/Params_uk_treasury_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Sell or transfer treasury shares", "x-entiva": { "jurisdiction": "uk", "stage": "ownership_and_capital", "applies_to": [ "private_ltd_shares", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the sale or transfer", "source": "generated", "required": true }, { "key": "sale_agreement", "title": "Sale agreement", "source": "uploaded", "required": false }, { "key": "stock_transfer_form", "title": "Stock transfer form", "source": "generated", "required": true }, { "key": "hmrc_stamp_duty_letter", "title": "HMRC stamping confirmation", "source": "registry_issued", "required": false }, { "key": "sh04_notice", "title": "SH04 notice of sale or transfer of treasury shares", "source": "generated", "required": true }, { "key": "companies_house_receipt", "title": "Companies House acceptance", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stock_transfer_form", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sh04_notice", "signer_role": "company_secretary", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SH04", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "shares_not_in_treasury", "type": null, "when": "The company does not hold the stated number of shares in treasury." }, { "code": "non_cash_sale", "type": null, "when": "Sale consideration is not cash as defined in s727." }, { "code": "transfer_not_for_employee_scheme", "type": null, "when": "A transfer is requested outside an employees' share scheme." }, { "code": "squeeze_out_restriction", "type": null, "when": "A s979 notice restricts the sale to the notifying person (s727)." }, { "code": "pre_emption_unresolved", "type": null, "when": "No pre-emption position is recorded." }, { "code": "stamp_duty_unconfirmed", "type": null, "when": "Duty is payable and HMRC's confirmation has not arrived." } ] } }, "Params_uk_accounting_reference_date_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the entity is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "accounting_reference_date": { "type": "object", "description": "New accounting reference date as {day, month}, for example the last day of March.", "examples": [ "{\"day\":31,\"month\":3}" ] }, "period_to_change": { "type": "string", "enum": [ "current", "previous" ], "description": "current: the current accounting reference period and later periods. previous: the immediately previous period and later periods.", "examples": [ "current" ] }, "direction": { "type": "string", "enum": [ "shorten", "extend" ], "description": "The notice must state whether the chosen period is shortened or extended.", "examples": [ "extend" ] }, "extension_exception": { "type": "string", "enum": [ "none", "aligned_with_uk_parent_or_subsidiary", "in_administration", "secretary_of_state_direction" ], "description": "Why a second extension within five years is allowed: aligned_with_uk_parent_or_subsidiary, in_administration or secretary_of_state_direction.", "examples": [ "none" ] }, "aligned_undertaking_number": { "type": "string", "description": "Company number of the UK parent or subsidiary whose ARD is being matched.", "examples": [ "09876543" ] }, "secretary_of_state_direction_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the direction.", "examples": [ "doc_1Wc7LsB3fXa" ] }, "business_reason": { "type": "string", "description": "Reason for shortening.", "examples": [ "Aligning year end with new parent" ] } }, "required": [ "registration_jurisdiction", "accounting_reference_date", "period_to_change", "direction" ], "description": "Shortens or extends the current or previous accounting reference period by notifying Companies House on AA01 before the filing deadline for the period concerned. Extensions are limited to 18 months and, normally, to once in five years." }, "Create_uk_accounting_reference_date_change": { "type": "object", "properties": { "type": { "const": "uk.accounting_reference_date.change" }, "params": { "$ref": "#/components/schemas/Params_uk_accounting_reference_date_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the accounting reference date", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' decision to change the accounting reference date", "source": "generated", "required": true }, { "key": "parent_alignment_evidence", "title": "Evidence of the parent or subsidiary's ARD", "source": "uploaded", "required": false }, { "key": "secretary_of_state_direction", "title": "Secretary of State direction disapplying the five-year rule", "source": "uploaded", "required": false }, { "key": "aa01_notice", "title": "AA01 / LL AA01 notice of new accounting reference date", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the notice", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acknowledgement and updated accounts due date", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AA01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ard_period_exceeds_18_months", "type": null, "when": "[requirement_error] The extended period would run longer than 18 months from its start." }, { "code": "ard_extension_within_five_years", "type": null, "when": "[requirement_error] An earlier period was extended less than five years ago and no exception applies." }, { "code": "accounts_deadline_passed", "type": null, "when": "[requirement_error] The previous period's filing deadline has passed, so it can no longer be changed." }, { "code": "new_deadline_already_passed", "type": null, "when": "[requirement_error] The new deadline for the period has already passed, so an automatic late-filing penalty would apply." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the AA01, for example for the 18-month limit." } ] } }, "Params_uk_articles_amend": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the company is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "amendment_type": { "type": "string", "enum": [ "full_replacement", "specific_clauses" ], "description": "full_replacement adopts a whole new set of articles; specific_clauses changes named articles only.", "examples": [ "specific_clauses" ] }, "clause_changes": { "type": "array", "items": {}, "description": "List of {clause, summary} describing each change.", "examples": [ "[{\"clause\":\"Article 24\",\"summary\":\"Allow share certificates to be issued electronically\"}]" ] }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of complete articles as amended, if the customer supplies them.", "examples": [ "doc_6Hm1VtC4rQe" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed.", "examples": [ "2026-10-14" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the amendment takes effect if later than the resolution.", "examples": [ "2026-10-14" ] }, "entrenched_provisions_affected": { "type": "boolean", "description": "True if the change adds, removes or touches entrenched provisions.", "examples": [ "false" ] }, "cic_objects_or_asset_lock_changed": { "type": "boolean", "description": "For a CIC: must be false.", "examples": [ "false" ] } }, "required": [ "registration_jurisdiction", "amendment_type", "resolution_date" ], "description": "Amends a company's articles by special resolution and files the resolution and a copy of the amended articles with Companies House within 15 days. Changes to a CIC's objects or asset-locked body and amendments by charities have their own." }, "Create_uk_articles_amend": { "type": "object", "properties": { "type": { "const": "uk.articles.amend" }, "params": { "$ref": "#/components/schemas/Params_uk_articles_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend the articles of association", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution recommending the amendment", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution amending the articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles of association as amended", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the upload", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acceptance of the resolution and articles", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "No prescribed form: copy of the special resolution", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_cic_objects_action", "type": null, "when": "[invalid_request_error] The change alters a CIC's objects." }, { "code": "use_cic_asset_lock_action", "type": null, "when": "[invalid_request_error] The change alters the CIC's nominated asset-locked body." }, { "code": "cic_mandatory_clause_altered", "type": null, "when": "[requirement_error] The draft removes or alters a mandatory CIC clause." }, { "code": "charity_use_charity_action", "type": null, "when": "[invalid_request_error] The company is a registered charity." }, { "code": "limited_exemption_would_lapse", "type": null, "when": "[requirement_error] The change would stop a guarantee company meeting the conditions that exempt it from using 'limited'." }, { "code": "resolution_threshold_not_met", "type": null, "when": "[requirement_error] Signed votes do not reach 75%." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected an uploaded document." } ] } }, "Params_uk_charitable_company_articles_amend": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the company is registered.", "examples": [ "england_wales" ] }, "charity_regulator": { "type": "string", "enum": [ "charity_commission", "oscr", "ccni" ], "description": "Regulator.", "examples": [ "charity_commission" ] }, "charity_registration_number": { "type": "string", "description": "Registered charity number with the regulator.", "examples": [ "1198765" ] }, "regulated_alteration_types": { "type": "array", "items": {}, "description": "Array of any of: purposes, benefits_to_trustees_or_connected_persons, dissolution_clause, other_requiring_authority, none.", "examples": [ "[\"dissolution_clause\"]" ] }, "changes": { "type": "array", "items": {}, "description": "Each change as {clause, old_summary, new_summary}.", "examples": [ "[{\"clause\":\"Article 41\",\"old_summary\":\"Surplus assets go to named charity A\",\"new_summary\":\"Surplus assets go to a charity with similar purposes chosen by the trustees\"}]" ] }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the complete amended articles if the customer supplies them.", "examples": [ "doc_4Mk8TqW2bNc" ] }, "regulator_authority_reference": { "type": "string", "description": "Regulator's reference for its written authority or consent.", "examples": [ "AUTH-2026-04417" ] }, "regulator_authority_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the regulator's written authority.", "examples": [ "doc_9Ts3FnR6vLa" ] }, "trustees_resolution_date": { "type": "string", "format": "date", "description": "Date the trustees resolved by a majority of all trustees to propose the change.", "examples": [ "2026-10-05" ] }, "members_resolution_date": { "type": "string", "format": "date", "description": "Date the members passed the special resolution.", "examples": [ "2026-10-12" ] }, "articles_required_majority_percent": { "type": "number", "description": "Higher majority the articles require for a special resolution, if any.", "examples": [ "75" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the amendment takes effect if later than the resolution.", "examples": [ "2026-10-12" ] } }, "required": [ "registration_jurisdiction", "charity_registration_number", "regulated_alteration_types", "changes", "trustees_resolution_date", "members_resolution_date" ], "description": "Amends the articles of a charitable company by special resolution after the charity regulator has authorised any regulated alteration, then files with Companies House within 15 days and notifies the regulator." }, "Create_uk_charitable_company_articles_amend": { "type": "object", "properties": { "type": { "const": "uk.charitable_company_articles.amend" }, "params": { "$ref": "#/components/schemas/Params_uk_charitable_company_articles_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a charitable company's articles", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustees_resolution", "title": "Trustees' resolution proposing the amendment", "source": "generated", "required": true }, { "key": "regulator_authority", "title": "Charity regulator's written authority or consent", "source": "uploaded", "required": false }, { "key": "special_resolution", "title": "Members' special resolution amending the articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as amended", "source": "generated", "required": true }, { "key": "cc04_objects_statement", "title": "CC04 statement of company's objects", "source": "generated", "required": false }, { "key": "regulator_notification_declaration", "title": "Declaration and notification pack for the charity regulator", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the upload", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acceptance of the resolution, articles and authority", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustees_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "regulator_notification_declaration", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Special resolution and amended articles", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "regulator_authority_required", "type": null, "when": "[requirement_error] A regulated alteration is proposed and no regulator authority is attached." }, { "code": "members_vote_before_authority", "type": null, "when": "[requirement_error] The members' vote is scheduled before authority was obtained for a regulated alteration." }, { "code": "members_majority_not_met", "type": null, "when": "[requirement_error] Signed votes do not reach 75% or the higher level in the articles." }, { "code": "regulator_process_not_mapped", "type": null, "when": "" }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the declaration to the regulator." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House or the regulator rejected the filing." } ] } }, "Params_uk_cic_asset_lock_body_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the CIC is registered.", "examples": [ "scotland" ] }, "asset_locked_body": { "type": "object", "description": "The body to nominate: {name, body_type, registration_number}.", "examples": [ "{\"name\":\"Leith Community Trust\",\"body_type\":\"charity\",\"registration_number\":\"SC045678\"}" ] }, "replaces_body_name": { "type": "string", "description": "Name of the asset-locked body currently named in the articles.", "examples": [ "Edinburgh Makers Foundation" ] }, "suitability_check_reference": { "type": "string", "description": "Reference of the Regulator suitability check, if one was made before submission.", "examples": [ "CIC-SUIT-2026-0377" ] }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed.", "examples": [ "2026-10-11" ] }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the amended articles.", "examples": [ "doc_2Ym6RtF9wCe" ] }, "transfer_assets": { "type": "object", "description": "Set only if assets are also to move for less than full consideration to an asset-locked body not named in the articles: {description, recipient_name.", "examples": [ "{\"description\":\"Workshop equipment\",\"recipient_name\":\"Leith Community Trust\",\"consideration\":\"nil\"}" ] } }, "required": [ "registration_jurisdiction", "asset_locked_body", "special_resolution_date" ], "description": "Changes the asset-locked body named in a community interest company's articles by special resolution and amended articles filed at Companies House. A suitability check with the Regulator may be needed first, and any transfer of assets to a." }, "Create_uk_cic_asset_lock_body_change": { "type": "object", "properties": { "type": { "const": "uk.cic_asset_lock_body.change" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_asset_lock_body_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a CIC's nominated asset-locked body", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution recommending the change of asset-locked body", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles amended to name the new asset-locked body", "source": "generated", "required": true }, { "key": "asset_locked_body_evidence", "title": "Evidence of the nominated body's status", "source": "uploaded", "required": true }, { "key": "cic53_application_to_transfer_assets", "title": "CIC53 application to transfer assets", "source": "generated", "required": false }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the upload", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acceptance of the resolution and articles", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "cic53_application_to_transfer_assets", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Special resolution and amended articles", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cic_cannot_nominate_itself", "type": null, "when": "[invalid_request_error] The nominated asset-locked body is the CIC itself." }, { "code": "asset_locked_body_unsuitable", "type": null, "when": "[requirement_error] The nominated body does not appear to be a permitted asset-locked body; a Regulator suitability check is recommended." }, { "code": "resolution_part_b_missing", "type": null, "when": "[requirement_error] Part B of the resolution does not name the body." }, { "code": "regulator_consent_required", "type": null, "when": "[requirement_error] An asset transfer to an unnamed body is proposed without CIC53 consent." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected an uploaded document." } ] } }, "Params_uk_cic_objects_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the CIC is registered.", "examples": [ "england_wales" ] }, "objects": { "type": "string", "description": "The statement of objects as it will read after the change.", "examples": [ "To provide affordable community workshops and training for residents of Hackney." ] }, "current_objects": { "type": "string", "description": "Current statement of objects.", "examples": [ "To provide community workshops for residents of Hackney." ] }, "community_interest_statement": { "type": "string", "description": "The community interest statement for the new objects.", "examples": [ "The company's activities will benefit residents who lack access to affordable workshop space." ] }, "notification_steps": { "type": "string", "description": "Steps taken to bring the proposed alteration to the notice of persons affected by the company's activities (CIC Regulations 2005 reg 14); the statement must be.", "examples": [ "Letters to 120 residents, website and workshop notice for 21 days, public meeting on 28 Sep 2026." ] }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed.", "examples": [ "2026-10-09" ] }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the articles as amended.", "examples": [ "doc_7Lt3NqM8bYe" ] }, "directors_signings": { "type": "array", "items": {}, "description": "per_ ids of every director.", "examples": [ "[\"per_4Cv8MnT2aKe\",\"per_9Xd1PqH6wLs\"]" ] }, "regulator_precheck_reference": { "type": "string", "description": "Reference of any informal advice from the CIC Regulator on the new objects.", "examples": [ "CIC-ADV-2026-0412" ] } }, "required": [ "registration_jurisdiction", "objects", "community_interest_statement", "notification_steps", "special_resolution_date", "directors_signings" ], "description": "Changes the objects of a community interest company by special resolution, amended articles, form CC04 and form CIC14. Companies House refers the documents to the CIC Regulator, and the change has no effect unless the Regulator approves." }, "Create_uk_cic_objects_change": { "type": "object", "properties": { "type": { "const": "uk.cic_objects.change" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_objects_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Alter a CIC's objects", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution recommending the change of objects", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution altering the objects", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles amended to match the resolution", "source": "generated", "required": true }, { "key": "cc04_objects_statement", "title": "CC04 notice of change of the company's objects", "source": "generated", "required": true }, { "key": "cic14_community_interest_statement", "title": "CIC14 'altering the objects of a community interest company': community interest statement and.", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the upload", "source": "generated", "required": true }, { "key": "regulator_approval_notice", "title": "CIC Regulator's approval or refusal, passed through the registrar", "source": "registry_issued", "required": true }, { "key": "registry_confirmation", "title": "Companies House registration of the altered objects and articles", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "cic14_community_interest_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "CC04", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "director_signature_missing", "type": null, "when": "[requirement_error] A director has not signed CIC14." }, { "code": "mandatory_cic_clause_altered", "type": null, "when": "[requirement_error] The draft articles remove or alter a mandatory CIC clause." }, { "code": "regulator_refused", "type": null, "when": "[registry_error] The Regulator refused the alteration; the company may appeal to the Appeal Officer." }, { "code": "community_interest_test_not_met", "type": null, "when": "[requirement_error] The new objects would not meet the community interest test on Entiva's pre-check." }, { "code": "notification_steps_missing", "type": null, "when": "[requirement_error] No statement of steps taken to notify affected persons." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign CIC14." } ] } }, "Params_uk_cio_constitution_amend": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "england_wales is the normal case.", "examples": [ "england_wales" ] }, "cio_type": { "type": "string", "enum": [ "foundation", "association" ], "description": "Foundation CIOs have trustees as their only members; association CIOs have a wider membership.", "examples": [ "association" ] }, "charity_registration_number": { "type": "string", "description": "Charity Commission registration number.", "examples": [ "1204411" ] }, "regulated_alteration_types": { "type": "array", "items": {}, "description": "Array of any of: purposes, benefits_to_trustees_or_connected_persons, dissolution_clause, other_requiring_authority, none.", "examples": [ "[\"purposes\"]" ] }, "changes": { "type": "array", "items": {}, "description": "Each change as {clause, old_summary, new_summary}; the submission needs the exact wording of amended and new clauses.", "examples": [ "[{\"clause\":\"Clause 3\",\"old_summary\":\"Relief of poverty in Greater Manchester\",\"new_summary\":\"Relief of poverty in the North West of England\"}]" ] }, "amended_constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the complete amended constitution if the customer supplies it.", "examples": [ "doc_6Bc2QvN8tMa" ] }, "commission_authority_reference": { "type": "string", "description": "Reference of the Commission's written authority.", "examples": [ "AUTH-2026-05102" ] }, "commission_authority_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the written authority.", "examples": [ "doc_3Hs7PdK1wXe" ] }, "voting_mode": { "type": "string", "enum": [ "general_meeting", "unanimous_outside_meeting" ], "description": "general_meeting: at least 75% of voting members including proxy and postal votes. unanimous_outside_meeting: all members agree by a method the constitution.", "examples": [ "general_meeting" ] }, "constitution_required_majority_percent": { "type": "number", "description": "Higher majority the constitution requires, if any.", "examples": [ "75" ] }, "members_resolution_date": { "type": "string", "format": "date", "description": "Date of the members' resolution.", "examples": [ "2026-10-10" ] }, "effective_date": { "type": "string", "format": "date", "description": "Later effective date set in the resolution.", "examples": [ "2026-10-10" ] } }, "required": [ "registration_jurisdiction", "cio_type", "charity_registration_number", "regulated_alteration_types", "changes", "voting_mode", "members_resolution_date" ], "description": "Amends the constitution of a charitable incorporated organisation by a members' resolution of at least 75%, after the Charity Commission has authorised any regulated alteration, then sends the pack to the Commission within 15 days.." }, "Create_uk_cio_constitution_amend": { "type": "object", "properties": { "type": { "const": "uk.cio_constitution.amend" }, "params": { "$ref": "#/components/schemas/Params_uk_cio_constitution_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a CIO's constitution", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "cio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustees_resolution", "title": "Trustees' resolution proposing the amendment", "source": "generated", "required": true }, { "key": "commission_authority", "title": "Charity Commission written authority for regulated alterations", "source": "uploaded", "required": false }, { "key": "members_resolution", "title": "Members' resolution amending the constitution", "source": "generated", "required": true }, { "key": "amended_constitution", "title": "Constitution as amended", "source": "generated", "required": true }, { "key": "commission_submission_pack", "title": "Pack for the Charity Commission: constitution, name and number, wording of clauses, resolution.", "source": "generated", "required": true }, { "key": "regulator_notification_declaration", "title": "Trustee declaration for the submission", "source": "generated", "required": true }, { "key": "commission_receipt", "title": "Charity Commission receipt or registration of the change", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "trustees_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "regulator_notification_declaration", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "No specific form is described in the guidance", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "commission_authority_required", "type": null, "when": "[requirement_error] A regulated alteration is proposed and no written authority is attached." }, { "code": "members_majority_not_met", "type": null, "when": "[requirement_error] Votes do not reach 75% or the constitution's higher level, or unanimity was not obtained." }, { "code": "foundation_cio_conflict", "type": null, "when": "[requirement_error] A foundation CIO's only members are trustees and a conflict of interest cannot be managed, so Commission authority is needed." }, { "code": "scotland_use_scio_action", "type": null, "when": "[jurisdiction_error] A Scotland-registered body is routed to manual review; Scottish charitable incorporated organisations use uk.scio_constitution.amend." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to cast a vote or sign the trustee declaration." } ] } }, "Params_uk_company_name_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the company is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "name": { "type": "string", "description": "Proposed name including the required ending: Ltd/Limited for private companies, plc/public limited company for PLCs, and the CIC ending for a CIC.", "examples": [ "Harbourline Digital Ltd" ] }, "method": { "type": "string", "enum": [ "special_resolution", "articles_provision" ], "description": "special_resolution: change by special resolution (CA 2006 s77, s78), filed on NM01. articles_provision: change by other means provided for in the articles.", "examples": [ "special_resolution" ] }, "articles_provision_reference": { "type": "string", "description": "Article number that provides the method.", "examples": [ "Article 79(1)" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed, or the date the articles-based change was made.", "examples": [ "2026-10-16" ] }, "conditional": { "type": "boolean", "description": "True if the name change depends on an event.", "examples": [ "false" ] }, "condition_description": { "type": "string", "description": "The event the change depends on.", "examples": [ "Completion of the sale of the trading business" ] }, "condition_met": { "type": "boolean", "description": "Whether the event has occurred.", "examples": [ "false" ] }, "same_day_service": { "type": "boolean", "description": "True for Companies House same-day service.", "examples": [ "false" ] }, "sensitive_word_approval_documents": { "type": "array", "items": {}, "description": "doc_ ids of Secretary of State approval or relevant-body letters needed for sensitive words in the new name.", "examples": [ "[\"doc_8Yk2PfQ5sTe\"]" ] }, "limited_exemption_claimed": { "type": "boolean", "description": "Set true only when the new name omits 'limited' and an exemption applies; then also create uk.limited_suffix_exemption.claim linked to this action.", "examples": [ "false" ] } }, "required": [ "registration_jurisdiction", "name", "method", "resolution_date" ], "description": "Changes the name of a company by special resolution or by another method in its articles. The new name takes effect only when Companies House registers it and issues a new certificate of incorporation on change of name." }, "Create_uk_company_name_change": { "type": "object", "properties": { "type": { "const": "uk.company_name.change" }, "params": { "$ref": "#/components/schemas/Params_uk_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a company's name", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution recommending the name change", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution to change the name", "source": "generated", "required": false }, { "key": "articles_extract", "title": "Articles provision permitting the change of name by other means", "source": "uploaded", "required": false }, { "key": "sensitive_word_approval", "title": "Approval or non-objection letter for sensitive words", "source": "uploaded", "required": false }, { "key": "nm01_or_nm04_notice", "title": "NM01 / NM04 notice of change of name", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the notice", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_on_change_of_name", "title": "Certificate of incorporation on change of name", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "NM01", "channel": "online", "government_fee": { "amount": 20, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_same_as_existing", "type": null, "when": "[invalid_request_error] The name is the same as one on the registrar's index of company names and no group consent applies." }, { "code": "name_requires_approval", "type": null, "when": "[requirement_error] The name contains a sensitive word or expression and no approval document is attached." }, { "code": "name_ending_invalid", "type": null, "when": "[invalid_request_error] The ending does not match the entity type." }, { "code": "limited_suffix_required", "type": null, "when": "[requirement_error] The name omits 'limited' and no exemption action is linked." }, { "code": "resolution_threshold_not_met", "type": null, "when": "[requirement_error] Signed votes do not reach 75% of eligible voting rights." }, { "code": "filing_deadline_passed", "type": null, "when": "[requirement_error] More than 15 days have passed since the resolution; the filing is still made but flagged late." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the notice or the name." } ] } }, "Params_uk_disputed_address_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the company or LLP concerned is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type key of the company concerned.", "examples": [ "private_ltd_shares" ] }, "company_number": { "type": "string", "description": "Companies House number of the company or LLP whose address is disputed.", "examples": [ "09887766" ] }, "address_type": { "type": "string", "enum": [ "registered_office", "director_service_address", "secretary_service_address", "llp_member_service_address", "psc_service_address", "principal_office_address" ], "description": "Which address is disputed.", "examples": [ "registered_office" ] }, "current_address_on_register": { "$ref": "#/components/schemas/Address", "description": "The address now shown on the register.", "examples": [ "{\"line1\":\"Flat 3, 8 Alder Court\",\"locality\":\"Leeds\",\"postal_code\":\"LS6 2AB\",\"country\":\"GB\"}" ] }, "person_concerned": { "type": "string", "pattern": "^per_", "description": "per_ id of the director, secretary, member or PSC whose service address is disputed, if the address is not the registered office.", "examples": [ "per_4Jh8NsB1vTa" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "per_ id of the applicant.", "examples": [ "per_2Fm7QxT9cLa" ] }, "applicant_connection": { "type": "string", "enum": [ "occupier_or_owner_of_address", "officer_or_psc_concerned", "creditor_or_third_party", "other" ], "description": "The applicant's link to the address.", "examples": [ "occupier_or_owner_of_address" ] }, "reason": { "type": "string", "description": "Why the applicant thinks the address is not appropriate for the company.", "examples": [ "The company has no connection with this address and no post for it is accepted or acknowledged here." ] }, "evidence_documents": { "type": "array", "items": {}, "description": "doc_ ids of supporting evidence.", "examples": [ "[\"doc_3Wb9HnK5pRs\"]" ] } }, "required": [ "registration_jurisdiction", "company_number", "address_type", "current_address_on_register", "applicant", "applicant_connection", "reason", "evidence_documents" ], "description": "Asks the registrar to change an address on the register that the applicant says is not appropriate or not connected with the company. Any person can apply." }, "Create_uk_disputed_address_change": { "type": "object", "properties": { "type": { "const": "uk.disputed_address.change" }, "params": { "$ref": "#/components/schemas/Params_uk_disputed_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to change a disputed registered office or service address", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "rp07_application", "title": "RP07 application to change a disputed address", "source": "generated", "required": true }, { "key": "dispute_evidence", "title": "Evidence of the dispute, dated within six months", "source": "uploaded", "required": true }, { "key": "registrar_notice_to_company", "title": "Registrar's notice to the company of intention to change the address", "source": "registry_issued", "required": false }, { "key": "registrar_outcome_notice", "title": "Notice of the outcome of the application", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "rp07_application", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RP07", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "evidence_out_of_date", "type": null, "when": "[requirement_error] Supporting evidence is dated more than six months ago." }, { "code": "applicant_not_verified", "type": null, "when": "[requirement_error] The applicant has not completed identity_address verification." }, { "code": "address_type_not_supported", "type": null, "when": "[jurisdiction_error] Procedure for the chosen non-registered-office address type was not confirmed; Entiva routes it to manual review." }, { "code": "application_refused", "type": null, "when": "[registry_error] The registrar was not satisfied the address is not appropriate; the applicant may appeal to the court." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the applicant's declaration." } ] } }, "Params_uk_limited_suffix_exemption_apply": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the company is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_guarantee", "charitable_company" ], "description": "Entity type key.", "examples": [ "private_ltd_guarantee" ] }, "exemption_basis": { "type": "string", "enum": [ "charity", "guarantee_company_conditions" ], "description": "charity: the company is a charity (CA 2006 s60). guarantee_company_conditions: exemption by regulations (s60; Company and Business Names Regulations 2009, SI.", "examples": [ "guarantee_company_conditions" ] }, "name_change_action_id": { "type": "string", "description": "act_ id of the linked uk.company_name.change action.", "examples": [ "act_7Jd4WsC1nGt" ] }, "charity_registration_number": { "type": "string", "description": "Required when exemption_basis is charity.", "examples": [ "1198765" ] }, "objects_condition_met": { "type": "boolean", "description": "Confirms the objects are the promotion or regulation of commerce, art, science, education, religion, charity or any profession, with anything incidental or.", "examples": [ "true" ] }, "articles_conditions_met": { "type": "boolean", "description": "Confirms the articles require income to be applied to the objects, bar dividends and returns of capital to members, and require surplus assets on winding up to.", "examples": [ "true" ] }, "articles_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the articles showing those clauses.", "examples": [ "doc_5Rw1KtM8cLa" ] } }, "required": [ "registration_jurisdiction", "exemption_basis", "name_change_action_id" ], "description": "Delivers the s60 statement on NE01 so that a company limited by guarantee, or a charitable company, can use a name without 'Limited' or 'cyfyngedig'. It is filed with a change of name, so it must be linked to a uk.company_name.change." }, "Create_uk_limited_suffix_exemption_apply": { "type": "object", "properties": { "type": { "const": "uk.limited_suffix_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_suffix_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Claim exemption from using 'Limited'", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_guarantee", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "articles", "title": "Articles showing the exemption clauses", "source": "uploaded", "required": false }, { "key": "ne01_statement", "title": "NE01 statement of entitlement to exemption from 'limited' or 'cyfyngedig'", "source": "generated", "required": true }, { "key": "entitlement_confirmation", "title": "Director's confirmation that the company meets the conditions", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the filing", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acceptance with the name change", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "entitlement_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "NE01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_change_action_required", "type": null, "when": "[requirement_error] No linked uk.company_name.change action." }, { "code": "exemption_conditions_not_met", "type": null, "when": "[requirement_error] The objects or articles do not meet the conditions for guarantee_company_conditions." }, { "code": "charity_status_unconfirmed", "type": null, "when": "[requirement_error] exemption_basis is charity but the company is not on the charity register." }, { "code": "exemption_basis_unresolved", "type": null, "when": "[jurisdiction_error] Entiva routes the claim to manual review because the statutory basis for post-2009 claims was not fully resolved." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to give the entitlement confirmation." } ] } }, "Params_uk_llp_name_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the LLP is registered.", "examples": [ "scotland" ] }, "name": { "type": "string", "description": "Proposed LLP name with a permitted LLP ending.", "examples": [ "Thistle Row Advisory LLP" ] }, "members_decision_date": { "type": "string", "format": "date", "description": "Date the members agreed the change under the LLP agreement.", "examples": [ "2026-10-15" ] }, "members_decision_basis": { "type": "string", "description": "Clause of the LLP agreement under which the members decided, or 'default rules' if the agreement is silent.", "examples": [ "Clause 14.2 (majority of members)" ] }, "same_day_service": { "type": "boolean", "description": "True for same-day service.", "examples": [ "false" ] }, "sensitive_word_approval_documents": { "type": "array", "items": {}, "description": "doc_ ids of approval letters for sensitive words in the new name.", "examples": [ "[]" ] } }, "required": [ "registration_jurisdiction", "name", "members_decision_date" ], "description": "Changes the name of a limited liability partnership by notifying Companies House on LL NM01 after the members have agreed. LLPs file by software only; no online channel is listed." }, "Create_uk_llp_name_change": { "type": "object", "properties": { "type": { "const": "uk.llp_name.change" }, "params": { "$ref": "#/components/schemas/Params_uk_llp_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change an LLP's name", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_decision", "title": "Members' decision to change the LLP's name", "source": "generated", "required": true }, { "key": "llp_agreement_extract", "title": "LLP agreement clauses on decision-making", "source": "uploaded", "required": false }, { "key": "sensitive_word_approval", "title": "Approval or non-objection letter for sensitive words", "source": "uploaded", "required": false }, { "key": "ll_nm01_notice", "title": "LL NM01 notice of change of name of an LLP", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the notice", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_on_change_of_name", "title": "Certificate of incorporation on change of name", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "member", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_decision", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LL NM01", "channel": "online", "government_fee": { "amount": 20, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_same_as_existing", "type": null, "when": "[invalid_request_error] The name matches one on the registrar's index of names." }, { "code": "name_requires_approval", "type": null, "when": "[requirement_error] A sensitive word needs an approval document." }, { "code": "name_ending_invalid", "type": null, "when": "[invalid_request_error] The name does not end with a permitted LLP indicator." }, { "code": "members_approval_incomplete", "type": null, "when": "[requirement_error] Not every member whose approval the LLP agreement requires has signed." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the notice." } ] } }, "Params_uk_overseas_company_name_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the UK establishment is registered.", "examples": [ "england_wales" ] }, "overseas_company_number": { "type": "string", "description": "Companies House registration number of the overseas company.", "examples": [ "FC041234" ] }, "uk_establishment_numbers": { "type": "array", "items": {}, "description": "Registration numbers of every UK establishment affected.", "examples": [ "[\"BR019876\"]" ] }, "name_type": { "type": "string", "enum": [ "corporate_name", "alternative_name" ], "description": "Which name changes: the overseas company's corporate name, or the alternative name it uses for UK registration.", "examples": [ "corporate_name" ] }, "name": { "type": "string", "description": "The new name exactly as registered in the home register.", "examples": [ "Nordvik Maritime Holdings AS" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect in the home jurisdiction.", "examples": [ "2026-10-12" ] }, "home_registry_certificate_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the home-registry certificate of change of name.", "examples": [ "doc_2Pf6QxL9sNr" ] }, "authorised": { "type": "string", "pattern": "^per_", "description": "per_ id of the director, secretary or person authorised to represent the company who signs the notice.", "examples": [ "per_5Tc1HvM8bKa" ] } }, "required": [ "registration_jurisdiction", "overseas_company_number", "uk_establishment_numbers", "name_type", "name", "effective_date" ], "description": "Tells Companies House that an overseas company with a UK establishment has changed its corporate name or alternative name, on form OS NM01. Companies House lists only a paper channel and a £30 fee for this notice." }, "Create_uk_overseas_company_name_change": { "type": "object", "properties": { "type": { "const": "uk.overseas_company_name.change" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify a change of an overseas company's name", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "home_registry_certificate", "title": "Certificate of change of name from the home registry", "source": "uploaded", "required": true }, { "key": "board_resolution_overseas_company", "title": "Overseas company's board resolution approving the change of name", "source": "uploaded", "required": false }, { "key": "os_nm01_notice", "title": "OS NM01 notice of change of name", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House confirmation of the name change", "source": "registry_issued", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "os_nm01_notice", "signer_role": "authorised_representative", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS NM01", "channel": "paper", "government_fee": { "amount": 30, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "home_registry_evidence_missing", "type": null, "when": "[requirement_error] No certificate of change of name from the home registry." }, { "code": "establishment_not_found", "type": null, "when": "[invalid_request_error] An establishment number does not belong to the overseas company." }, { "code": "deadline_at_risk", "type": null, "when": "[requirement_error] Fewer than 5 days remain of the 21-day period; Entiva warns before posting." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House returned the paper form." } ] } }, "Params_uk_register_material_remove": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the company or LLP concerned is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type key of the company concerned.", "examples": [ "private_ltd_shares" ] }, "company_number": { "type": "string", "description": "Companies House number of the company or LLP whose register entry contains the material.", "examples": [ "11223344" ] }, "material": { "type": "array", "items": {}, "description": "Each item to remove: {form_code, filing_date, location_in_register, description}.", "examples": [ "[{\"form_code\":\"AP01\",\"filing_date\":\"2025-12-09\",\"location_in_register\":\"Filing history, page 2\",\"description\":\"Residential address\"}]" ] }, "s1094_ground": { "type": "string", "enum": [ "accepted_under_s1073_or_derived", "unnecessary_material" ], "description": "accepted_under_s1073_or_derived: the material is a document accepted despite not meeting delivery requirements, or derives from one. unnecessary_material.", "examples": [ "unnecessary_material" ] }, "grounds_explanation": { "type": "string", "description": "Why the material falls within the ground chosen.", "examples": [ "The address was not required by the form and was not needed to comply with any enactment." ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "per_ id of the applicant.", "examples": [ "per_8Rc4LtV1mHa" ] }, "applicant_connection": { "type": "string", "description": "Applicant's current or past connection to the company, or 'none'.", "examples": [ "Director named in the filing" ] }, "interest_representations": { "type": "string", "description": "Representations about the applicant's interest in removal.", "examples": [ "Residential address is protected personal data." ] }, "supporting_documents": { "type": "array", "items": {}, "description": "doc_ ids of written information the applicant wants the registrar to consider.", "examples": [ "[\"doc_5Tz8KfN3qWe\"]" ] } }, "required": [ "registration_jurisdiction", "company_number", "material", "s1094_ground", "grounds_explanation", "applicant", "applicant_connection" ], "description": "Applies to the registrar under s1094 CA 2006 and the Registrar Regulations 2024 to remove a document, or information in a document, that was not properly delivered or is unnecessary. Any person can apply; the registrar may give notice and." }, "Create_uk_register_material_remove": { "type": "object", "properties": { "type": { "const": "uk.register_material.remove" }, "params": { "$ref": "#/components/schemas/Params_uk_register_material_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to remove material from the public register", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "removal_application", "title": "RP08 application to remove material from the register", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Supporting information the applicant relies on", "source": "uploaded", "required": false }, { "key": "registrar_notice_of_intention", "title": "Registrar's notice of intention to remove and objection deadline", "source": "registry_issued", "required": false }, { "key": "registrar_outcome_notice", "title": "Registrar's notice of the outcome of the application", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "removal_application", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RP08", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "use_rp07_for_registered_office", "type": null, "when": "[invalid_request_error] The application is about a registered office address." }, { "code": "material_not_identified", "type": null, "when": "[invalid_request_error] The material or its location in the register is not specified." }, { "code": "pre_2006_act_material", "type": null, "when": "[requirement_error] The material was delivered under the Companies Act 1985 or an earlier Act; RP08 does not cover it." }, { "code": "application_rejected", "type": null, "when": "[registry_error] The registrar rejected the application." }, { "code": "objection_received", "type": null, "when": "[registry_error] A person objected during the objection period; the registrar weighs it before deciding." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the applicant's declaration." } ] } }, "Params_uk_registered_office_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the entity is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "address": { "$ref": "#/components/schemas/Address", "description": "New registered office address.", "examples": [ "{\"line1\":\"Unit 4, 25 Bute Street\",\"locality\":\"Cardiff\",\"postal_code\":\"CF10 5LJ\",\"country\":\"GB\"}" ] }, "use_entiva_registered_office": { "type": "boolean", "description": "True to use Entiva's registered office service address for registration_jurisdiction instead of new_address.", "examples": [ "false" ] }, "appropriate_address_confirmation": { "type": "boolean", "description": "Confirms the new address is an appropriate address under CA 2006 s86: a document addressed to the company and delivered there by hand or post would be expected.", "examples": [ "true" ] }, "records_change_date": { "type": "string", "format": "date", "description": "Date from which the company applies the new address to registers kept at the registered office and to documents that must show the address.", "examples": [ "2026-10-31" ] }, "register_of_members_location": { "type": "string", "enum": [ "new_registered_office", "existing_sail_unchanged" ], "description": "Where the register of members is kept after the move.", "examples": [ "new_registered_office" ] }, "board_decision_date": { "type": "string", "format": "date", "description": "Date of the directors' decision, if already taken.", "examples": [ "2026-10-17" ] }, "occupier_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of evidence that the company can receive and acknowledge post at the new address.", "examples": [ "doc_4Rt8NpE2kVu" ] } }, "required": [ "registration_jurisdiction", "address", "appropriate_address_confirmation" ], "description": "Moves a company's or LLP's registered office to a new appropriate address in the same part of the UK by notice to Companies House. The change takes effect when the registrar registers the notice, and for 14 days afterwards documents can." }, "Create_uk_registered_office_change": { "type": "object", "properties": { "type": { "const": "uk.registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered office address", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' decision to change the registered office address", "source": "generated", "required": true }, { "key": "occupier_consent", "title": "Evidence the company can receive and acknowledge post at the new address", "source": "uploaded", "required": false }, { "key": "ad01_notice", "title": "AD01 / LL AD01 notice of change of registered office address", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the notice", "source": "generated", "required": true }, { "key": "api_filing_consent", "title": "Companies House API Filing OAuth consent", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House confirmation and updated company profile", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ad01_notice", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "api_filing_consent", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AD01", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_outside_registration_jurisdiction", "type": null, "when": "[jurisdiction_error] The new address is not in the part of the UK where the entity is registered." }, { "code": "welsh_company_must_stay_in_wales", "type": null, "when": "[jurisdiction_error] The entity is a Welsh company and the new address is in England." }, { "code": "address_not_appropriate", "type": null, "when": "[requirement_error] The address cannot receive and acknowledge hand or post delivery (s86), for example a mail drop without proof of delivery." }, { "code": "registry_consent_missing", "type": null, "when": "[requirement_error] No valid Companies House API Filing consent for the registered-office scope; a signature requirement is raised." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the notice, for example because the company number or authentication does not match." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to give the s86 confirmation or the One Login consent itself." } ] } }, "Params_uk_registered_office_situation_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "description": "Must be england_wales.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "current_situation": { "type": "string", "enum": [ "england_and_wales", "wales" ], "description": "How the register entry now states the registered office situation.", "examples": [ "england_and_wales" ] }, "situation": { "type": "string", "enum": [ "england_and_wales", "wales" ], "description": "The situation to register.", "examples": [ "wales" ] }, "registered_office_in_wales_confirmation": { "type": "boolean", "description": "Confirms that the registered office address is in Wales, as s88 and require for either direction of change.", "examples": [ "true" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed.", "examples": [ "2026-10-13" ] }, "use_welsh_forms": { "type": "boolean", "description": "True to prepare bilingual or Welsh-language forms for a Welsh company.", "examples": [ "false" ] } }, "required": [ "registration_jurisdiction", "current_situation", "situation", "registered_office_in_wales_confirmation", "resolution_date" ], "description": "Switches a company between being registered as situated in 'England and Wales' and being a 'Welsh company' situated in Wales, by special resolution and notice on AD05. Companies House then amends the register and issues a new certificate." }, "Create_uk_registered_office_situation_change": { "type": "object", "properties": { "type": { "const": "uk.registered_office_situation.change" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_office_situation_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the situation of the registered office between England and Wales and Wales", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution recommending the change of situation", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Members' special resolution changing the registered office situation", "source": "generated", "required": true }, { "key": "ad05_notice", "title": "AD05 notice to change the situation of the registered office", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Authentication of the AD05", "source": "generated", "required": true }, { "key": "amended_certificate_of_incorporation", "title": "New certificate of incorporation reflecting the change", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "AD05", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registered_office_not_in_wales", "type": null, "when": "[jurisdiction_error] The registered office address is not in Wales, so the situation cannot be changed." }, { "code": "situation_unchanged", "type": null, "when": "[invalid_request_error] new_situation equals current_situation." }, { "code": "resolution_threshold_not_met", "type": null, "when": "[requirement_error] Signed votes do not reach 75%." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the AD05." } ] } }, "Params_uk_registered_society_name_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Part of the UK where the society is registered.", "examples": [ "scotland" ] }, "society_registration_number": { "type": "string", "description": "FCA Mutuals Public Register number of the society.", "examples": [ "SP2468R" ] }, "name": { "type": "string", "description": "Proposed name.", "examples": [ "Glen Row Community Energy Society Limited" ] }, "general_meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting that passed the name-change resolution.", "examples": [ "2026-10-06" ] }, "notice_basis": { "type": "string", "enum": [ "rules_name_change_notice", "rules_amendment_notice" ], "description": "Which notice was given: the notice the rules require for a name-change resolution, or, if the rules do not cover it, the notice required for a resolution to.", "examples": [ "rules_name_change_notice" ] }, "notice_given_date": { "type": "string", "format": "date", "description": "Date the notice of the meeting was given.", "examples": [ "2026-09-15" ] }, "trademark_check_acknowledged": { "type": "boolean", "description": "Customer acknowledges trade mark protection is separate and has been checked.", "examples": [ "true" ] } }, "required": [ "registration_jurisdiction", "society_registration_number", "name", "general_meeting_date", "notice_basis", "notice_given_date" ], "description": "Changes the name of a co-operative or community benefit society by a resolution at a general meeting with the notice the rules require, followed by the FCA's written approval and registration. A name change takes effect only once the FCA." }, "Create_uk_registered_society_name_change": { "type": "object", "properties": { "type": { "const": "uk.registered_society_name.change" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a registered society's name", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_meeting_notice", "title": "Notice of the general meeting with the name-change resolution", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Resolution of the general meeting changing the name", "source": "generated", "required": true }, { "key": "fca_change_of_name_form", "title": "FCA change of name submission", "source": "generated", "required": true }, { "key": "fca_written_approval", "title": "FCA written approval and registration of the name", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fca_change_of_name_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority", "form": "Change of name", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "meeting_notice_insufficient", "type": null, "when": "[requirement_error] The notice given does not meet what the rules require for the resolution." }, { "code": "restricted_word_in_name", "type": null, "when": "[requirement_error] The name contains a restricted word and the FCA's view is needed." }, { "code": "jurisdiction_not_supported", "type": null, "when": "[jurisdiction_error] Registered societies in Northern Ireland are not supported." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the FCA form." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The FCA refused approval of the name." } ] } }, "Params_uk_registered_society_office_change": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Part of the UK where the society is registered.", "examples": [ "england_wales" ] }, "society_registration_number": { "type": "string", "description": "FCA Mutuals Public Register number of the society.", "examples": [ "IP34567R" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office address.", "examples": [ "{\"line1\":\"Unit 2, Wharf Road\",\"locality\":\"Bristol\",\"postal_code\":\"BS1 4RT\",\"country\":\"GB\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the society uses the new address.", "examples": [ "2026-11-01" ] }, "decision_date": { "type": "string", "format": "date", "description": "Date of the decision under the rules to change the registered office.", "examples": [ "2026-10-09" ] }, "decision_basis": { "type": "string", "enum": [ "committee_decision_under_rules", "members_resolution_amending_rule" ], "description": "How the society's rules authorise the change: a committee decision, or a members' resolution amending a rule that states the place of the registered office.", "examples": [ "committee_decision_under_rules" ] } }, "required": [ "registration_jurisdiction", "society_registration_number", "registered_office", "decision_date", "decision_basis" ], "description": "Notifies the FCA of a new registered office for a co-operative or community benefit society. The FCA registers the change as an amendment to the rules, and the society must keep a registered office in the UK." }, "Create_uk_registered_society_office_change": { "type": "object", "properties": { "type": { "const": "uk.registered_society_office.change" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a registered society's registered office", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registered_office_decision", "title": "Committee decision or members' resolution changing the registered office", "source": "generated", "required": true }, { "key": "fca_change_of_registered_office_form", "title": "FCA change of registered office submission", "source": "generated", "required": true }, { "key": "fca_registration_acknowledgement", "title": "FCA registration of the change as an amendment to the rules", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "registered_office_decision", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fca_change_of_registered_office_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority", "form": "Change of registered office", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "address_not_in_uk", "type": null, "when": "[jurisdiction_error] The new registered office is not in the UK." }, { "code": "decision_basis_invalid", "type": null, "when": "[requirement_error] The chosen decision basis does not match the society's rules." }, { "code": "jurisdiction_not_supported", "type": null, "when": "[jurisdiction_error] Registered societies in Northern Ireland are not supported." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the FCA form." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The FCA refused to register the change." } ] } }, "Params_uk_registered_society_rules_amend": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Part of the UK where the society is registered.", "examples": [ "england_wales" ] }, "society_registration_number": { "type": "string", "description": "FCA Mutuals Public Register number of the society.", "examples": [ "IP34567R" ] }, "society_type": { "type": "string", "enum": [ "co_operative", "community_benefit" ], "description": "Co-operative society or community benefit society under the Co-operative and Community Benefit Societies Act 2014.", "examples": [ "community_benefit" ] }, "amendment_scope": { "type": "string", "enum": [ "complete", "partial" ], "description": "complete: replaces the whole rulebook. partial: changes named rules.", "examples": [ "partial" ] }, "rule_changes": { "type": "array", "items": {}, "description": "Each change as {rule, summary}.", "examples": [ "[{\"rule\":\"Rule 22\",\"summary\":\"Reduce the notice for general meetings from 21 to 14 days\"}]" ] }, "rules_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the complete new rules or the amendment text if the customer supplies it.", "examples": [ "doc_9Hs5NmV2bTe" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members resolved to amend the rules under the society's rules.", "examples": [ "2026-10-07" ] }, "secretary": { "type": "string", "pattern": "^per_", "description": "per_ id of the society's secretary, who signs the amendment.", "examples": [ "per_3Ym6TqD9nKa" ] }, "all_members_are_societies": { "type": "boolean", "description": "True if every member is itself a registered society.", "examples": [ "false" ] }, "signing_members": { "type": "array", "items": {}, "description": "per_ ids of the three signing members.", "examples": [ "[\"per_8Vc2BxH5wLe\",\"per_1Zp4RsM7cJa\",\"per_6Nk9FtQ3dYe\"]" ] } }, "required": [ "registration_jurisdiction", "society_registration_number", "society_type", "amendment_scope", "rule_changes", "resolution_date", "secretary", "all_members_are_societies" ], "description": "Amends the rules of a co-operative or community benefit society and registers the amendment with the FCA through the Mutuals Society Portal. The amendment is not valid until the FCA registers it, and the FCA must register it if it is not." }, "Create_uk_registered_society_rules_amend": { "type": "object", "properties": { "type": { "const": "uk.registered_society_rules.amend" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_rules_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a registered society's rules", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' resolution amending the rules", "source": "generated", "required": true }, { "key": "amendment_to_rules", "title": "Amendment to rules", "source": "generated", "required": true }, { "key": "fca_portal_submission", "title": "FCA complete or partial amendment to rules submission", "source": "generated", "required": true }, { "key": "fca_registration_acknowledgement", "title": "FCA registration of the amendment and sealed acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "amendment_to_rules", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority", "form": "Complete amendment to rules or Partial amendment to rules", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "rules_contrary_to_act", "type": null, "when": "[requirement_error] The amendment appears contrary to the 2014 Act, so the FCA is unlikely to register it." }, { "code": "signatory_requirements_not_met", "type": null, "when": "[requirement_error] The secretary plus three members have not all signed." }, { "code": "jurisdiction_not_supported", "type": null, "when": "[jurisdiction_error] Registered societies in Northern Ireland are not supported." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the amendment." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The FCA refused to register the amendment." } ] } }, "Params_uk_replacement_document_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the entity is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "original_document": { "type": "object", "description": "The filing being replaced: {form_code, filing_date, transaction_id}.", "examples": [ "{\"form_code\":\"PSC01\",\"filing_date\":\"2026-08-04\",\"transaction_id\":\"MzQ0ODkxMjAwMWFkaXF6a2N4\"}" ] }, "replacement_reason": { "type": "string", "enum": [ "incorrect_information", "improper_delivery", "unnecessary_material" ], "description": "incorrect_information: some or all of the information is wrong. improper_delivery: the original did not meet the requirements for proper delivery..", "examples": [ "incorrect_information" ] }, "replacement_form_data": { "type": "object", "description": "The full corrected data for the original form.", "examples": [ "{\"date_of_birth\":{\"month\":6,\"year\":1984}}" ] }, "original_filed_by": { "type": "string", "enum": [ "entiva", "company", "other_agent", "officer_or_psc" ], "description": "Who delivered the original. s1076 lets the replacement be delivered only by the person who delivered the original, or by the company it relates to.", "examples": [ "entiva" ] }, "confirm_matching_details": { "type": "boolean", "description": "Confirms company name, company number and dates in the replacement match the register.", "examples": [ "true" ] }, "proof_pr03_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the PR03 consent.", "examples": [ "doc_9Qd3NfL7wTc" ] }, "affected": { "type": "string", "pattern": "^per_", "description": "per_ id of the individual whose particulars are corrected.", "examples": [ "per_6Ye2JmS4bKa" ] } }, "required": [ "registration_jurisdiction", "original_document", "replacement_reason", "replacement_form_data", "original_filed_by", "confirm_matching_details" ], "description": "Replaces a previously filed document whose information was wrong or which did not meet the requirements for proper delivery, by delivering a corrected version of the original form with RP01. It can only replace documents filed on or after." }, "Create_uk_replacement_document_file": { "type": "object", "properties": { "type": { "const": "uk.replacement_document.file" }, "params": { "$ref": "#/components/schemas/Params_uk_replacement_document_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Replace a document on the Companies House register", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "original_document_copy", "title": "Copy of the original document from the register", "source": "registry_issued", "required": true }, { "key": "replacement_form", "title": "Replacement of the original form with corrected data", "source": "generated", "required": true }, { "key": "rp01_form", "title": "RP01 replacement document cover form", "source": "generated", "required": true }, { "key": "proof_pr03_consent", "title": "PR03 consent for PROOF-protected paper forms", "source": "uploaded", "required": false }, { "key": "corrected_content_confirmation", "title": "Confirmation by a director that the replacement is accurate", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the filing", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acceptance of the replacement", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "corrected_content_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RP01 with a replacement of the original form", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "original_before_2009", "type": null, "when": "[requirement_error] The original was filed before 1 Oct 2009 and cannot be replaced." }, { "code": "wrong_deliverer", "type": null, "when": "[requirement_error] The replacement would not be delivered by the original deliverer or the company." }, { "code": "charge_document_not_replaceable", "type": null, "when": "[invalid_request_error] Documents delivered under Part 25 are corrected by rectification under s859M, not RP01." }, { "code": "details_do_not_match_register", "type": null, "when": "[requirement_error] Company name, number or dates differ from the register." }, { "code": "proof_consent_missing", "type": null, "when": "[requirement_error] The company is PROOF-protected and a PR03 consent is needed for a paper form." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the replacement." } ] } }, "Params_uk_scio_constitution_amend": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Must be scotland.", "examples": [ "scotland" ] }, "scio_number": { "type": "string", "description": "OSCR charity number of the SCIO.", "examples": [ "SC051234" ] }, "affects_purposes": { "type": "boolean", "description": "True if the amendment changes the purposes.", "examples": [ "false" ] }, "affects_name": { "type": "boolean", "description": "True if the amendment changes the SCIO's name.", "examples": [ "false" ] }, "oscr_consent_reference": { "type": "string", "description": "OSCR's consent reference.", "examples": [ "OSCR-CONSENT-2026-1187" ] }, "oscr_consent_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of OSCR's consent letter.", "examples": [ "doc_8Rk4VnS2cLe" ] }, "voting_mode": { "type": "string", "enum": [ "general_meeting_two_thirds", "unanimous_outside_meeting" ], "description": "general_meeting_two_thirds: two-thirds majority of those voting at a general meeting, including proxy and postal votes where permitted..", "examples": [ "general_meeting_two_thirds" ] }, "resolution_date": { "type": "string", "format": "date", "description": "The general meeting date, or for a resolution passed otherwise, the date the last member agreed (s63).", "examples": [ "2026-10-08" ] }, "sections_changed": { "type": "array", "items": {}, "description": "Constitution sections changed.", "examples": [ "[\"Clause 12 (quorum)\",\"Clause 14 (notice of meetings)\"]" ] }, "amended_constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the complete revised constitution if the customer supplies it.", "examples": [ "doc_5Gp9TmQ3bXa" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the amendment applies.", "examples": [ "2026-10-08" ] } }, "required": [ "registration_jurisdiction", "scio_number", "affects_purposes", "affects_name", "voting_mode", "resolution_date", "sections_changed" ], "description": "Amends the constitution of a Scottish charitable incorporated organisation by members' resolution under s63 of the 2005 Act, after OSCR consent where the change affects purposes or the name, then notifies OSCR within three months." }, "Create_uk_scio_constitution_amend": { "type": "object", "properties": { "type": { "const": "uk.scio_constitution.amend" }, "params": { "$ref": "#/components/schemas/Params_uk_scio_constitution_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a SCIO's constitution", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "scio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustees_resolution", "title": "Trustees' decision to propose the amendment and approve the OSCR submission", "source": "generated", "required": true }, { "key": "oscr_consent", "title": "OSCR consent to the change of purposes or name", "source": "registry_issued", "required": false }, { "key": "members_resolution", "title": "Members' resolution amending the constitution", "source": "generated", "required": true }, { "key": "amended_constitution", "title": "Revised constitution", "source": "generated", "required": true }, { "key": "oscr_notification_form", "title": "OSCR 'Notification of changes made to your charity' submission", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "OSCR acknowledgement and register update", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting" } ], "signatures": [ { "document_key": "trustees_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "oscr_notification_form", "signer_role": "trustee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "OSCR", "form": "Consent application for purposes or name changes", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "oscr_consent_required", "type": null, "when": "[requirement_error] The change affects purposes or the name and no OSCR consent is recorded." }, { "code": "majority_not_met", "type": null, "when": "[requirement_error] Fewer than two-thirds of votes cast, or not every member agreed outside a meeting." }, { "code": "notification_overdue", "type": null, "when": "[requirement_error] More than three months have passed since the change; OSCR notification is late." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried to sign the trustee declaration." } ] } }, "Params_uk_second_filing_file": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the entity is registered.", "examples": [ "england_wales" ] }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type key.", "examples": [ "private_ltd_shares" ] }, "original_document": { "type": "object", "description": "Identifies the filing being corrected: {form_code, filing_date, transaction_id}.", "examples": [ "{\"form_code\":\"AP01\",\"filing_date\":\"2026-09-22\",\"transaction_id\":\"MzQ1MjA2NzE4OGFkaXF6a2N4\"}" ] }, "error_nature": { "type": "string", "enum": [ "typographical", "other_minor", "date_of_birth", "material_or_substantive" ], "description": "typographical or other_minor can use RP04. date_of_birth and material_or_substantive must use uk.replacement_document.file, per Companies House guidance.", "examples": [ "typographical" ] }, "error_description": { "type": "string", "description": "What is wrong in the original document.", "examples": [ "Director's service address shows 'Cheapside Lane' instead of 'Cheapside Lane East'." ] }, "corrected_values": { "type": "object", "description": "Map of field name to the correct value.", "examples": [ "{\"service_address.line1\":\"14 Cheapside Lane East\"}" ] }, "affected": { "type": "string", "pattern": "^per_", "description": "per_ id of the individual whose particulars are corrected, if any.", "examples": [ "per_3Gd8KtW2nLa" ] }, "confirm_original_properly_delivered": { "type": "boolean", "description": "Confirms the original was accepted and only a minor error remains.", "examples": [ "true" ] } }, "required": [ "registration_jurisdiction", "original_document", "error_nature", "error_description", "corrected_values", "confirm_original_properly_delivered" ], "description": "Corrects a minor error in a document that Companies House already accepted as properly delivered, by delivering the document again on RP04. Companies House guidance limits this to very limited cases, such as a typo in a service address." }, "Create_uk_second_filing_file": { "type": "object", "properties": { "type": { "const": "uk.second_filing.file" }, "params": { "$ref": "#/components/schemas/Params_uk_second_filing_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a second filing of a document previously delivered", "x-entiva": { "jurisdiction": "uk", "stage": "changes", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "original_document_copy", "title": "Copy of the original document from the register", "source": "registry_issued", "required": true }, { "key": "rp04_form", "title": "RP04 second filing form with the corrected document", "source": "generated", "required": true }, { "key": "corrected_content_confirmation", "title": "Confirmation by a director that the corrected content is accurate", "source": "generated", "required": true }, { "key": "companies_house_filing_authentication", "title": "Companies House authentication of the filing", "source": "generated", "required": true }, { "key": "registry_confirmation", "title": "Companies House acceptance of the second filing", "source": "registry_issued", "required": true } ], "people": [ { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "corrected_content_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "companies_house_filing_authentication", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RP04", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_replacement_document_action", "type": null, "when": "[invalid_request_error] The error is a date of birth or material." }, { "code": "original_document_not_found", "type": null, "when": "[invalid_request_error] The transaction cannot be matched to a filing on the register." }, { "code": "original_not_properly_delivered", "type": null, "when": "[requirement_error] The original was not accepted as properly delivered; RP04 does not apply." }, { "code": "director_confirmation_missing", "type": null, "when": "[requirement_error] No director has confirmed the corrected content." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] Companies House rejected the second filing." } ] } }, "Params_uk_administration_appoint": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Taken from the entity. northern_ireland is scoped by an NI-licensed practitioner; statutory references are for Great Britain." }, "appointment_route": { "type": "string", "enum": [ "directors_or_company", "qualifying_floating_charge_holder", "court_application" ], "description": "Directors or company, qualifying floating charge holder, or court." }, "statutory_purpose": { "type": "string", "enum": [ "rescue_as_going_concern", "better_result_than_winding_up", "realise_property_for_secured_or_preferential_creditors" ], "description": "Objective (para 3); rescue is the default (para 3)." }, "insolvency_basis": { "type": "string", "enum": [ "unable_to_pay_debts", "likely_to_become_unable" ], "description": "Unable, or likely to become unable, to pay debts (paras 11, 27)." }, "qualifying_floating_charge": { "type": "object", "description": "QFCH route: {holder_entity_id, charge_reference, created_on, enforceable}." }, "prior_chargeholders_handled": { "type": "boolean", "description": "Prior chargeholders consented or got notice: 2 business days or 5." }, "winding_up_petition_outstanding": { "type": "boolean", "description": "Bars out-of-court appointment, subject to para 25A." }, "administration_ended_within_12_months": { "type": "boolean", "description": "Bars a directors' appointment." }, "administrative_receiver_in_office": { "type": "boolean", "description": "Bars out-of-court appointment." } }, "required": [ "appointment_route", "statutory_purpose", "insolvency_basis", "prior_chargeholders_handled", "winding_up_petition_outstanding", "administration_ended_within_12_months", "administrative_receiver_in_office" ], "description": "Appoints a licensed insolvency practitioner as administrator by the directors or company, a qualifying floating charge holder, or the court. A moratorium protects the company." }, "Create_uk_administration_appoint": { "type": "object", "properties": { "type": { "const": "uk.administration.appoint" }, "params": { "$ref": "#/components/schemas/Params_uk_administration_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an administrator", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true }, { "key": "directors_declaration", "title": "Directors' declaration of insolvency and eligibility (paras 27, 29)", "source": "generated", "required": false }, { "key": "notice_of_intention", "title": "Notice of intention to appoint, filed at court", "source": "generated", "required": false }, { "key": "chargeholder_notice_or_consent", "title": "Prior chargeholder notice or consent", "source": "uploaded", "required": false }, { "key": "notice_of_appointment", "title": "Notice of appointment with administrator's statement", "source": "generated", "required": true }, { "key": "creditors_list", "title": "Creditors' list (para 46)", "source": "uploaded", "required": true }, { "key": "notice_am01", "title": "AM01 notice to Companies House", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of appointment", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "creditors", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_declaration", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "chargeholder_notice_or_consent", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_appointment", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "The court", "form": "Notice of intention and notice of appointment", "channel": "both", "government_fee": { "amount": 58, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "company_not_insolvent", "type": null, "when": "Insolvency basis not made out (paras 11, 27)." }, { "code": "winding_up_petition_pending", "type": null, "when": "Petition outstanding." }, { "code": "repeat_appointment_within_12_months", "type": null, "when": "Barred within 12 months." }, { "code": "administrative_receiver_in_office", "type": null, "when": "Receiver in office." } ] } }, "Params_uk_charity_convert_to_cio": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "charitable_company", "registered_society" ], "description": "Body converting." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "description": "Scotland uses uk.charity.convert_to_scio; Northern Ireland is unsupported." }, "registry_number": { "type": "string", "description": "Companies House number or FCA number." }, "charity_number": { "type": "string", "description": "Registered charity number." }, "proposed_cio_name": { "type": "string", "description": "Must not include 'limited'; the Commission refuses confusing or offensive names." }, "constitution_model": { "type": "string", "enum": [ "association", "foundation", "other_commission_approved" ], "description": "Association or foundation model." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Proposed CIO constitution; stay near the model and explain changes." }, "purposes_changed": { "type": "boolean", "description": "True if purposes differ from today's; change needs Commission authority first." }, "commission_authority_reference": { "type": "string", "description": "Required if purposes changed or clauses are reconciled with Commission authority." }, "liability": { "type": "object", "description": "{type: guarantee|shares, current_guarantee: money, cio_liability: money, shares_fully_paid: boolean}." }, "conversion_resolution": { "type": "object", "description": "{type: special_resolution | unanimous_written_resolution, passed_date, first_meeting_date, second_meeting_date}." }, "constitution_resolution_date": { "type": "string", "format": "date", "description": "Date members adopted the CIO constitution." }, "trustees": { "type": "array", "items": {}, "description": "Array of person_ref: every charity trustee; each signs a Trustee Declaration Form." }, "secretary": { "type": "string", "pattern": "^per_", "description": "Society secretary; countersigns the special resolution." }, "social_housing": { "type": "object", "description": "{is_provider: boolean, rsh_notified_date}." }, "filings_up_to_date": { "type": "boolean", "description": "Confirms Companies House or FCA and Commission filings are not overdue." } }, "required": [ "entity_type", "registration_jurisdiction", "registry_number", "charity_number", "proposed_cio_name", "constitution_model", "constitution_document_id", "purposes_changed", "liability", "conversion_resolution", "constitution_resolution_date", "trustees", "social_housing", "filings_up_to_date" ], "description": "Converts a registered charitable company, or charitable co-operative or community benefit society, into a charitable incorporated organisation under Charities Act 2011 ss228-233. Members pass a conversion resolution and one adopting the." }, "Create_uk_charity_convert_to_cio": { "type": "object", "properties": { "type": { "const": "uk.charity.convert_to_cio" }, "params": { "$ref": "#/components/schemas/Params_uk_charity_convert_to_cio" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a charitable company or registered society into a CIO", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "charitable_company", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Trustees' resolution to convert and adopt the constitution", "source": "generated", "required": true }, { "key": "conversion_resolution", "title": "Members' conversion resolution", "source": "generated", "required": true }, { "key": "constitution_adoption_resolution", "title": "Members' resolution adopting the CIO constitution", "source": "generated", "required": true }, { "key": "proposed_cio_constitution", "title": "Proposed CIO constitution", "source": "uploaded", "required": true }, { "key": "trustee_declaration_forms", "title": "Trustee Declaration Forms, wet-ink signed, one per trustee", "source": "uploaded", "required": true }, { "key": "fca_statutory_declaration", "title": "Society's statutory declaration that its resolutions were valid", "source": "uploaded", "required": false }, { "key": "rsh_notification_statement", "title": "Statement that the Regulator of Social Housing was notified", "source": "uploaded", "required": false }, { "key": "charity_register_entry", "title": "Register of charities entry showing CIO status and conversion date", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "conversion_resolution", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "constitution_adoption_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "trustee_declaration_forms", "signer_role": "trustee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "fca_statutory_declaration", "signer_role": "officer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "Commission online application to convert a charitable company to a CIO", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_registered_charity", "type": null, "when": "requirement_error: not a registered charity, or an exempt charity." }, { "code": "filings_overdue", "type": null, "when": "requirement_error: accounts or returns overdue at the registrar or Commission." }, { "code": "shares_not_fully_paid", "type": null, "when": "requirement_error: partly paid shares (s228, s229)." }, { "code": "name_contains_limited", "type": null, "when": "invalid_request_error: proposed_cio_name includes 'limited'." }, { "code": "registration_jurisdiction_unsupported", "type": null, "when": "jurisdiction_error: scotland or northern_ireland." } ] } }, "Params_uk_charity_convert_to_scio": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "charitable_company", "registered_society" ], "description": "Only a charity that is a company or registered society can convert (s56)." }, "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Must be scotland." }, "oscr_charity_number": { "type": "string", "description": "Scottish Charity Register number." }, "registry_number": { "type": "string", "description": "Companies House number or FCA number; both resolutions must state it." }, "proposed_scio_name": { "type": "string", "description": "OSCR must refuse a name within s10 of the 2005 Act." }, "scio_principal_office": { "$ref": "#/components/schemas/Address", "description": "Proposed principal office (s54)." }, "scio_constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Proposed SCIO constitution; must meet s50." }, "member_count": { "type": "integer", "description": "A company needs more than one member (s56)." }, "shares_fully_paid": { "type": "boolean", "description": "With share capital, every share must be fully paid (s56)." }, "conversion_resolution": { "type": "object", "description": "{type: special_resolution | unanimous_written_resolution, passed_date, first_meeting_date, second_meeting_date}." }, "constitution_resolution_date": { "type": "string", "format": "date", "description": "Date members adopted the SCIO constitution." }, "resolutions_state_identifiers": { "type": "boolean", "description": "Both resolutions state name, charity number and company or FCA number." }, "trustees": { "type": "array", "items": {}, "description": "Array of person_ref; OSCR checks disqualification." }, "secretary": { "type": "string", "pattern": "^per_", "description": "Society secretary." }, "charity_test_confirmation": { "type": "boolean", "description": "Trustees confirm the SCIO would still meet the charity test (s57)." }, "filings_up_to_date": { "type": "boolean", "description": "Accounts and returns not overdue at the registrar or OSCR." } }, "required": [ "entity_type", "registration_jurisdiction", "oscr_charity_number", "registry_number", "proposed_scio_name", "scio_principal_office", "scio_constitution_document_id", "member_count", "conversion_resolution", "constitution_resolution_date", "resolutions_state_identifiers", "trustees", "charity_test_confirmation", "filings_up_to_date" ], "description": "Converts a Scottish charity that is a company or registered society into a SCIO under the Charities and Trustee Investment Act 2005 ss56-58. Members pass a conversion resolution and one adopting the SCIO constitution, and Entiva sends." }, "Create_uk_charity_convert_to_scio": { "type": "object", "properties": { "type": { "const": "uk.charity.convert_to_scio" }, "params": { "$ref": "#/components/schemas/Params_uk_charity_convert_to_scio" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a charitable company or registered society into a SCIO", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "charitable_company", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Trustees' decision to convert", "source": "generated", "required": true }, { "key": "conversion_resolution", "title": "Members' resolution to convert into a SCIO", "source": "generated", "required": true }, { "key": "constitution_adoption_resolution", "title": "Members' resolution adopting the SCIO constitution", "source": "generated", "required": true }, { "key": "proposed_scio_constitution", "title": "Proposed SCIO constitution", "source": "uploaded", "required": true }, { "key": "scio_application_for_conversion", "title": "OSCR Application for Conversion with the new-SCIO application documents", "source": "generated", "required": true }, { "key": "fca_statutory_declaration", "title": "Society's statutory declaration that its resolutions were valid", "source": "uploaded", "required": false }, { "key": "oscr_register_entry", "title": "Scottish Charity Register entry showing SCIO status", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "conversion_resolution", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "constitution_adoption_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "scio_application_for_conversion", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fca_statutory_declaration", "signer_role": "officer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Scottish Charity Regulator", "form": "OSCR 'Application for Conversion' form with the new-SCIO documents and both resolutions", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "single_member_company", "type": null, "when": "requirement_error: a company with one member cannot convert (s56)." }, { "code": "shares_not_fully_paid", "type": null, "when": "requirement_error: partly paid shares (s56)." }, { "code": "resolutions_missing_identifiers", "type": null, "when": "requirement_error: a resolution omits the name, charity number or registry number." }, { "code": "trustee_disqualified", "type": null, "when": "requirement_error: a proposed trustee is disqualified." }, { "code": "oscr_refused", "type": null, "when": "registry_error: refused (s57-); the error carries the reasons." } ] } }, "Params_uk_cic_convert_to_charitable_company": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Decides the statement needed: Charity Commission, OSCR statement in principle or HMRC Part 11 CTA 2010 exemption statement." }, "cic_number": { "type": "string", "description": "Companies House number." }, "liability_type": { "type": "string", "enum": [ "guarantee", "shares" ], "description": "A CIC limited by shares cannot become a charitable company limited by guarantee, or the reverse." }, "name": { "type": "string", "description": "New name with no CIC designation." }, "amended_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Articles as proposed to be amended, with exclusively charitable purposes (s54C)." }, "charity_regulator_statement_document_id": { "type": "string", "pattern": "^doc_", "description": "The s54C statement for the jurisdiction." }, "uses_limited_exemption": { "type": "boolean", "description": "True if the new name omits 'limited' or 'cyfyngedig': Form NE01 is then filed." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolutions passed." }, "court_challenge": { "type": "object", "description": "{holders_reach_15_percent: boolean, application_made: boolean, court_order_document_id}." }, "authorised_director": { "type": "string", "pattern": "^per_", "description": "Director who confirms the application and NE01." } }, "required": [ "registration_jurisdiction", "cic_number", "liability_type", "name", "amended_articles_document_id", "charity_regulator_statement_document_id", "uses_limited_exemption", "special_resolution_date", "court_challenge", "authorised_director" ], "description": "Ends a CIC's CIC status and makes it an ordinary charitable company under the Companies Act 2004 ss53-55A. Members pass special resolutions to cease being a CIC, amend the articles and change the name; a charity-regulator statement is." }, "Create_uk_cic_convert_to_charitable_company": { "type": "object", "properties": { "type": { "const": "uk.cic.convert_to_charitable_company" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_convert_to_charitable_company" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a CIC into a charitable company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolutions", "title": "Special resolutions to cease being a CIC, amend the articles and change the name", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as proposed to be amended", "source": "uploaded", "required": true }, { "key": "charity_regulator_statement", "title": "Commission, OSCR or HMRC statement under s54C", "source": "uploaded", "required": true }, { "key": "s54c_application", "title": "Application to the registrar under s54C", "source": "generated", "required": true }, { "key": "ne01_exemption_notice", "title": "Form NE01, exemption from 'limited'", "source": "generated", "required": false }, { "key": "new_certificate_of_incorporation", "title": "New certificate stating it is issued because the company is ceasing to be a CIC", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "special_resolutions", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s54c_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ne01_exemption_notice", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies, then the Regulator of CICs", "form": "s54C application with the special resolutions, amended articles and charity statement", "channel": "paper", "government_fee": { "amount": 30, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liability_type_not_convertible", "type": null, "when": "invalid_request_error: shares-to-guarantee conversion is barred." }, { "code": "s54a_window_open", "type": null, "when": "requirement_error: the 28-day court-application period has not ended." }, { "code": "charity_statement_missing", "type": null, "when": "requirement_error: the s54C statement is missing." }, { "code": "cic_designation_retained", "type": null, "when": "invalid_request_error: proposed_name still complies with s33." }, { "code": "cic_regulator_ineligible", "type": null, "when": "registry_error: Regulator found the company ineligible (s55); appeal to the Appeal Officer (s55A)." } ] } }, "Params_uk_cic_convert_to_cio": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "description": "Scottish and Northern Ireland CICs can first use uk.cic.convert_to_charitable_company." }, "cic_number": { "type": "string", "description": "Companies House number." }, "proposed_cio_name": { "type": "string", "description": "Replace 'CIC' with 'CIO'; not a sensitive name." }, "constitution_model": { "type": "string", "enum": [ "association", "foundation", "other_commission_approved" ], "description": "Commission model; the CIC guidance points to association." }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Proposed CIO constitution." }, "has_entrenchment_provision": { "type": "boolean", "description": "True needs an entrenchment statement (reg 4)." }, "liability": { "type": "object", "description": "{type: guarantee|shares, current_guarantee: money, cio_liability: money, shares_fully_paid: boolean}." }, "acknowledge_share_cancellation": { "type": "boolean", "description": "Required with share capital: all shares are cancelled on conversion with no rights kept (reg 10)." }, "resulting_charity_exempt": { "type": "boolean", "description": "Must be false (reg 4)." }, "conversion_resolution": { "type": "object", "description": "{type: special_resolution | unanimous_written_resolution, passed_date} (reg 4)." }, "constitution_resolution_date": { "type": "string", "format": "date", "description": "Date members adopted the CIO constitution." }, "trustees": { "type": "array", "items": {}, "description": "Array of person_ref: the directors who will be trustees." }, "social_housing": { "type": "object", "description": "{is_provider: boolean, rsh_notified_date}." }, "filings_up_to_date": { "type": "boolean", "description": "Accounts and CIC reports filed; overdue filings make a grant inappropriate (reg 8)." } }, "required": [ "registration_jurisdiction", "cic_number", "proposed_cio_name", "constitution_model", "constitution_document_id", "has_entrenchment_provision", "liability", "resulting_charity_exempt", "conversion_resolution", "constitution_resolution_date", "trustees", "social_housing", "filings_up_to_date" ], "description": "Converts a CIC into a CIO under Charities Act 2011 s234 and the CIO Regulations 2017 Part 2. Members pass a conversion resolution and one adopting the CIO constitution, directors sign the Commission's declaration, and Entiva applies for." }, "Create_uk_cic_convert_to_cio": { "type": "object", "properties": { "type": { "const": "uk.cic.convert_to_cio" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_convert_to_cio" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a community interest company into a CIO", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution to convert", "source": "generated", "required": true }, { "key": "conversion_resolution", "title": "Resolution that members wish to convert the CIC into a CIO under the 2017 Regulations", "source": "generated", "required": true }, { "key": "constitution_adoption_resolution", "title": "Resolution that members adopted the CIO constitution", "source": "generated", "required": true }, { "key": "proposed_cio_constitution", "title": "Proposed CIO constitution", "source": "uploaded", "required": true }, { "key": "trustee_declaration_forms", "title": "Trustee Declaration Forms, wet-ink signed, one per trustee", "source": "uploaded", "required": true }, { "key": "special_circumstances_statement", "title": "Text for the application's 'Special Circumstances' box naming the converting CIC", "source": "generated", "required": true }, { "key": "regulator_eligibility_decision", "title": "CIC Regulator's decision that the CIC may cease to be a CIC", "source": "registry_issued", "required": false }, { "key": "charity_register_entry", "title": "Register of charities entry showing CIO status", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "conversion_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "constitution_adoption_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "trustee_declaration_forms", "signer_role": "trustee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "Commission charity registration service with the resolutions, proposed constitution and Tr", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "shares_not_fully_paid", "type": null, "when": "requirement_error: partly paid shares (reg 4)." }, { "code": "resulting_charity_exempt", "type": null, "when": "requirement_error: the resulting charity would be exempt (reg 4)." }, { "code": "share_cancellation_not_acknowledged", "type": null, "when": "requirement_error: share capital exists and the cancellation is not acknowledged." }, { "code": "cic_regulator_ineligible", "type": null, "when": "registry_error: Regulator found the CIC ineligible (2004 Act s55: e.g. ordered audit, manager, winding-up petition)." }, { "code": "filings_overdue", "type": null, "when": "requirement_error: accounts or reports not filed (reg 8)." } ] } }, "Params_uk_cic_convert_to_registered_society": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Registered societies are offered here in england_wales and scotland only; the Regulator's guide also describes a Northern Ireland route this catalog does not." }, "cic_number": { "type": "string", "description": "Companies House number." }, "society_type": { "type": "string", "enum": [ "community_benefit_society" ], "description": "Community benefit society with assets restricted under SI 2006/264." }, "proposed_society_name": { "type": "string", "description": "Must not include 'company' (CCBSA 2014 s115)." }, "society_rules_document_id": { "type": "string", "pattern": "^doc_", "description": "Rules, signed by the appointed members and the secretary or a director (s115); cover the s14 matters." }, "appointed_members": { "type": "array", "items": {}, "description": "Array of exactly three person_ref: members appointed in the special resolution (s115)." }, "appointed_members_may_accept_fca_changes": { "type": "boolean", "description": "True if they may accept FCA-required rule changes without a further meeting (s115)." }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "Secretary, or a director if none." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date members passed the special resolution." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In Great Britain or the Channel Islands (s2)." }, "member_count": { "type": "integer", "description": "At least 3, or 2 that are both registered societies (s2)." }, "community_benefit_statement": { "type": "string", "description": "How the business benefits the community (s2); the FCA must be satisfied." }, "excess_shares": { "type": "object", "description": "{convert_to_loan_stock: boolean, interest_rate_percent, repayment_terms}." } }, "required": [ "registration_jurisdiction", "cic_number", "society_type", "proposed_society_name", "society_rules_document_id", "appointed_members", "appointed_members_may_accept_fca_changes", "signing_officer", "special_resolution_date", "registered_office", "member_count", "community_benefit_statement", "excess_shares" ], "description": "Takes a CIC out of CIC status by converting it into a community benefit society with restricted assets. Members pass a special resolution; Entiva posts it with the society rules and an authorised members' statement to the registrar, who." }, "Create_uk_cic_convert_to_registered_society": { "type": "object", "properties": { "type": { "const": "uk.cic.convert_to_registered_society" }, "params": { "$ref": "#/components/schemas/Params_uk_cic_convert_to_registered_society" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a CIC into a community benefit society with restricted assets", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "cic" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution to convert into a registered society with a restriction on use of assets", "source": "generated", "required": true }, { "key": "society_rules", "title": "Rules of the society", "source": "uploaded", "required": true }, { "key": "restricted_assets_statement", "title": "Authorised members' statement that the company becomes a society with restricted assets if the.", "source": "generated", "required": true }, { "key": "regulator_decision_notice", "title": "CIC Regulator's eligibility decision", "source": "registry_issued", "required": false }, { "key": "fca_rules_certificate", "title": "FCA acknowledgement of registration and rules certificate (s115)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "society_rules", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "restricted_assets_statement", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies", "form": "No prescribed form: resolution, rules and statement to the registrar", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "appointed_members_wrong_count", "type": null, "when": "invalid_request_error: not exactly three appointed members (s115)." }, { "code": "name_contains_company", "type": null, "when": "invalid_request_error: society name includes 'company' (s115)." }, { "code": "society_conditions_not_met", "type": null, "when": "requirement_error: fewer than 3 members, office outside Great Britain or the Channel Islands, or no community-benefit basis (s2)." }, { "code": "cic_regulator_ineligible", "type": null, "when": "registry_error: Regulator found the CIC ineligible." }, { "code": "fca_registration_refused", "type": null, "when": "registry_error: the FCA is not satisfied the conditions are met." } ] } }, "Params_uk_company_convert_to_cic": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Taken from the entity. northern_ireland returns jurisdiction_not_supported until CIC availability there is confirmed." }, "name": { "type": "string", "description": "Ends 'CIC', 'C.I.C.' or 'community interest company'; same on articles and CIC37." }, "resolution_date": { "type": "string", "format": "date", "description": "Special resolution to become a CIC (2004 Act s37)." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "Written resolution or general meeting." }, "articles_source": { "type": "string", "enum": [ "cic_model_shares", "cic_model_guarantee", "uploaded" ], "description": "Mandatory CIC clauses cannot be altered; shares or guarantee type cannot change." }, "community_description": { "type": "string", "description": "CIC37 section A: the community or section of it to benefit." }, "activities": { "type": "array", "items": {}, "description": "CIC37 section B: [{activity, benefit_to_community}].", "examples": [ "[{\"activity\":\"Free weekly football coaching\",\"benefit_to_community\":\"Free activity for children who cannot afford paid coaching\"}]" ] }, "surplus_use": { "type": "string", "description": "Donating to a non-nominated asset-locked body needs 'with the consent of the CIC Regulator'." }, "is_incorporated_charity": { "type": "boolean", "description": "True needs written Charity Commission or OSCR consent." }, "not_excluded_company_declaration": { "type": "boolean", "description": "Not a political party, campaigning organisation or subsidiary." }, "signing_directors": { "type": "array", "items": {}, "description": "person_ref of every director; each signs CIC37 section D.", "examples": [ "[\"per_test_7c1d\",\"per_test_9e02\"]" ] } }, "required": [ "name", "resolution_date", "resolution_method", "articles_source", "community_description", "activities", "surplus_use", "is_incorporated_charity", "not_excluded_company_declaration", "signing_directors" ], "description": "Converts a limited company into a CIC: special resolution, CIC name and articles with asset lock, and form CIC37 signed by every director. The CIC Regulator decides eligibility." }, "Create_uk_company_convert_to_cic": { "type": "object", "properties": { "type": { "const": "uk.company.convert_to_cic" }, "params": { "$ref": "#/components/schemas/Params_uk_company_convert_to_cic" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a limited company into a community interest company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the community interest statement", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution: become a CIC, new name and articles", "source": "generated", "required": true }, { "key": "cic_articles", "title": "CIC articles as altered", "source": "generated", "required": true }, { "key": "application_cic37", "title": "Form CIC37 sections A-D", "source": "generated", "required": true }, { "key": "charity_consent", "title": "Charity Commission or OSCR consent", "source": "uploaded", "required": false }, { "key": "new_certificate_of_incorporation", "title": "Certificate of incorporation on conversion", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_cic37", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "CIC37 with special resolution and CIC articles", "channel": "paper", "government_fee": { "amount": 45, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "excluded_company", "type": null, "when": "Political party, campaigning body or subsidiary." }, { "code": "charity_consent_missing", "type": null, "when": "Incorporated charity without consent." }, { "code": "articles_missing_statutory_clauses", "type": null, "when": "Mandatory CIC clauses omitted or altered." }, { "code": "company_type_changed", "type": null, "when": "Articles switch shares and guarantee." } ] } }, "Params_uk_company_convert_to_limited": { "type": "object", "properties": { "limited_form": { "type": "string", "enum": [ "by_shares", "by_guarantee" ], "description": "Must be stated in the resolution (s105)." }, "name": { "type": "string", "description": "Name with the limited ending." }, "resolution_date": { "type": "string", "format": "date", "description": "Special resolution date (s105)." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "Written resolution or general meeting." }, "guarantee_amount_per_member": { "$ref": "#/components/schemas/Money", "description": "Required if by_guarantee.", "examples": [ "1.00 GBP" ] }, "has_allotted_share_capital": { "type": "boolean", "description": "True triggers the s108 statement of capital within 15 days." }, "articles_source": { "type": "string", "enum": [ "entiva_model", "uploaded" ], "description": "Entiva's model or customer-uploaded articles." }, "authenticating": { "type": "string", "pattern": "^per_", "description": "Director, secretary or person authorised." }, "confirm_statement_of_compliance": { "type": "boolean", "description": "Part 7 requirements met; a false statement can be an offence." } }, "required": [ "limited_form", "name", "resolution_date", "resolution_method", "has_allotted_share_capital", "articles_source", "authenticating", "confirm_statement_of_compliance" ], "description": "Re-registers an unlimited company as private limited by shares or guarantee on a special resolution and form RR06; a statement of capital follows within 15 days." }, "Create_uk_company_convert_to_limited": { "type": "object", "properties": { "type": { "const": "uk.company.convert_to_limited" }, "params": { "$ref": "#/components/schemas/Params_uk_company_convert_to_limited" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register an unlimited company as a private limited company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the application", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution: re-register as limited", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as proposed to be amended", "source": "generated", "required": true }, { "key": "statement_of_guarantee", "title": "Statement of guarantee", "source": "generated", "required": false }, { "key": "statement_of_capital", "title": "Statement of capital within 15 days", "source": "generated", "required": false }, { "key": "application_rr06", "title": "Completed form RR06", "source": "generated", "required": true }, { "key": "new_certificate_of_incorporation", "title": "Certificate of incorporation on re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_rr06", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_capital", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RR06", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "previously_reregistered_unlimited", "type": null, "when": "Previously re-registered as unlimited (s105)." }, { "code": "guarantee_amount_missing", "type": null, "when": "by_guarantee without an amount." }, { "code": "resolution_missing_limited_form", "type": null, "when": "Resolution omits shares or guarantee (s105)." }, { "code": "statement_of_capital_overdue", "type": null, "when": "15 days passed without it." } ] } }, "Params_uk_company_convert_to_private": { "type": "object", "properties": { "name": { "type": "string", "description": "Name with the private limited ending." }, "resolution_date": { "type": "string", "format": "date", "description": "Special resolution passed at a general meeting (s97)." }, "cancellation_status": { "type": "string", "enum": [ "no_application_can_be_made", "window_expired", "application_withdrawn", "court_confirmed" ], "description": "State of the s98 window (s97)." }, "articles_source": { "type": "string", "enum": [ "entiva_model_private", "uploaded" ], "description": "Entiva's private model, or customer-uploaded articles." }, "authenticating": { "type": "string", "pattern": "^per_", "description": "Director, secretary or person authorised; printed name only." }, "confirm_statement_of_compliance": { "type": "boolean", "description": "Part 7 requirements met; a false statement can be an offence." } }, "required": [ "name", "resolution_date", "cancellation_status", "articles_source", "authenticating", "confirm_statement_of_compliance" ], "description": "Re-registers a public company as a private limited company: special resolution at a general meeting, 28-day cancellation window, then form RR02." }, "Create_uk_company_convert_to_private": { "type": "object", "properties": { "type": { "const": "uk.company.convert_to_private" }, "params": { "$ref": "#/components/schemas/Params_uk_company_convert_to_private" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a public company as a private limited company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution convening the meeting and approving RR02", "source": "generated", "required": true }, { "key": "notice_of_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution and minutes", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as proposed to be amended", "source": "generated", "required": true }, { "key": "court_order", "title": "Court order confirming the resolution, if any", "source": "uploaded", "required": false }, { "key": "application_rr02", "title": "Completed form RR02", "source": "generated", "required": true }, { "key": "new_certificate_of_incorporation", "title": "Certificate of incorporation on re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_rr02", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RR02", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "written_resolution_not_allowed", "type": null, "when": "Public company passed the resolution in writing." }, { "code": "cancellation_window_open", "type": null, "when": "28 days have not passed (s98)." }, { "code": "cancellation_application_pending", "type": null, "when": "A court application is pending." }, { "code": "resolution_cancelled", "type": null, "when": "The court cancelled the resolution." } ] } }, "Params_uk_company_convert_to_public": { "type": "object", "properties": { "name": { "type": "string", "description": "Ends 'public limited company' or 'p.l.c.' (s58); Welsh endings allowed (s58)." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed (s90)." }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "Private companies may use a written resolution." }, "articles_source": { "type": "string", "enum": [ "entiva_model_public", "uploaded" ], "description": "Entiva's public company model, or customer-uploaded articles." }, "balance_sheet_date": { "type": "string", "format": "date", "description": "No more than 7 months before delivery (s92)." }, "allotted_share_capital": { "$ref": "#/components/schemas/Money", "description": "At least £50,000 or euro equivalent.", "examples": [ "50000.00 GBP" ] }, "aggregate_paid_up": { "$ref": "#/components/schemas/Money", "description": "Paid up on nominal value (s94); each share a quarter plus full premium.", "examples": [ "50000.00 GBP" ] }, "non_cash_allotment_since_balance_sheet": { "type": "boolean", "description": "True needs a valuation report unless a share exchange or merger." }, "secretary": { "type": "string", "pattern": "^per_", "description": "Required if no secretary (s94, s95); must meet s273." }, "authenticating": { "type": "string", "pattern": "^per_", "description": "Director, secretary or person authorised; printed name only." }, "confirm_statement_of_compliance": { "type": "boolean", "description": "Part 7 requirements met (s94); a false statement can be an offence." } }, "required": [ "name", "resolution_date", "resolution_method", "articles_source", "balance_sheet_date", "allotted_share_capital", "aggregate_paid_up", "non_cash_allotment_since_balance_sheet", "authenticating", "confirm_statement_of_compliance" ], "description": "Re-registers a private company as a public company limited by shares: special resolution, audited balance sheet, new name and articles, and form RR01." }, "Create_uk_company_convert_to_public": { "type": "object", "properties": { "type": { "const": "uk.company.convert_to_public" }, "params": { "$ref": "#/components/schemas/Params_uk_company_convert_to_public" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a private company as a public company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_unlimited" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the application", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution: re-register, new name and articles", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as proposed to be amended", "source": "generated", "required": true }, { "key": "balance_sheet", "title": "Balance sheet within 7 months", "source": "uploaded", "required": true }, { "key": "auditor_report", "title": "Unqualified auditor's report (s92)", "source": "uploaded", "required": true }, { "key": "auditor_statement", "title": "Auditor's net assets statement (s92)", "source": "uploaded", "required": true }, { "key": "secretary_consent", "title": "Proposed secretary's consent to act", "source": "generated", "required": false }, { "key": "valuation_report", "title": "Valuation report for a non-cash allotment", "source": "uploaded", "required": false }, { "key": "application_rr01", "title": "Completed form RR01", "source": "generated", "required": true }, { "key": "new_certificate_of_incorporation", "title": "Certificate of incorporation on re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "secretary_consent", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_rr01", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RR01", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "authorised_minimum_not_met", "type": null, "when": "Allotted capital under £50,000 or euro equivalent." }, { "code": "shares_not_quarter_paid", "type": null, "when": "A share is under a quarter paid plus premium." }, { "code": "balance_sheet_too_old", "type": null, "when": "Balance sheet over 7 months old." }, { "code": "auditor_report_qualified", "type": null, "when": "Report qualified or net assets too low." } ] } }, "Params_uk_company_convert_to_registered_society": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Where the company is registered." }, "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee" ], "description": "CICs cannot use this route: use uk.cic.convert_to_registered_society." }, "company_number": { "type": "string", "description": "Companies House number." }, "society_type": { "type": "string", "enum": [ "co_operative_society", "community_benefit_society" ], "description": "Bona fide co-operative society or community benefit society." }, "proposed_society_name": { "type": "string", "description": "Must not include 'company' (s115)." }, "society_rules_document_id": { "type": "string", "pattern": "^doc_", "description": "Rules covering the s14 matters." }, "appointed_members": { "type": "array", "items": {}, "description": "Array of exactly three person_ref appointed in the resolution (s115)." }, "appointed_members_may_accept_fca_changes": { "type": "boolean", "description": "True if they may accept FCA rule changes without a further meeting (s115)." }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "Secretary, or a director if none; signs the rules (s115)." }, "special_resolution": { "type": "object", "description": "{method: general_meeting|written_resolution, passed_date}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In Great Britain or the Channel Islands (s2)." }, "member_count": { "type": "integer", "description": "At least 3, or 2 that are both registered societies (s2)." }, "business_basis_statement": { "type": "string", "description": "Why it qualifies: bona fide co-operative or community benefit (s2,)." }, "excess_shares": { "type": "object", "description": "{convert_to_loan_stock: boolean, interest_rate_percent, repayment_terms}." } }, "required": [ "registration_jurisdiction", "entity_type", "company_number", "society_type", "proposed_society_name", "society_rules_document_id", "appointed_members", "appointed_members_may_accept_fca_changes", "signing_officer", "special_resolution", "registered_office", "member_count", "business_basis_statement", "excess_shares" ], "description": "Converts a private company limited by shares or guarantee into a co-operative or community benefit society under CCBSA 2014 ss115-117. The company passes a special resolution with the society's rules and three appointed members; the FCA." }, "Create_uk_company_convert_to_registered_society": { "type": "object", "properties": { "type": { "const": "uk.company.convert_to_registered_society" }, "params": { "$ref": "#/components/schemas/Params_uk_company_convert_to_registered_society" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a company into a registered society", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution to convert, appointing three members", "source": "generated", "required": true }, { "key": "society_rules", "title": "Rules of the society", "source": "uploaded", "required": true }, { "key": "fca_submission", "title": "Copy of the resolution and rules sent to the FCA (s115)", "source": "generated", "required": true }, { "key": "fca_rules_certificate", "title": "FCA acknowledgement of registration and rules certificate (s115)", "source": "registry_issued", "required": false }, { "key": "companies_house_cancellation_notice", "title": "Registrar's registration of the resolution and certificate; company cancelled", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "society_rules", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "FCA", "form": "No FCA form listed for converting a company: resolution and rules to the FCA", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cic_not_eligible", "type": null, "when": "requirement_error: the company is a CIC." }, { "code": "appointed_members_wrong_count", "type": null, "when": "invalid_request_error: not exactly three appointed members." }, { "code": "name_contains_company", "type": null, "when": "invalid_request_error: society name includes 'company' (s115)." }, { "code": "society_conditions_not_met", "type": null, "when": "requirement_error: fewer than 3 members, no co-operative or community basis, or office outside Great Britain or the Channel Islands." }, { "code": "fca_registration_refused", "type": null, "when": "registry_error: the FCA is not satisfied the conditions are met." } ] } }, "Params_uk_company_convert_to_unlimited": { "type": "object", "properties": { "name": { "type": "string", "description": "New name without limited or public endings (ss102, 109)." }, "member_assents": { "type": "array", "items": {}, "description": "One per member: {member_id, signed_by_person_id, on_behalf_of_member}.", "examples": [ "[{\"member_id\":\"per_test_a1\",\"signed_by_person_id\":\"per_test_a1\",\"on_behalf_of_member\":false}]" ] }, "articles_source": { "type": "string", "enum": [ "entiva_model_unlimited", "uploaded" ], "description": "Entiva's unlimited model, or customer-uploaded articles." }, "authenticating_directors": { "type": "array", "items": {}, "description": "person_ref of every director; all must authenticate the form.", "examples": [ "[\"per_test_7c1d\",\"per_test_9e02\"]" ] }, "directors_confirm_whole_membership": { "type": "boolean", "description": "Assenting persons are the whole membership and agents' authority was checked (ss103, 110)." } }, "required": [ "name", "member_assents", "articles_source", "authenticating_directors", "directors_confirm_whole_membership" ], "description": "Re-registers a company as unlimited: RR05 for a private company, RR07 for a public one. Every member assents and every director authenticates." }, "Create_uk_company_convert_to_unlimited": { "type": "object", "properties": { "type": { "const": "uk.company.convert_to_unlimited" }, "params": { "$ref": "#/components/schemas/Params_uk_company_convert_to_unlimited" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a company as unlimited", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the application", "source": "generated", "required": true }, { "key": "member_assent_form", "title": "Prescribed form of assent, one per member", "source": "generated", "required": true }, { "key": "amended_articles", "title": "Articles as proposed to be amended", "source": "generated", "required": true }, { "key": "application_rr05_or_rr07", "title": "Completed RR05 or RR07", "source": "generated", "required": true }, { "key": "new_certificate_of_incorporation", "title": "Certificate of incorporation on re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "member_assent_form", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_rr05_or_rr07", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RR05", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "member_assent_missing", "type": null, "when": "A member has not assented." }, { "code": "previously_reregistered", "type": null, "when": "Barred by an earlier re-registration (s102 or s109)." }, { "code": "director_authentication_missing", "type": null, "when": "A director has not authenticated." }, { "code": "not_limited_by_shares", "type": null, "when": "A public company must be limited by shares (s109)." } ] } }, "Params_uk_company_voluntary_arrangement_propose": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Taken from the entity." }, "proposer": { "type": "string", "enum": [ "directors", "administrator", "liquidator" ], "description": "Directors, or the administrator or liquidator." }, "arrangement_type": { "type": "string", "enum": [ "composition", "scheme_of_arrangement" ], "description": "Composition or scheme of arrangement." }, "duration_months": { "type": "integer", "description": "Planned length." }, "secured_or_preferential_creditors_affected": { "type": "boolean", "description": "True needs the creditor's concurrence (s4-)." }, "prior_moratorium": { "type": "boolean", "description": "A Part A1 moratorium continues while a CVA proposal is pending." } }, "required": [ "proposer", "arrangement_type", "duration_months", "secured_or_preferential_creditors_affected", "prior_moratorium" ], "description": "Proposes a company voluntary arrangement with creditors through a nominee then supervisor. Creditors approve by 75% in value; members then decide." }, "Create_uk_company_voluntary_arrangement_propose": { "type": "object", "properties": { "type": { "const": "uk.company_voluntary_arrangement.propose" }, "params": { "$ref": "#/components/schemas/Params_uk_company_voluntary_arrangement_propose" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Propose a company voluntary arrangement", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true }, { "key": "cva_proposal", "title": "Proposal: assets, liabilities, fees, supervisor, duration", "source": "uploaded", "required": true }, { "key": "statement_of_affairs", "title": "Statement of affairs, within 2 weeks of the proposal", "source": "generated", "required": true }, { "key": "nominee_consent_and_report", "title": "Nominee's consent and report to court (s2, r2.9)", "source": "generated", "required": true }, { "key": "report_of_result", "title": "Report of result to court within 4 business days", "source": "generated", "required": true }, { "key": "notice_cva1", "title": "CVA1; CVA3 annual report; CVA4", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "cva_proposal", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "statement_of_affairs", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "nominee_consent_and_report", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "The court", "form": "Nominee's report", "channel": "both", "government_fee": { "amount": 11, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "nominee_report_overdue", "type": null, "when": "Over 28 days since the nominee got the proposal." }, { "code": "creditor_threshold_not_met", "type": null, "when": "Under 75% in value, or over half of unconnected creditors against." }, { "code": "secured_creditor_concurrence_missing", "type": null, "when": "Term affects secured rights without concurrence (s4)." }, { "code": "challenge_window_open", "type": null, "when": "28-day s6 window has not ended." } ] } }, "Params_uk_limited_partnership_designate_pflp": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "slp" ], "description": "An existing PFLP cannot apply." }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Taken from the entity. slp is Scotland only." }, "registered_number": { "type": "string", "description": "Registered number (s8D)." }, "registration_date": { "type": "string", "format": "date", "description": "Date of registration (s8D)." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal place of business (s8D)." }, "partnership_agreement_in_writing": { "type": "boolean", "description": "Condition (s8D)." }, "collective_investment_scheme_confirmed": { "type": "boolean", "description": "Condition: FSMA s235 collective investment scheme (s8D,); a general partner confirms (s8D)." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref or entity_ref of every general partner; each signs (s8D).", "examples": [ "[\"per_test_41aa\",\"ent_test_gp02\"]" ] } }, "required": [ "entity_type", "registered_number", "registration_date", "principal_place_of_business", "partnership_agreement_in_writing", "collective_investment_scheme_confirmed", "general_partners" ], "description": "Designates a registered limited partnership, including a Scottish LP, as a private fund limited partnership with form LP8 signed by every general partner." }, "Create_uk_limited_partnership_designate_pflp": { "type": "object", "properties": { "type": { "const": "uk.limited_partnership.designate_pflp" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_partnership_designate_pflp" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Designate a registered limited partnership as a private fund limited partnership", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "lp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Written limited partnership agreement", "source": "uploaded", "required": true }, { "key": "application_lp8", "title": "Completed form LP8", "source": "generated", "required": true }, { "key": "certificate_of_designation", "title": "Certificate of designation", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_lp8", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP8", "channel": "paper", "government_fee": { "amount": 30, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_collective_investment_scheme", "type": null, "when": "Fails the FSMA s235 test." }, { "code": "agreement_not_in_writing", "type": null, "when": "No written agreement." }, { "code": "already_designated", "type": null, "when": "Already a private fund limited partnership." }, { "code": "general_partner_signature_missing", "type": null, "when": "A general partner has not signed." } ] } }, "Params_uk_moratorium_request": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Taken from the entity. northern_ireland is scoped by an NI-licensed practitioner; statutory references are for Great Britain." }, "filing_route": { "type": "string", "enum": [ "directors_file_at_court", "court_application_petition_outstanding", "court_application_overseas_company" ], "description": "Directors file at court; court application if a winding-up petition is outstanding or the company is overseas." }, "insolvency_basis": { "type": "string", "enum": [ "unable_to_pay_debts", "likely_to_become_unable" ], "description": "Directors' statement: unable, or likely to become unable, to pay debts (s A6)." }, "rescue_plan_summary": { "type": "string", "description": "How the moratorium helps rescue the company as a going concern." }, "winding_up_petition_outstanding": { "type": "boolean", "description": "True forces a court application showing a better result than winding up (s A4)." }, "insolvency_procedure_in_last_12_months": { "type": "boolean", "description": "Makes the company ineligible." }, "excluded_sector": { "type": "string", "enum": [ "none", "insurer", "bank", "e_money_or_payment_institution", "investment_firm", "market_or_capital_markets_participant", "securitisation_or_ppp", "social_housing_provider" ], "description": "Sch ZA1 exclusions." } }, "required": [ "filing_route", "insolvency_basis", "rescue_plan_summary", "winding_up_petition_outstanding", "insolvency_procedure_in_last_12_months", "excluded_sector" ], "description": "Gets a 20 business day Part A1 moratorium for an eligible company by filing at court or applying, with a licensed monitor. Extendable by directors, creditors or the court." }, "Create_uk_moratorium_request": { "type": "object", "properties": { "type": { "const": "uk.moratorium.request" }, "params": { "$ref": "#/components/schemas/Params_uk_moratorium_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain a Part A1 moratorium", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true }, { "key": "directors_notice_and_statement", "title": "Directors' notice and statement of inability to pay (s A6)", "source": "generated", "required": true }, { "key": "monitor_consent_and_statements", "title": "Monitor's consent, eligibility and rescue statements (s A6)", "source": "generated", "required": true }, { "key": "eligibility_check", "title": "Schedule ZA1 eligibility check", "source": "generated", "required": true }, { "key": "notice_mt01", "title": "MT01 commencement notice", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_notice_and_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "monitor_consent_and_statements", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "The court", "form": "s A6 documents at court", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "company_not_eligible", "type": null, "when": "Falls in a Schedule ZA1 exclusion." }, { "code": "recent_insolvency_procedure", "type": null, "when": "Procedure in the last 12 months." }, { "code": "winding_up_petition_outstanding", "type": null, "when": "Use the court application route." }, { "code": "monitor_statement_missing", "type": null, "when": "s A6 statements missing." } ] } }, "Params_uk_mvl_reconstruction_implement": { "type": "object", "properties": { "winding_up_type": { "type": "string", "enum": [ "mvl", "cvl" ], "description": "Members' or creditors' voluntary winding up." }, "winding_up_stage": { "type": "string", "enum": [ "proposed", "resolution_passed" ], "description": "s110 applies where the company is being, or is proposed to be, wound up voluntarily." }, "transferee": { "type": "object", "description": "{type: company|llp, name, registration_number, jurisdiction}.", "examples": [ "{\"type\":\"company\",\"name\":\"Beacon Newco Limited\",\"registration_number\":\"15432198\",\"jurisdiction\":\"england_wales\"}" ] }, "consideration_type": { "type": "string", "enum": [ "shares", "policies_or_interests", "llp_membership", "profit_participation", "mixed" ], "description": "What the liquidator receives for members (s110,)." }, "authority_type": { "type": "string", "enum": [ "general_authority", "specific_arrangement" ], "description": "General authority, or one arrangement (s110)." }, "sanction_route": { "type": "string", "enum": [ "special_resolution", "court", "liquidation_committee" ], "description": "MVL: special resolution." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the s110 resolution was passed." } }, "required": [ "winding_up_type", "winding_up_stage", "transferee", "consideration_type", "authority_type", "sanction_route" ], "description": "Transfers a business to another company or LLP in a voluntary winding up, the liquidator taking shares or interests for members. Dissenters have 7 days." }, "Create_uk_mvl_reconstruction_implement": { "type": "object", "properties": { "type": { "const": "uk.mvl_reconstruction.implement" }, "params": { "$ref": "#/components/schemas/Params_uk_mvl_reconstruction_implement" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reconstruct through a voluntary liquidation", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the proposal and application", "source": "generated", "required": true }, { "key": "s110_special_resolution", "title": "Special resolution authorising the liquidator", "source": "generated", "required": true }, { "key": "transfer_agreement", "title": "Sale or transfer agreement", "source": "uploaded", "required": true }, { "key": "dissent_notice", "title": "Notice of the s111 dissent right", "source": "generated", "required": true }, { "key": "liquidation_committee_or_court_sanction", "title": "CVL only: committee resolution or court order", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "s110_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "transfer_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Resolution copy via the upload service", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_in_voluntary_winding_up", "type": null, "when": "Not being, or proposed to be, wound up voluntarily." }, { "code": "declaration_of_solvency_missing", "type": null, "when": "MVL without the declaration." }, { "code": "dissent_period_open", "type": null, "when": "The 7-day s111 period has not ended." }, { "code": "court_winding_up_within_year", "type": null, "when": "Court-ordered winding up within a year without sanction (s110)." } ] } }, "Params_uk_public_company_merger_implement": { "type": "object", "properties": { "merger_type": { "type": "string", "enum": [ "absorption", "new_company", "division" ], "description": "Absorption or new company; division among transferees." }, "role_of_this_entity": { "type": "string", "enum": [ "transferor", "transferee" ], "description": "This entity's role." }, "counterparties": { "type": "array", "items": {}, "description": "Other companies: {entity_id or company_number, name, role, is_new_company}.", "examples": [ "[{\"company_number\":\"01234567\",\"name\":\"Beacon Systems plc\",\"role\":\"transferee\"}]" ] }, "share_exchange_ratio": { "type": "string", "description": "Exchange ratio, or for a division the allocation criteria." }, "last_accounts_date": { "type": "string", "format": "date", "description": "A supplementary statement is needed if accounts are over 7 months before the first meeting." }, "publication_method": { "type": "string", "enum": [ "gazette_notice", "website" ], "description": "Registrar's Gazette notice or website, a month before any members' meeting." } }, "required": [ "merger_type", "role_of_this_entity", "counterparties", "share_exchange_ratio", "last_accounts_date", "publication_method" ], "description": "Merges public companies or divides one, as a court-sanctioned scheme under CA 2006 Part 27: draft terms, expert report, member votes, sanction." }, "Create_uk_public_company_merger_implement": { "type": "object", "properties": { "type": { "const": "uk.public_company_merger.implement" }, "params": { "$ref": "#/components/schemas/Params_uk_public_company_merger_implement" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge or divide public companies", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "plc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the proposal and application", "source": "generated", "required": true }, { "key": "draft_terms", "title": "Draft terms", "source": "generated", "required": true }, { "key": "directors_explanatory_report", "title": "Directors' explanatory report", "source": "generated", "required": true }, { "key": "expert_report", "title": "Independent expert's report", "source": "uploaded", "required": true }, { "key": "supplementary_accounting_statement", "title": "Supplementary accounting statement", "source": "uploaded", "required": false }, { "key": "new_company_articles", "title": "Articles of a new transferee", "source": "generated", "required": false }, { "key": "meeting_notices_and_proxies", "title": "Meeting notices, proxy and voting forms", "source": "generated", "required": true }, { "key": "witness_statements", "title": "Witness statements in support", "source": "uploaded", "required": true }, { "key": "sealed_court_order", "title": "Sealed court order", "source": "uploaded", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "witness_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "meeting_notices_and_proxies", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "expert_report", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Draft terms", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_public_company", "type": null, "when": "A company involved is not public." }, { "code": "company_in_liquidation", "type": null, "when": "A company is being wound up." }, { "code": "one_month_publication_not_met", "type": null, "when": "Draft terms not published a month before the first meeting." }, { "code": "exemption_conditions_not_met", "type": null, "when": "A claimed exemption is not met." } ] } }, "Params_uk_redomiciliation_request": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "inbound", "outbound" ], "description": "inbound moves a foreign entity into the UK; outbound moves a UK entity abroad." }, "foreign_jurisdiction": { "type": "string", "description": "ISO 3166 code of the other jurisdiction." } }, "required": [ "direction", "foreign_jurisdiction" ], "description": "UK law has no continuation or redomiciliation regime, so every call returns a jurisdiction_error pointing to alternatives." }, "Create_uk_redomiciliation_request": { "type": "object", "properties": { "type": { "const": "uk.redomiciliation.request" }, "params": { "$ref": "#/components/schemas/Params_uk_redomiciliation_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue an entity into or out of the UK", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [], "people": [], "approvals": [], "signatures": [], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "redomiciliation_not_available", "type": null, "when": "Always: HTTP 422, type jurisdiction_error." }, { "code": "invalid_direction", "type": null, "when": "direction is not inbound or outbound." } ] } }, "Params_uk_registered_society_convert_to_company": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Country of the new company's registered office." }, "fca_registration_number": { "type": "string", "description": "FCA Mutuals Public Register number." }, "target_entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc" ], "description": "A society cannot convert into an existing company; a new one is set up." }, "name": { "type": "string", "description": "No name reservation exists; Entiva checks availability." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office of the new company." }, "registered_office_situation": { "type": "string", "enum": [ "england_wales", "wales", "scotland" ], "description": "Situation recorded at Companies House." }, "memorandum_and_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Proposed memorandum and articles." }, "special_resolution": { "type": "object", "description": "{includes_memorandum_particulars, first_meeting_date, second_meeting_date, first_meeting_support_percent, first_meeting_turnout_percent." }, "statement_of_capital": { "type": "array", "items": {}, "description": "Array of {currency, class, number_of_shares, nominal_value, amount_unpaid, rights}; required for shares and plc." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Each member's guarantee; required for a guarantee company." }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref: first directors." }, "secretarys": { "type": "array", "items": {}, "description": "Array of person_ref; required for a plc." }, "psc": { "type": "object", "description": "{statement: has_psc|no_psc, psc_ids: array of person_ref}." }, "sic_codes": { "type": "array", "items": {}, "description": "Array of up to four SIC codes." }, "lawful_purpose_confirmation": { "type": "boolean", "description": "IN01 statement that intended activities are lawful." }, "target_conversion_date": { "type": "string", "format": "date", "description": "Proposed date; the FCA agrees it with Companies House." } }, "required": [ "registration_jurisdiction", "fca_registration_number", "target_entity_type", "name", "registered_office", "registered_office_situation", "memorandum_and_articles_document_id", "special_resolution", "directors", "psc", "sic_codes", "lawful_purpose_confirmation" ], "description": "Converts a co-operative or community benefit society into a company under CCBSA 2014 ss112-114. The society passes a special resolution at two meetings; Entiva files the new company's incorporation on hold with Companies House and sends." }, "Create_uk_registered_society_convert_to_company": { "type": "object", "properties": { "type": { "const": "uk.registered_society.convert_to_company" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_convert_to_company" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a registered society into a company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution_copies", "title": "Three copies of the special resolution, each with the society's name and number", "source": "generated", "required": true }, { "key": "memorandum_and_articles", "title": "Proposed memorandum and articles", "source": "uploaded", "required": true }, { "key": "fca_conversion_form", "title": "FCA 'Convert to a company' form", "source": "generated", "required": true }, { "key": "statutory_declaration", "title": "Declaration that the resolution was passed lawfully and under the rules", "source": "uploaded", "required": true }, { "key": "in01_incorporation_application", "title": "Incorporation application filed on hold", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act for first directors and secretary", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation of the new company", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "other", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution_copies", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fca_conversion_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statutory_declaration", "signer_role": "officer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "in01_incorporation_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "FCA", "form": "FCA 'Convert to a company' paper form with three resolution copies, memorandum and article", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "special_resolution_procedure_invalid", "type": null, "when": "invalid_request_error: votes or meeting dates do not meet s113." }, { "code": "existing_company_not_allowed", "type": null, "when": "invalid_request_error: a society cannot convert into an existing company." }, { "code": "company_name_unavailable", "type": null, "when": "requirement_error: name on the register or restricted." }, { "code": "director_unverified", "type": null, "when": "requirement_error: a first director has no Companies House personal code." }, { "code": "statutory_declaration_missing", "type": null, "when": "requirement_error: the FCA's statutory declaration is missing." } ] } }, "Params_uk_registered_society_merge": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Registered office country of the society the action runs on." }, "amalgamating_societies": { "type": "array", "items": {}, "description": "At least two objects {fca_registration_number, name, entity_id, first_meeting_date, second_meeting_date, first_meeting_support_percent." }, "resulting_society": { "type": "object", "description": "{mode: new_society|existing_society, name, fca_registration_number, rules_document_id}. s109 does not say which; Entiva confirms the route with the FCA." }, "amalgamation_terms_document_id": { "type": "string", "pattern": "^doc_", "description": "Agreement on property and division of funds (s109-)." }, "dissolve_amalgamating_societies": { "type": "boolean", "description": "True if the amalgamation dissolves one or more societies (s109)." }, "includes_pra_authorised_society": { "type": "boolean", "description": "True makes the FCA copy the resolution to the PRA (s111)." }, "secretarys": { "type": "array", "items": {}, "description": "Array of person_ref: each society's secretary." }, "target_effective_date": { "type": "string", "format": "date", "description": "Effective on FCA registration of the resolutions." } }, "required": [ "registration_jurisdiction", "amalgamating_societies", "resulting_society", "amalgamation_terms_document_id", "dissolve_amalgamating_societies", "includes_pra_authorised_society", "secretarys" ], "description": "Merges two or more co-operative or community benefit societies into one under CCBSA 2014 s109. Each society passes a special resolution at two general meetings; the signed copy of each goes to the FCA within 14 days of confirmation and." }, "Create_uk_registered_society_merge": { "type": "object", "properties": { "type": { "const": "uk.registered_society.merge" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amalgamate registered societies", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amalgamation_terms", "title": "Amalgamation agreement and funds division terms", "source": "uploaded", "required": true }, { "key": "special_resolution_copies", "title": "Signed copy of each society's special resolution", "source": "generated", "required": true }, { "key": "resulting_society_rules", "title": "Rules of the amalgamated society", "source": "uploaded", "required": true }, { "key": "fca_cover_letter", "title": "Cover letter to the FCA", "source": "generated", "required": true }, { "key": "fca_registration_confirmation", "title": "FCA registration of the resolutions", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution_copies", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "amalgamation_terms", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "FCA", "form": "No FCA amalgamation form is listed", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "special_resolution_procedure_invalid", "type": null, "when": "invalid_request_error: votes or meeting dates do not meet s111." }, { "code": "fewer_than_two_societies", "type": null, "when": "invalid_request_error: fewer than two societies." }, { "code": "fca_route_unconfirmed", "type": null, "when": "requirement_error: the FCA has not confirmed how the amalgamated society is registered." }, { "code": "filing_deadline_missed", "type": null, "when": "requirement_error: signed copy not delivered within 14 days; the FCA may still register it (s111)." }, { "code": "registration_jurisdiction_unsupported", "type": null, "when": "jurisdiction_error: a Northern Ireland society." } ] } }, "Params_uk_registered_society_transfer_engagements": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "Registered office country of the transferor." }, "transferor_fca_registration_number": { "type": "string", "description": "FCA number of the society transferring." }, "transferee": { "type": "object", "description": "{fca_registration_number, name, entity_id}: the receiving registered society." }, "property_transferred": { "type": "string", "enum": [ "all", "part" ], "description": "All or part of the property passes without conveyance (s110)." }, "property_schedule_document_id": { "type": "string", "pattern": "^doc_", "description": "Schedule of property and engagements; required for a part transfer." }, "transferee_agreement_document_id": { "type": "string", "pattern": "^doc_", "description": "Receiving society's agreement to fulfil the engagements (s110)." }, "special_resolution": { "type": "object", "description": "{first_meeting_date, second_meeting_date, first_meeting_support_percent, second_meeting_support_percent}; meetings 14 days to one month apart." }, "includes_pra_authorised_society": { "type": "boolean", "description": "True makes the FCA copy the resolution to the PRA (s111)." }, "all_property_transferred": { "type": "boolean", "description": "True once all property vested in the transferor is transferred or conveyed; the s126 certificate and cancellation depend on it." }, "s126_certifying_officer": { "type": "string", "pattern": "^per_", "description": "Secretary or another FCA-approved officer who signs the s126 certificate (s126)." }, "transfer_effective_date": { "type": "string", "format": "date", "description": "Effective on FCA registration of the resolution." } }, "required": [ "registration_jurisdiction", "transferor_fca_registration_number", "transferee", "property_transferred", "transferee_agreement_document_id", "special_resolution", "includes_pra_authorised_society", "all_property_transferred", "s126_certifying_officer" ], "description": "Transfers all or some of a registered society's engagements, and approved property, to another registered society that agrees to fulfil them. The transferor passes a special resolution at two meetings and the FCA registers it; once the." }, "Create_uk_registered_society_transfer_engagements": { "type": "object", "properties": { "type": { "const": "uk.registered_society.transfer_engagements" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_transfer_engagements" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a registered society's engagements to another society", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "transfer_agreement", "title": "Receiving society's agreement to fulfil the engagements", "source": "uploaded", "required": true }, { "key": "property_schedule", "title": "Schedule of property and engagements transferred", "source": "uploaded", "required": false }, { "key": "special_resolution_copies", "title": "Signed copies of the transferor's special resolution", "source": "generated", "required": true }, { "key": "fca_transfer_engagements_form", "title": "FCA 'Transfer engagements' form", "source": "generated", "required": true }, { "key": "s126_certificate", "title": "Certificate under s126 that all property is transferred or conveyed", "source": "generated", "required": true }, { "key": "fca_cancellation_confirmation", "title": "FCA cancellation of the transferor's registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution_copies", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fca_transfer_engagements_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "s126_certificate", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "transfer_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "FCA", "form": "FCA 'Transfer engagements' paper form with the signed special resolution copy", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "special_resolution_procedure_invalid", "type": null, "when": "invalid_request_error: votes or meeting dates do not meet s111." }, { "code": "transferee_not_registered", "type": null, "when": "requirement_error: the receiving society is not on the FCA register." }, { "code": "s126_certificate_missing", "type": null, "when": "requirement_error: cancellation requested before the s126 certificate was lodged (s126)." }, { "code": "property_not_fully_transferred", "type": null, "when": "requirement_error: all_property_transferred is false, so the certificate cannot be signed." }, { "code": "registration_jurisdiction_unsupported", "type": null, "when": "jurisdiction_error: a Northern Ireland society." } ] } }, "Params_uk_restructuring_plan_implement": { "type": "object", "properties": { "condition_a_basis": { "type": "string", "description": "Financial difficulties affecting going concern." }, "condition_b_basis": { "type": "string", "description": "How the plan eliminates, reduces, prevents or mitigates them." }, "relevant_alternative": { "type": "string", "description": "What would most likely happen without the plan; used for cram down." }, "classes": { "type": "array", "items": {}, "description": "One per class: {class_name, holders_description, estimated_value, expected_to_vote_for}.", "examples": [ "[{\"class_name\":\"Senior lenders\",\"holders_description\":\"4 banks\",\"estimated_value\":\"85000000.00 GBP\",\"expected_to_vote_for\":true}]" ] }, "cross_class_cram_down_sought": { "type": "boolean", "description": "True to bind a dissenting class." }, "company_status": { "type": "string", "enum": [ "going_concern", "in_administration", "in_liquidation" ], "description": "A liquidator or administrator may apply." }, "pension_scheme_notice_needed": { "type": "boolean", "description": "Notices to the Pensions Regulator or PPF Board." }, "moratorium_ended_within_12_weeks": { "type": "boolean", "description": "True bars moratorium creditors from voting." } }, "required": [ "condition_a_basis", "condition_b_basis", "relevant_alternative", "classes", "cross_class_cram_down_sought", "company_status", "pension_scheme_notice_needed", "moratorium_ended_within_12_weeks" ], "description": "Court-sanctioned restructuring plan for a company in financial difficulty under CA 2006 Part 26A, with optional cross-class cram down. Partner solicitors run the hearings." }, "Create_uk_restructuring_plan_implement": { "type": "object", "properties": { "type": { "const": "uk.restructuring_plan.implement" }, "params": { "$ref": "#/components/schemas/Params_uk_restructuring_plan_implement" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Implement a restructuring plan", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the proposal and application", "source": "generated", "required": true }, { "key": "plan_document", "title": "Restructuring plan", "source": "uploaded", "required": true }, { "key": "explanatory_statement", "title": "Explanatory statement with directors' interests", "source": "uploaded", "required": true }, { "key": "claim_and_evidence", "title": "Court claim form and evidence bundle", "source": "generated", "required": true }, { "key": "witness_statements", "title": "Witness statements in support", "source": "uploaded", "required": true }, { "key": "meeting_notices_and_proxies", "title": "Meeting notices, proxy and voting forms", "source": "generated", "required": true }, { "key": "chair_report", "title": "Chair's report of the meetings", "source": "generated", "required": true }, { "key": "sealed_court_order", "title": "Sealed court order", "source": "uploaded", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "witness_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "meeting_notices_and_proxies", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "chair_report", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Sealed court order", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "condition_a_not_met", "type": null, "when": "No financial difficulty shown." }, { "code": "condition_b_not_met", "type": null, "when": "Plan does not address the difficulty." }, { "code": "company_excluded", "type": null, "when": "Excluded by regulations under s901B." }, { "code": "moratorium_creditor_vote_barred", "type": null, "when": "Moratorium creditors would vote within 12 weeks." } ] } }, "Params_uk_scheme_of_arrangement_implement": { "type": "object", "properties": { "scheme_kind": { "type": "string", "enum": [ "creditor_compromise", "member_arrangement", "creditors_and_members", "reconstruction_or_amalgamation" ], "description": "Who the arrangement binds." }, "classes": { "type": "array", "items": {}, "description": "One per class: {class_name, holders_description, estimated_value}; settled with counsel.", "examples": [ "[{\"class_name\":\"Unsecured trade creditors\",\"holders_description\":\"212 suppliers\",\"estimated_value\":\"4200000.00 GBP\"}]" ] }, "company_status": { "type": "string", "enum": [ "solvent_going_concern", "in_administration", "in_liquidation" ], "description": "A liquidator or administrator may also apply (s899)." }, "involves_public_company_merger_or_division": { "type": "boolean", "description": "True routes to the Part 27 action; Part 26 cannot be sanctioned unless Part 27 is met." } }, "required": [ "scheme_kind", "classes", "company_status", "involves_public_company_merger_or_division" ], "description": "Court-sanctioned compromise or arrangement with creditors or members under CA 2006 Part 26, including reconstructions with s900 transfer orders. Partner solicitors run the hearings." }, "Create_uk_scheme_of_arrangement_implement": { "type": "object", "properties": { "type": { "const": "uk.scheme_of_arrangement.implement" }, "params": { "$ref": "#/components/schemas/Params_uk_scheme_of_arrangement_implement" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Implement a scheme of arrangement", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the proposal and application", "source": "generated", "required": true }, { "key": "scheme_document", "title": "Scheme of arrangement", "source": "uploaded", "required": true }, { "key": "explanatory_statement", "title": "Explanatory statement with directors' interests", "source": "uploaded", "required": true }, { "key": "claim_and_evidence", "title": "Court claim form and evidence bundle", "source": "generated", "required": true }, { "key": "witness_statements", "title": "Witness statements in support", "source": "uploaded", "required": true }, { "key": "meeting_notices_and_proxies", "title": "Meeting notices, proxy and voting forms", "source": "generated", "required": true }, { "key": "chair_report", "title": "Chair's report of the meetings", "source": "generated", "required": true }, { "key": "sealed_court_order", "title": "Sealed court order", "source": "uploaded", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "witness_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "meeting_notices_and_proxies", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "chair_report", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Sealed court order", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "part_27_applies", "type": null, "when": "Public company merger or division; use Part 27." }, { "code": "class_composition_unresolved", "type": null, "when": "Classes not settled with counsel." }, { "code": "majority_not_met", "type": null, "when": "A class missed the majorities (s899)." }, { "code": "licensed_professional_unavailable", "type": null, "when": "No solicitor or counsel instructed." } ] } }, "Params_uk_societas_convert_to_plc": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the UKS is registered." }, "uks_number": { "type": "string", "description": "UKS number." }, "proposed_plc_name": { "type": "string", "description": "Duplicate names are refused." }, "name_approval_document_id": { "type": "string", "pattern": "^doc_", "description": "Approval response; required if the name has sensitive or restricted words." }, "registered_office_situation": { "type": "string", "enum": [ "england_wales", "wales", "scotland", "northern_ireland" ], "description": "Situation of the registered office; the address must match." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Proposed registered office in the UK." }, "draft_terms_notice_action_id": { "type": "string", "description": "Id of the completed uk.societas.notify_conversion_draft_terms action; SE DT03 must be filed first." }, "conversion_dates": { "type": "object", "description": "{registered_as_se, draft_terms_drawn_up, expert_certificate, general_meeting}." }, "management_report_document_id": { "type": "string", "pattern": "^doc_", "description": "Report by the management or administrative organ (Art 66)." }, "expert_certificate_document_id": { "type": "string", "pattern": "^doc_", "description": "Independent expert's certificate that assets at least equal capital (Art 66); expert eligible as statutory auditor and independent (CA 2006 s909)." }, "proposed_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Articles of the proposed PLC." }, "statement_of_capital": { "type": "array", "items": {}, "description": "Array of {currency, class, number_of_shares, nominal_value, aggregate_nominal_value, amount_unpaid, rights: {voting, dividends, capital, redemption}}." }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref: at least two, one an individual; deemed appointed on registration (reg 88)." }, "corporate_directors": { "type": "array", "items": {}, "description": "Array of person_ref for corporate directors." }, "secretarys": { "type": "array", "items": {}, "description": "Array of person_ref: at least one, with the CA 2006 s273 qualification for a PLC." }, "psc": { "type": "object", "description": "{statement: has_psc|no_psc, psc_ids: array of person_ref, section_243_exemption_person_ids}." }, "authenticating_member": { "type": "string", "pattern": "^per_", "description": "Member of the management or administrative organ who authenticates the compliance statement with a printed name." } }, "required": [ "registration_jurisdiction", "uks_number", "proposed_plc_name", "registered_office_situation", "registered_office", "draft_terms_notice_action_id", "conversion_dates", "management_report_document_id", "expert_certificate_document_id", "proposed_articles_document_id", "statement_of_capital", "directors", "secretarys", "psc", "authenticating_member" ], "description": "Second step of converting a UK Societas into a PLC: once the draft terms have been publicised for a month and the general meeting has approved them, Entiva files form SE CV01 with the Art 66 report, the expert's certificate, the PLC." }, "Create_uk_societas_convert_to_plc": { "type": "object", "properties": { "type": { "const": "uk.societas.convert_to_plc" }, "params": { "$ref": "#/components/schemas/Params_uk_societas_convert_to_plc" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a UK Societas into a public limited company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "uk_societas" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "management_report", "title": "Report by the management or administrative organ (Art 66)", "source": "uploaded", "required": true }, { "key": "expert_certificate", "title": "Independent expert's certificate (Art 66)", "source": "uploaded", "required": true }, { "key": "proposed_articles", "title": "Articles of the proposed PLC", "source": "uploaded", "required": true }, { "key": "general_meeting_resolution", "title": "Resolution approving the draft terms and articles (Art 66)", "source": "generated", "required": true }, { "key": "director_secretary_consents", "title": "Consent to act for each director and secretary", "source": "generated", "required": true }, { "key": "psc_confirmations", "title": "Each individual PSC's confirmation that they know their particulars are supplied", "source": "generated", "required": false }, { "key": "se_cv01_form", "title": "Form SE CV01", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Registrar's certificate (reg 87)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "other", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "se_cv01_form", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_secretary_consents", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "psc_confirmations", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "general_meeting_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies", "form": "Form SE CV01", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "draft_terms_not_notified", "type": null, "when": "requirement_error: no completed SE DT03 action for this entity." }, { "code": "notice_period_not_met", "type": null, "when": "requirement_error: the meeting is less than one month after publication." }, { "code": "resolution_majority_not_met", "type": null, "when": "requirement_error: no majority in number representing 75% in value of each class present and voting (s907)." }, { "code": "insufficient_directors", "type": null, "when": "invalid_request_error: fewer than two directors, or none an individual." }, { "code": "director_unverified", "type": null, "when": "requirement_error: a director has no Companies House personal code." } ] } }, "Params_uk_societas_conversion_draft_terms_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the UK Societas is registered; decides the Companies House office." }, "uks_number": { "type": "string", "description": "UKS number; must match the register." }, "proposed_plc_name": { "type": "string", "description": "Full PLC name; it must end 'public limited company' or 'p.l.c.'." }, "draft_terms_document_id": { "type": "string", "pattern": "^doc_", "description": "Draft terms of conversion, attached to the form." }, "planned_general_meeting_date": { "type": "string", "format": "date", "description": "At least one month after the draft terms are publicised (Art 66)." }, "signing_member": { "type": "string", "pattern": "^per_", "description": "Member of the management or administrative organ who signs." } }, "required": [ "registration_jurisdiction", "uks_number", "proposed_plc_name", "draft_terms_document_id", "planned_general_meeting_date", "signing_member" ], "description": "First step of converting a UK Societas into a PLC: delivers the draft terms of conversion to the registrar on form SE DT03 so they are publicised at least one month before the general meeting that decides on them (Council Regulation." }, "Create_uk_societas_conversion_draft_terms_notify": { "type": "object", "properties": { "type": { "const": "uk.societas_conversion_draft_terms.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_societas_conversion_draft_terms_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the draft terms of conversion of a UK Societas into a PLC", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "uk_societas" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "draft_terms", "title": "Draft terms of conversion", "source": "uploaded", "required": true }, { "key": "management_organ_resolution", "title": "Resolution approving the draft terms and the Art 66 report", "source": "generated", "required": true }, { "key": "se_dt03_form", "title": "Form SE DT03", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of receipt of the draft terms", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "registry_idv" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "special", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "management_organ_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "se_dt03_form", "signer_role": "member", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies, office for the UKS's jurisdiction", "form": "Form SE DT03 with the draft terms attached", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "meeting_date_too_early", "type": null, "when": "requirement_error: planned meeting is less than one month after expected publication." }, { "code": "uks_details_mismatch", "type": null, "when": "invalid_request_error: UKS number or name does not match the register." }, { "code": "signatory_not_in_management_organ", "type": null, "when": "requirement_error: the signer is not a recorded member of the organ." }, { "code": "registry_rejected", "type": null, "when": "registry_error: Companies House returned the form." } ] } }, "Params_uk_uk_establishment_register": { "type": "object", "properties": { "overseas_company_name": { "type": "string", "description": "Exactly as in the constitution, with punctuation." }, "legal_form": { "type": "string", "description": "Say whether limited, and private or public." }, "country_of_incorporation": { "type": "string", "description": "ISO 3166 country." }, "governing_law": { "type": "string", "description": "Law of incorporation." }, "credit_or_financial_institution": { "type": "boolean", "description": "B2." }, "parent_law_accounts": { "type": "object", "description": "{required, period_from 'dd/mm', period_to 'dd/mm', disclosure_months}.", "examples": [ "{\"required\":false}" ] }, "home_office_address": { "$ref": "#/components/schemas/Address", "description": "Principal place of business or registered office, if not in the constitution." }, "establishment_name": { "type": "string", "description": "Establishment name; business name rules apply." }, "establishment_address": { "$ref": "#/components/schemas/Address", "description": "Physical address; no PO Box, DX or LP number." }, "opening_date": { "type": "string", "format": "date", "description": "Cannot be in the future; registration due within one month." }, "business_description": { "type": "string", "description": "Business carried on." }, "directors": { "type": "array", "items": {}, "description": "Every director: {person_id, authority: limited|unlimited, acts: alone|jointly, jointly_with[]}; each needs a personal code.", "examples": [ "[{\"person_id\":\"per_test_d1\",\"authority\":\"unlimited\",\"acts\":\"alone\"}]" ] }, "permanent_representatives": { "type": "array", "items": {}, "description": "At least one individual: {person_id, service_address, authority fields}.", "examples": [ "[{\"person_id\":\"per_test_pr1\",\"authority\":\"unlimited\",\"acts\":\"alone\"}]" ] }, "person_authorised_to_accept_service": { "type": "object", "description": "{person_id or entity_id, service_address}; omit if none." }, "authenticating": { "type": "string", "pattern": "^per_", "description": "Director, secretary or permanent representative; printed name only." } }, "required": [ "overseas_company_name", "legal_form", "country_of_incorporation", "governing_law", "credit_or_financial_institution", "parent_law_accounts", "establishment_name", "establishment_address", "opening_date", "business_description", "directors", "permanent_representatives", "authenticating" ], "description": "Registers a branch of an overseas company on form OS IN01 with a certified constitution, directors' personal codes and a permanent representative. Creates a uk_establishment entity; due within one month of opening." }, "Create_uk_uk_establishment_register": { "type": "object", "properties": { "type": { "const": "uk.uk_establishment.register" }, "params": { "$ref": "#/components/schemas/Params_uk_uk_establishment_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a UK establishment of an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Governing body resolution opening the establishment and appointing representatives", "source": "generated", "required": true }, { "key": "certified_constitution", "title": "Certified constitution", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified English translation, if needed", "source": "uploaded", "required": false }, { "key": "latest_accounts", "title": "Latest disclosed accounts, if parent law requires them", "source": "uploaded", "required": false }, { "key": "registry_extract", "title": "Home registry extract within 3 months", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership chart to individual beneficial owners", "source": "uploaded", "required": true }, { "key": "application_os_in01", "title": "Completed form OS IN01", "source": "generated", "required": true }, { "key": "registration_confirmation", "title": "Registrar's confirmation with the UK establishment number", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "other", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_os_in01", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_constitution", "signer_role": "authorised_representative", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS IN01", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "director_not_verified", "type": null, "when": "A director has no personal code." }, { "code": "certified_constitution_missing", "type": null, "when": "No certified constitution." }, { "code": "opening_date_in_future", "type": null, "when": "opening_date is after today." }, { "code": "entity_not_eligible", "type": null, "when": "Partnership, LP, unincorporated body or government agency." }, { "code": "permanent_representative_missing", "type": null, "when": "None given." } ] } }, "Params_uk_ukeig_alternative_name_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the establishment is registered." }, "grouping": { "type": "object", "description": "{number, name, member_state} exactly as on the register." }, "proposed_alternative_name": { "type": "string", "description": "Treated as the grouping name for UK law once registered (reg 12A)." }, "replaces_alternative_name": { "type": "string", "description": "The earlier alternative name being replaced." }, "name_approval_document_id": { "type": "string", "pattern": "^doc_", "description": "Response from the department consulted; required if the name has sensitive or restricted words." }, "signing": { "type": "string", "pattern": "^per_", "description": "A member or manager who signs." } }, "required": [ "registration_jurisdiction", "grouping", "proposed_alternative_name", "signing" ], "description": "Registers a name, other than its registered name, under which an EEIG with an official address outside the UK will trade in the UK. Form EE NM01 registers the first alternative name; EE NM02 replaces an earlier one." }, "Create_uk_ukeig_alternative_name_register": { "type": "object", "properties": { "type": { "const": "uk.ukeig_alternative_name.register" }, "params": { "$ref": "#/components/schemas/Params_uk_ukeig_alternative_name_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an alternative name of an EEIG's UK establishment", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ee_nm_form", "title": "Form EE NM01 or EE NM02", "source": "generated", "required": true }, { "key": "name_approval", "title": "Response on a sensitive name", "source": "uploaded", "required": false }, { "key": "registration_confirmation", "title": "Registrar's confirmation of the alternative name", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ee_nm_form", "signer_role": "member", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies, office for the establishment", "form": "Form EE NM01", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "establishment_not_registered", "type": null, "when": "requirement_error: no registered UK establishment under reg 12." }, { "code": "name_unavailable", "type": null, "when": "requirement_error: duplicates a registered name or is restricted." }, { "code": "sensitive_name_approval_missing", "type": null, "when": "requirement_error: sensitive words and no approval attached." }, { "code": "ukeig_not_applicable", "type": null, "when": "invalid_request_error: a UKEIG changes its name with form EE MP01." } ] } }, "Params_uk_ukeig_establishment_register": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Part of the UK where the establishment is; decides the Companies House office." }, "grouping": { "type": "object", "description": "{name, official_address: address, member_state, foreign_register}." }, "foreign_company": { "type": "object", "description": "{address: address, established_date}." }, "contract_document_id": { "type": "string", "pattern": "^doc_", "description": "Certified copy of the contract establishing the grouping." }, "translation_document_id": { "type": "string", "pattern": "^doc_", "description": "Certified English translation; required if the contract is not in English." }, "objects": { "type": "string", "description": "Objects of the grouping." }, "duration": { "type": "string", "description": "Duration; 'indefinite' if none is fixed." }, "members": { "type": "array", "items": {}, "description": "Objects: individual {kind, title, forenames, surname, legal_form, service_address} or corporate {kind, name, registered_in, registration_number." }, "managers": { "type": "array", "items": {}, "description": "Array of person_ref for the managers." }, "authenticating_member": { "type": "string", "pattern": "^per_", "description": "Member who authenticates the form with a printed name." } }, "required": [ "registration_jurisdiction", "grouping", "foreign_company", "contract_document_id", "objects", "duration", "members", "authenticating_member" ], "description": "Registers the UK establishment of a European economic interest grouping whose official address is outside the UK. Entiva completes form EE FM02, attaches a certified copy of the contract, has a member authenticate it, and posts it with." }, "Create_uk_ukeig_establishment_register": { "type": "object", "properties": { "type": { "const": "uk.ukeig_establishment.register" }, "params": { "$ref": "#/components/schemas/Params_uk_ukeig_establishment_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a UK establishment of an EEIG whose official address is outside the UK", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "grouping_contract_certified_copy", "title": "Certified copy of the grouping contract", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified English translation of the contract and other filed documents", "source": "uploaded", "required": false }, { "key": "foreign_registry_extract", "title": "Foreign register extract showing the grouping and official address", "source": "uploaded", "required": true }, { "key": "ee_fm02_form", "title": "Form EE FM02", "source": "generated", "required": true }, { "key": "registration_confirmation", "title": "Registrar's confirmation of the registered establishment", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ee_fm02_form", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies: Cardiff, Edinburgh or Belfast", "form": "Form EE FM02 with certified contract", "channel": "paper", "government_fee": { "amount": 124, "currency": "GBP" } }, "entiva_fee_basis": "free", "errors": [ { "code": "uk_official_address_not_allowed", "type": null, "when": "invalid_request_error: the official address is in the UK; this form cannot register a UKEIG." }, { "code": "establishment_already_registered", "type": null, "when": "requirement_error: already registered (reg 12)." }, { "code": "contract_not_certified", "type": null, "when": "requirement_error: contract copy not certified, or translation missing." }, { "code": "filing_deadline_passed", "type": null, "when": "requirement_error: more than one month since established_date; Entiva can file but records the offence risk." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the registrar returned the form." } ] } }, "Params_uk_ukeig_establishment_change_notify": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the establishment reported is situated." }, "grouping": { "type": "object", "description": "{number, name, member_state} as on the register." }, "change_type": { "type": "string", "enum": [ "establishment_set_up", "establishment_closed" ], "description": "Box 3: an additional establishment set up, or one closed." }, "establishment_address": { "$ref": "#/components/schemas/Address", "description": "Address of the establishment set up or closed." }, "event_date": { "type": "string", "format": "date", "description": "Date of the event; the 30-day deadline runs from it." }, "correspondence_address": { "$ref": "#/components/schemas/Address", "description": "Optional UK address for correspondence when more than one UK establishment will remain." }, "signing": { "type": "string", "pattern": "^per_", "description": "A member or manager who signs." } }, "required": [ "registration_jurisdiction", "grouping", "change_type", "establishment_address", "event_date", "signing" ], "description": "Tells the registrar that an EEIG whose official address is outside the UK has set up an additional UK establishment or closed one (Council Regulation 2137/85 Arts 7, 10; EEIG Regulations 1989 reg 13). A member or manager signs form EE." }, "Create_uk_ukeig_establishment_change_notify": { "type": "object", "properties": { "type": { "const": "uk.ukeig_establishment_change.notify" }, "params": { "$ref": "#/components/schemas/Params_uk_ukeig_establishment_change_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the setting up or closure of an EEIG establishment in the UK", "x-entiva": { "jurisdiction": "uk", "stage": "restructuring", "applies_to": [ "ukeig" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ee_mp02_form", "title": "Form EE MP02", "source": "generated", "required": true }, { "key": "registration_confirmation", "title": "Registrar's confirmation that the register is updated", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ee_mp02_form", "signer_role": "member", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Companies, office for the establishment", "form": "Form EE MP02", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "included", "errors": [ { "code": "establishment_not_registered", "type": null, "when": "requirement_error: no registered UK establishment; use uk.ukeig.register_establishment." }, { "code": "ukeig_closure_not_allowed", "type": null, "when": "invalid_request_error: a UKEIG is closed with EE MP01 and the liquidation forms." }, { "code": "filing_deadline_passed", "type": null, "when": "requirement_error: more than 30 days since the event; Entiva can file but records the offence risk." } ] } }, "Params_uk_administrative_restoration_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where registered; decides which Crown representative gives the waiver.", "examples": [ "england_wales" ] }, "company_number": { "type": "string", "description": "Registered number; RT01 needs number and name to match.", "examples": [ "09876543" ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution.", "examples": [ "2024-02-13" ] }, "dissolution_basis": { "type": "string", "enum": [ "s1000_defunct", "s1001_defunct_liquidation_notice", "s1002A_false_basis", "registered_office_regulation_22", "s1003_voluntary", "other" ], "description": "How it was struck off.", "examples": [ "s1000_defunct" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "The former director or member who applies and makes the statement of compliance.", "examples": [ "per_1Q8xPa1eMw5U" ] }, "applicant_capacity": { "type": "string", "enum": [ "former_director", "former_member" ], "description": "Capacity held at or before dissolution; an LLP allows only former_member.", "examples": [ "former_director" ] }, "trading_evidence": { "type": "array", "items": {}, "description": "document_ref[] showing the company was trading or in operation when struck off.", "examples": [ "[\"doc_1Q8xPb2fNx6V\"]" ] }, "bona_vacantia": { "type": "object", "description": "{property_vested, crown_representative?: treasury_solicitor|duchy_of_lancaster|duchy_of_cornwall|kltr_scotland|crown_solicitor_ni, waiver_letter?.", "examples": [ "{\"property_vested\":true,\"crown_representative\":\"treasury_solicitor\",\"waiver_letter\":\"doc_1Q8xPb3gOy7W\",\"costs_paid\":true}" ] }, "catch_up_filings": { "type": "array", "items": {}, "description": "act_ ids of the actions filing every outstanding account and confirmation statement up to dissolution, with fees.", "examples": [ "[\"act_1Q8xPc4hPz8X\",\"act_1Q8xPc5iQa9Y\"]" ] }, "outstanding_penalties": { "type": "object", "description": "{section_453_penalties_paid, relevant_person_fines_paid, amount_confirmed_by_companies_house?: money}.", "examples": [ "{\"section_453_penalties_paid\":true,\"relevant_person_fines_paid\":true,\"amount_confirmed_by_companies_house\":{\"amount\":75000,\"currency\":\"GBP\"}}" ] }, "directors_after_restoration": { "type": "array", "items": {}, "description": "person_ref[] of directors on restoration; their fines are checked and they need identity verification.", "examples": [ "[\"per_1Q8xPa1eMw5U\"]" ] }, "alternative_name": { "type": "string", "description": "Name to use if the former name is unavailable; otherwise the registered number is the name and must be changed within 14 days.", "examples": [ "Harbour Lane Studios (UK) Ltd" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office for AD01, required if the default Companies House address was in use at strike-off; it must be appropriate, with evidence.", "examples": [ "{\"line1\":\"14 Quay Street\",\"city\":\"Bristol\",\"postal_code\":\"BS1 4XY\",\"country\":\"GB\"}" ] } }, "required": [ "entity_type", "registration_jurisdiction", "company_number", "dissolution_date", "dissolution_basis", "applicant", "applicant_capacity", "bona_vacantia", "catch_up_filings", "outstanding_penalties" ], "description": "Applies to the Registrar under CA 2006 s1024 to restore a company or LLP the Registrar struck off, where the applicant is a former director, the application arrives within 6 years of dissolution and the company was trading when struck off.." }, "Create_uk_administrative_restoration_apply": { "type": "object", "properties": { "type": { "const": "uk.administrative_restoration.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_administrative_restoration_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off company or LLP administratively", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "rt01_application", "title": "RT01 or LL RT01 with statement of compliance", "source": "generated", "required": true }, { "key": "evidence_of_standing", "title": "Proof the applicant was a director or member", "source": "uploaded", "required": true }, { "key": "trading_evidence", "title": "Evidence of trading or operation at strike-off", "source": "uploaded", "required": false }, { "key": "bvc14_application", "title": "Application for a bona vacantia waiver letter", "source": "generated", "required": false }, { "key": "bona_vacantia_waiver_letter", "title": "Crown representative's written consent", "source": "uploaded", "required": false }, { "key": "outstanding_accounts_and_statements", "title": "Every outstanding account and confirmation statement, with fees", "source": "generated", "required": true }, { "key": "penalty_payment_confirmations", "title": "Proof that s453 penalties and relevant-person fines are paid", "source": "uploaded", "required": false }, { "key": "ad01_notice", "title": "AD01 change of registered office with evidence the address is appropriate", "source": "generated", "required": false }, { "key": "em01_notice", "title": "EM01 change of registered email address", "source": "generated", "required": false }, { "key": "restoration_decision_letter", "title": "Registrar's decision; restoration takes effect from the date it is sent", "source": "registry_issued", "required": true }, { "key": "gazette_restoration_notice", "title": "Gazette notice of restoration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "rt01_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bvc14_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "RT01", "channel": "paper", "government_fee": { "amount": 341, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "voluntary_strike_off_not_restorable", "type": "requirement_error", "when": "dissolution_basis is s1003_voluntary or other; use uk.court_restoration.apply." }, { "code": "six_year_limit_expired", "type": "requirement_error", "when": "Dissolved over 6 years ago, or will be before the package reaches the Registrar." }, { "code": "applicant_not_former_officer", "type": "requirement_error", "when": "The records do not show the applicant as a former director in the capacity claimed." }, { "code": "trading_not_evidenced", "type": "requirement_error", "when": "No evidence the company was trading or in operation at strike-off." }, { "code": "bona_vacantia_consent_missing", "type": "requirement_error", "when": "Property vested and there is no waiver letter, or Crown costs are unpaid (s1025-)." }, { "code": "records_not_up_to_date", "type": "requirement_error", "when": "catch_up_filings leaves an account or confirmation statement outstanding." }, { "code": "penalties_unpaid", "type": "requirement_error", "when": "s453 penalties or relevant-person fines remain unpaid (s1025-)." }, { "code": "restoration_refused", "type": "registry_error", "when": "The Registrar refused; Entiva offers uk.court_restoration.apply, which must start within 28 days of the decision notice." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_charitable_company_close": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "charitable_company" ], "description": "Always charitable_company.", "examples": [ "charitable_company" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered and so which charity regulator applies.", "examples": [ "england_wales" ] }, "charity_registration_number": { "type": "string", "description": "Registered charity number.", "examples": [ "1198765" ] }, "route": { "type": "string", "enum": [ "strike_off", "liquidation" ], "description": "strike_off: Companies House voluntary strike-off then the regulator. liquidation: close through uk.creditors_voluntary_liquidation.start or the members'.", "examples": [ "strike_off" ] }, "liquidation_action_id": { "type": "string", "description": "Required when route is liquidation: act_ id of the liquidation action." }, "closure_reason": { "type": "string", "description": "Why the charity is closing, recorded in the trustees' minutes and given to the regulator.", "examples": [ "Charitable purposes fulfilled; no further funds to be raised" ] }, "decision_date": { "type": "string", "format": "date", "description": "Date the trustees decided to close.", "examples": [ "2026-10-08" ] }, "trustees_deciding": { "type": "array", "items": {}, "description": "person_ref values for the trustees, who are the company's directors.", "examples": [ "[\"per_6Bt3NgWk\", \"per_1Xr9LyEd\", \"per_8Mq4ZvCa\"]" ] }, "assets_value_at_decision": { "$ref": "#/components/schemas/Money", "description": "Value of the charity's assets when the decision to close was made, in minor units.", "examples": [ "{\"amount\": 1850000, \"currency\": \"GBP\"}" ] }, "asset_recipients": { "type": "array", "items": {}, "description": "Charities that received assets." }, "has_permanent_endowment": { "type": "boolean", "description": "True if the charity holds permanent endowment; it must be dealt with before closing.", "examples": [ "false" ] }, "has_designated_land": { "type": "boolean", "description": "True if it holds designated land.", "examples": [ "false" ] }, "has_special_trusts": { "type": "boolean", "description": "True if it is trustee of special trusts.", "examples": [ "false" ] }, "endowment_transfer_details": { "type": "string", "description": "Required if any of the three flags above is true: receiving charities and confirmation they hold on the same trusts." }, "governing_document_requires_regulator_consent": { "type": "boolean", "description": "True if the governing document says the charity regulator must consent to winding up.", "examples": [ "false" ] }, "regulator_consent_reference": { "type": "string", "description": "OSCR's consent reference, or the Commission's consent reference where the governing document requires it." }, "strike_off_eligibility": { "type": "object", "description": "Required when route is strike_off: {no_trading_or_stock_sale_in_3_months, no_name_change_in_3_months, not_threatened_with_liquidation, no_creditor_agreements}.", "examples": [ "{\"no_trading_or_stock_sale_in_3_months\": true, \"no_name_change_in_3_months\": true, \"not_threatened_with_liquidation\": true, \"no_creditor_agreements\": true}" ] }, "hmrc_registered_charity": { "type": "boolean", "description": "True if the charity is registered with HMRC; adds a task to tell HMRC it has closed.", "examples": [ "true" ] } }, "required": [ "entity_type", "registration_jurisdiction", "charity_registration_number", "route", "closure_reason", "decision_date", "trustees_deciding", "assets_value_at_decision", "has_permanent_endowment", "has_designated_land", "has_special_trusts", "governing_document_requires_regulator_consent", "hmrc_registered_charity" ], "description": "A charitable company closes under company law first and then tells its charity regulator: the Charity Commission in England and Wales, OSCR in Scotland or the Charity Commission for Northern Ireland." }, "Create_uk_charitable_company_close": { "type": "object", "properties": { "type": { "const": "uk.charitable_company.close" }, "params": { "$ref": "#/components/schemas/Params_uk_charitable_company_close" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Close a charitable company: strike off or liquidate, then notify the charity regulator", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustee_decision_minutes", "title": "Trustees' minutes deciding to close", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution", "source": "generated", "required": false }, { "key": "ds01_application", "title": "Application to strike off", "source": "generated", "required": false }, { "key": "s1006_notice_copies", "title": "Copies of the application for members, employees, creditors, directors and pension trustees", "source": "generated", "required": false }, { "key": "proof_of_s1006_delivery", "title": "Proof the s1006 copies were delivered", "source": "uploaded", "required": false }, { "key": "regulator_consent", "title": "Charity regulator consent", "source": "uploaded", "required": false }, { "key": "asset_transfer_evidence", "title": "Evidence of asset transfers", "source": "uploaded", "required": false }, { "key": "regulator_closure_notification", "title": "Notification to the charity regulator", "source": "generated", "required": true }, { "key": "companies_house_dissolution_notice", "title": "Gazette notice of dissolution", "source": "registry_issued", "required": true }, { "key": "regulator_removal_confirmation", "title": "Charity regulator removal confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "trustee_decision_minutes", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ds01_application", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "regulator_closure_notification", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "DS01 voluntary strike-off", "channel": "online", "government_fee": { "amount": 13, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "strike_off_ineligible", "type": null, "when": "[requirement_error] The company traded or sold stock in the last 3 months, changed its name, is threatened with liquidation or has an arrangement with creditors." }, { "code": "regulator_consent_missing", "type": null, "when": "[requirement_error] registration_jurisdiction is scotland and no OSCR consent reference was given, or the governing document requires regulator consent that has not been obtained." }, { "code": "endowment_unresolved", "type": null, "when": "[requirement_error] Permanent endowment, designated land or special trusts have not been dealt with; the charity cannot close until they are." }, { "code": "liquidation_not_complete", "type": null, "when": "[requirement_error] route is liquidation and the linked liquidation action has not dissolved the company, so the regulator notice is held." }, { "code": "s1006_notices_missing", "type": null, "when": "[requirement_error] Proof is missing that the 7-day copies of the DS01 were given to everyone s1006 lists." }, { "code": "company_still_registered", "type": null, "when": "[invalid_request_error] The regulator notification was requested before the company was removed from the register." }, { "code": "nhs_charity_excluded", "type": null, "when": "[jurisdiction_error] NHS charities cannot use the Charity Commission's online closure service." } ] } }, "Params_uk_cio_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cio" ], "description": "Always cio.", "examples": [ "cio" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "description": "Always england_wales.", "examples": [ "england_wales" ] }, "charity_registration_number": { "type": "string", "description": "Registered charity number.", "examples": [ "1212121" ] }, "dissolution_resolution_method": { "type": "string", "enum": [ "general_meeting_75_percent", "general_meeting_no_dissent", "unanimous_written" ], "description": "How the members passed the dissolution resolution (CIO Regulations 2012 reg 6): 75% of those voting at a general meeting; a decision without a vote and without.", "examples": [ "general_meeting_75_percent" ] }, "dissolution_resolution_date": { "type": "string", "format": "date", "description": "Date the resolution was passed.", "examples": [ "2026-10-12" ] }, "short_notice_agreed": { "type": "boolean", "description": "True if the meeting was held on shorter notice because a qualifying majority agreed (reg 6).", "examples": [ "false" ] }, "foundation_cio": { "type": "boolean", "description": "True for a foundation CIO, where the trustees are the only members.", "examples": [ "false" ] }, "trustees_applying": { "type": "array", "items": {}, "description": "person_ref values for the charity trustees making the application.", "examples": [ "[\"per_6Bt3NgWk\", \"per_1Xr9LyEd\", \"per_8Mq4ZvCa\"]" ] }, "all_debts_settled_declaration": { "type": "boolean", "description": "Declaration by or for the trustees that any debts and liabilities have been settled or provided for in full (reg 5).", "examples": [ "true" ] }, "asset_application_statement": { "type": "string", "description": "Statement of how any property has been or is to be applied on dissolution in line with the constitution (reg 5).", "examples": [ "Remaining funds of £4,120 transferred to Riverside Community Trust (charity 1098765) under clause 14 of the constitution" ] }, "assets_value_at_decision": { "$ref": "#/components/schemas/Money", "description": "Value of the charity's assets when the decision to close was made, in minor units.", "examples": [ "{\"amount\": 412000, \"currency\": \"GBP\"}" ] }, "asset_recipients": { "type": "array", "items": {}, "description": "Charities that received assets." }, "has_permanent_endowment": { "type": "boolean", "description": "True if the CIO holds permanent endowment.", "examples": [ "false" ] }, "has_designated_land": { "type": "boolean", "description": "True if the CIO holds designated land.", "examples": [ "false" ] }, "has_special_trusts": { "type": "boolean", "description": "True if the CIO is trustee of special trusts.", "examples": [ "false" ] }, "endowment_transfer_details": { "type": "string", "description": "Required if any of the three flags above is true: receiving charity names and numbers and confirmation they hold on the same trusts." }, "specific_purpose_funds_handled": { "type": "string", "description": "How grants or appeal funds for specific purposes were dealt with, if any.", "examples": [ "No restricted funds held" ] }, "has_linked_charities": { "type": "boolean", "description": "True if the CIO has linked charities; ending the link needs a separate application to the Commission.", "examples": [ "false" ] }, "no_liquidator_acting_confirmed": { "type": "boolean", "description": "Confirms no liquidator is acting for the CIO.", "examples": [ "true" ] }, "acting_for_majority_of_trustees_confirmed": { "type": "boolean", "description": "Confirms the applicant acts for the trustees or a majority of them.", "examples": [ "true" ] }, "constitution_procedure_followed_confirmed": { "type": "boolean", "description": "Confirms the exact procedure in the constitution was followed.", "examples": [ "true" ] }, "notice_delivery_method": { "type": "string", "enum": [ "post", "hand_delivery" ], "description": "How the 7-day notice reaches members, employees and non-applying trustees.", "examples": [ "post" ] }, "hmrc_registered_charity": { "type": "boolean", "description": "True if the charity is registered with HMRC; Entiva then adds a task to tell HMRC it has closed.", "examples": [ "true" ] } }, "required": [ "entity_type", "registration_jurisdiction", "charity_registration_number", "dissolution_resolution_method", "dissolution_resolution_date", "trustees_applying", "all_debts_settled_declaration", "asset_application_statement", "assets_value_at_decision", "has_permanent_endowment", "has_designated_land", "has_special_trusts", "has_linked_charities", "no_liquidator_acting_confirmed", "acting_for_majority_of_trustees_confirmed", "constitution_procedure_followed_confirmed", "notice_delivery_method", "hmrc_registered_charity" ], "description": "Trustees decide to close, members pass the dissolution resolution, the trustees declare debts settled and say how the assets are applied, and the Charity Commission is applied to on its online closure form. Trustees give notice within 7." }, "Create_uk_cio_dissolve": { "type": "object", "properties": { "type": { "const": "uk.cio.dissolve" }, "params": { "$ref": "#/components/schemas/Params_uk_cio_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a charitable incorporated organisation through the Charity Commission", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "cio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustee_decision_minutes", "title": "Trustees' minutes deciding to close", "source": "generated", "required": true }, { "key": "meeting_notice", "title": "Notice of general meeting", "source": "generated", "required": false }, { "key": "dissolution_resolution", "title": "Members' dissolution resolution", "source": "generated", "required": true }, { "key": "trustee_declaration", "title": "Trustees' declaration on debts and assets", "source": "generated", "required": true }, { "key": "closure_form_data", "title": "Answers for the Commission's online closure form", "source": "generated", "required": true }, { "key": "application_notice", "title": "Notice of application for dissolution", "source": "generated", "required": true }, { "key": "proof_of_notice_delivery", "title": "Proof that the notice was delivered", "source": "uploaded", "required": true }, { "key": "asset_transfer_evidence", "title": "Evidence of asset transfers", "source": "uploaded", "required": false }, { "key": "commission_removal_notice", "title": "Charity Commission notice of removal", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "trustee_decision_minutes", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dissolution_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "trustee_declaration", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "closure_form_data", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Charity Commission for England and Wales", "form": "Online charity closure form", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "cio_england_wales_only", "type": null, "when": "[jurisdiction_error] registration_jurisdiction is not england_wales; Scottish charitable incorporated organisations are SCIOs." }, { "code": "nhs_charity_excluded", "type": null, "when": "[jurisdiction_error] The charity is an NHS charity, which the Commission's online closure service does not accept." }, { "code": "resolution_invalid", "type": null, "when": "[requirement_error] The resolution lacks 75% of those voting, was passed on less than 14 days' notice without a qualifying majority waiving it, or a written resolution was not." }, { "code": "liquidator_or_administrator_appointed", "type": null, "when": "[requirement_error] A liquidator, administrator, receiver or moratorium is in place, or a winding-up petition has been presented; the application cannot be made or must be." }, { "code": "debts_not_settled", "type": null, "when": "[requirement_error] The trustees have not declared that debts and liabilities are settled or provided for in full, or a decision the constitution requires has not been taken (reg." }, { "code": "endowment_unresolved", "type": null, "when": "[requirement_error] Permanent endowment, designated land or special trusts have not been dealt with; the charity cannot close until they are." }, { "code": "notice_not_delivered", "type": null, "when": "[requirement_error] Proof is missing that the 7-day notices were delivered by hand or post; email does not count." }, { "code": "application_withdrawal_required", "type": null, "when": "[invalid_request_error] The CIO received property, an administrator was appointed or a petition was presented after applying; the application must be withdrawn or updated." } ] } }, "Params_uk_compulsory_liquidation_petition": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type to be wound up.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company is registered.", "examples": [ "england_wales" ] }, "grounds": { "type": "array", "items": {}, "description": "Grounds relied on, from: special_resolution (IA 1986 s122) and unable_to_pay_debts (s122). gov.uk describes both as conditions for a director's petition, so.", "examples": [ "[\"special_resolution\", \"unable_to_pay_debts\"]" ] }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the members passed the special resolution that the company be wound up by the court.", "examples": [ "2026-10-19" ] }, "unpaid_debts_total": { "$ref": "#/components/schemas/Money", "description": "Total debts the company cannot pay, in minor units. gov.uk says £750 or more.", "examples": [ "{\"amount\": 6840000, \"currency\": \"GBP\"}" ] }, "inability_to_pay_basis": { "type": "string", "enum": [ "statutory_demand", "unsatisfied_execution", "cash_flow", "balance_sheet", "scottish_charge_expired", "ni_certificate_of_unenforceability" ], "description": "How inability to pay is shown: an unpaid statutory demand, an unsatisfied execution, cash-flow insolvency, or balance-sheet insolvency.", "examples": [ "cash_flow" ] }, "share_capital": { "type": "object", "description": "Required for companies with share capital: {issued_shares, share_classes, aggregate_nominal_value, paid_up}." }, "nature_of_business": { "type": "string", "description": "Nature of the company's business, if known (IR 2016 r7.5).", "examples": [ "Software consultancy" ] }, "hearing_centre": { "type": "string", "description": "County court hearing centre." }, "proceedings_type": { "type": "string", "enum": [ "comi_proceedings", "establishment_proceedings", "not_eu_regulation_proceedings" ], "description": "Whether the proceedings are COMI proceedings, establishment proceedings or proceedings to which the EU Regulation as it has effect in UK law does not apply.", "examples": [ "comi_proceedings" ] }, "proceedings_type_reasons": { "type": "string", "description": "Reasons for the proceedings type, written into the witness statement.", "examples": [ "Registered office and principal place of business are in London; all management is in England" ] }, "article_1_2_undertaking": { "type": "boolean", "description": "Whether the company is an Article 1.2 undertaking.", "examples": [ "false" ] }, "moratorium_in_force": { "type": "boolean", "description": "Whether a Part A1 moratorium is in force.", "examples": [ "false" ] }, "directors": { "type": "array", "items": {}, "description": "person_ref values for the directors who authorise the petition.", "examples": [ "[\"per_5Tq8NwXc\"]" ] }, "evidence_of_debts": { "type": "string", "pattern": "^doc_", "description": "Uploaded schedule of creditors and the debts due, with any statutory demand or judgment.", "examples": [ "doc_2Gk8PsVa" ] }, "representation": { "type": "string", "enum": [ "partner_solicitor", "director_attends" ], "description": "Who attends the hearing.", "examples": [ "partner_solicitor" ] } }, "required": [ "entity_type", "registration_jurisdiction", "grounds", "special_resolution_date", "unpaid_debts_total", "nature_of_business", "proceedings_type", "proceedings_type_reasons", "article_1_2_undertaking", "moratorium_in_force", "directors", "evidence_of_debts" ], "description": "The company, acting through its directors and backed by a members' special resolution, presents its own winding-up petition. Entiva solicitor files Comp 1 and Comp 2 with the court, gives Gazette notice, files the certificate of." }, "Create_uk_compulsory_liquidation_petition": { "type": "object", "properties": { "type": { "const": "uk.compulsory_liquidation.petition" }, "params": { "$ref": "#/components/schemas/Params_uk_compulsory_liquidation_petition" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Petition the court to wind up the company", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "board_decision", "title": "Directors' decision to present the petition", "source": "generated", "required": true }, { "key": "members_special_resolution", "title": "Special resolution that the company be wound up by the court", "source": "generated", "required": true }, { "key": "evidence_of_debts", "title": "Schedule of debts and creditors", "source": "uploaded", "required": true }, { "key": "winding_up_petition", "title": "Winding-up petition", "source": "generated", "required": true }, { "key": "petition_confirmation", "title": "Confirmation of petition details", "source": "generated", "required": true }, { "key": "proceedings_witness_statement", "title": "Witness statement on the type of proceedings", "source": "generated", "required": true }, { "key": "certificate_of_service", "title": "Certificate of service", "source": "generated", "required": false }, { "key": "gazette_notice_petition", "title": "Gazette notice of the petition", "source": "generated", "required": true }, { "key": "certificate_of_compliance", "title": "Certificate of compliance with rules 7.9 and 7.10", "source": "generated", "required": true }, { "key": "sealed_petition", "title": "Court-sealed petition with hearing date", "source": "registry_issued", "required": true }, { "key": "winding_up_order", "title": "Winding-up order", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "director", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_decision", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_special_resolution", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "winding_up_petition", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_compliance", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HM Courts and Tribunals Service: the High Court", "form": "Comp 1 winding-up petition with Comp 2 and the members' winding-up resolution", "channel": "both", "government_fee": { "amount": 2880, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "special_resolution_required", "type": null, "when": "[requirement_error] The members' special resolution has not reached 75% or has not been signed, and no other ground is accepted by Entiva's flow." }, { "code": "debts_below_threshold", "type": null, "when": "[requirement_error] unpaid_debts_total is below £750, the figure gov.uk gives for a director's petition." }, { "code": "court_mismatch", "type": null, "when": "[invalid_request_error] hearing_centre was given but the High Court has sole jurisdiction (registered office in the London insolvency district, IA 1986 s117) or paid-up capital is." }, { "code": "moratorium_in_force", "type": null, "when": "[requirement_error] A Part A1 moratorium is in force; the petition needs the extra statements and the monitor's details (IR 2016 r7.5)." }, { "code": "winding_up_already_in_progress", "type": null, "when": "[invalid_request_error] The entity is already in liquidation or administration, or another petition is open." }, { "code": "gazette_notice_too_late", "type": null, "when": "[invalid_request_error] The hearing date leaves fewer than 7 business days for the Gazette notice; the court may dismiss the petition (r7.10)." }, { "code": "certificate_of_compliance_late", "type": null, "when": "[invalid_request_error] Less than 5 business days remain before the hearing (r7.12)." }, { "code": "scotland_ni_manual_route", "type": null, "when": "[jurisdiction_error] registration_jurisdiction is scotland or northern_ireland: the action tracks milestones only and the partner solicitor files off-platform." } ] } }, "Params_uk_court_restoration_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type; LLPs by SI 2009/1804 reg 57.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Decides court and procedure: England and Wales, Scotland, Northern Ireland.", "examples": [ "england_wales" ] }, "company_number": { "type": "string", "description": "Registered number.", "examples": [ "09876543" ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution; Entiva computes the 6-year limit from it.", "examples": [ "2022-06-21" ] }, "dissolution_basis": { "type": "string", "enum": [ "s1000_or_s1001_defunct", "s1002A_false_basis", "s1003_voluntary", "post_winding_up_dissolution", "post_administration_dissolution", "registered_office_regulation_22" ], "description": "How the company left the register.", "examples": [ "s1003_voluntary" ] }, "why_not_administrative": { "type": "string", "enum": [ "voluntary_strike_off", "not_trading_at_strike_off", "outside_six_years", "refused_by_registrar", "personal_injury_claim", "post_insolvency_dissolution", "other" ], "description": "Why the administrative route is not used; Entiva blocks the court route if the cheaper one is open.", "examples": [ "voluntary_strike_off" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "The applicant.", "examples": [ "per_1Q8xQa1fNx6V" ] }, "applicant_category": { "type": "string", "enum": [ "secretary_of_state", "former_director", "land_interest_holder", "property_rights_holder", "prospective_contractual_party", "potential_claimant", "pension_fund_manager_or_trustee", "former_member_or_personal_representative", "creditor", "former_liquidator", "notifiable_party_in_voluntary_strike_off", "other_interested_person" ], "description": "The s1029 category giving standing; other_interested_person relies on the court accepting an interest.", "examples": [ "creditor" ] }, "purpose": { "type": "string", "description": "Why restoration is needed; goes into the evidence.", "examples": [ "Recover GBP 48,200 owed under a 2018 supply contract." ] }, "grounds": { "type": "array", "items": {}, "description": "Grounds (s1031): carrying_on_business_at_strike_off, registrar_lacked_reasonable_cause, strike_off_requirements_not_complied_with, just_to_restore.", "examples": [ "[\"strike_off_requirements_not_complied_with\",\"just_to_restore\"]" ] }, "time_limit_basis": { "type": "string", "enum": [ "within_six_years", "personal_injury_claim_any_time", "within_28_days_of_registrar_refusal" ], "description": "Why the application is in time: six years from dissolution; a personal injury claim; or 28 days from the Registrar's refusal.", "examples": [ "within_six_years" ] }, "registrar_refusal_date": { "type": "string", "format": "date", "description": "Date of the refusal notice, if applicable.", "examples": [ "2026-10-02" ] }, "bona_vacantia": { "type": "object", "description": "{property_vested, no_objection_letter?: document_ref}.", "examples": [ "{\"property_vested\":true,\"no_objection_letter\":\"doc_1Q8xQb2gOy7W\"}" ] }, "restoration_name": { "type": "string", "description": "Name to restore under if the former name is unavailable.", "examples": [ "Harbour Lane Studios (UK) Ltd" ] }, "directions_sought": { "type": "array", "items": {}, "description": "put_everyone_in_pre_dissolution_position (s1032), deliver_documents_to_registrar, registrar_costs, crown_representative_costs (s1032).", "examples": [ "[\"put_everyone_in_pre_dissolution_position\",\"deliver_documents_to_registrar\"]" ] } }, "required": [ "entity_type", "registration_jurisdiction", "company_number", "dissolution_date", "dissolution_basis", "why_not_administrative", "applicant", "applicant_category", "purpose", "grounds", "time_limit_basis", "bona_vacantia" ], "description": "Applies to the court under CA 2006 s1029 for an order restoring a company or LLP. Used when administrative restoration is unavailable or was refused." }, "Create_uk_court_restoration_apply": { "type": "object", "properties": { "type": { "const": "uk.court_restoration.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_court_restoration_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the court to restore a dissolved company or LLP", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "court_application", "title": "Part 8 claim form N208, petition or originating summons", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Witness statement with statement of truth, affidavit or facts in the petition: service.", "source": "generated", "required": true }, { "key": "evidence_of_interest", "title": "Proof of the applicant's interest: contract, invoices, judgment, officer record, land title", "source": "uploaded", "required": true }, { "key": "bv_no_objection_letter", "title": "Bona vacantia solicitor's written non-objection", "source": "uploaded", "required": false }, { "key": "service_record", "title": "Proof of service on the Registrar and on the Treasury Solicitor, Lord Advocate or Crown Solicitor.", "source": "generated", "required": true }, { "key": "court_order", "title": "Sealed order restoring the company", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "witness", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "court_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "supporting_evidence", "signer_role": "witness", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_evidence", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "The court", "form": "Part 8 claim form N208 with evidence", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "administrative_route_available", "type": "requirement_error", "when": "Struck off under s1000, s1001 or s1002A within 6 years and apparently trading: set why_not_administrative or use the administrative route." }, { "code": "time_limit_expired", "type": "requirement_error", "when": "Over 6 years since dissolution and neither the personal injury exception nor the 28-day window applies." }, { "code": "standing_not_shown", "type": "requirement_error", "when": "The applicant has no s1029 category and no interest the court is likely to accept." }, { "code": "bona_vacantia_no_objection_missing", "type": "requirement_error", "when": "E&W: property vested and there is no written non-objection from the Treasury Solicitor." }, { "code": "registrar_notice_not_served", "type": "requirement_error", "when": "The Registrar has not had the minimum notice of the hearing." }, { "code": "court_refused", "type": "registry_error", "when": "The court dismissed or adjourned the application; the response carries the order and costs." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_court_restoration_order_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type of the dissolved company.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Decides sealed or certified copy.", "examples": [ "england_wales" ] }, "court_order": { "type": "string", "pattern": "^doc_", "description": "The sealed order.", "examples": [ "doc_1Q8xRa1hQa9Y" ] }, "order_date": { "type": "string", "format": "date", "description": "Date of the order.", "examples": [ "2026-12-04" ] }, "court_application_action_id": { "type": "string", "description": "act_ id of uk.court_restoration.apply, if Entiva ran the case.", "examples": [ "act_1Q8xQc3hPz8X" ] }, "restoration_name": { "type": "string", "description": "Name in the order where the former name was unavailable; if none, the registered number becomes the name.", "examples": [ "Harbour Lane Studios (UK) Ltd" ] }, "filings_directed": { "type": "array", "items": {}, "description": "Documents the order directs the company to deliver (s1032): {description, due_date}.", "examples": [ "[{\"description\":\"Accounts for the year ended 30 June 2022\",\"due_date\":\"2027-01-04\"}]" ] } }, "required": [ "entity_type", "registration_jurisdiction", "court_order", "order_date" ], "description": "Delivers the court's restoration order to the Registrar. Restoration takes effect when a copy of the order is delivered and the Registrar gazettes it." }, "Create_uk_court_restoration_order_register": { "type": "object", "properties": { "type": { "const": "uk.court_restoration_order.register" }, "params": { "$ref": "#/components/schemas/Params_uk_court_restoration_order_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deliver a court restoration order to Companies House", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "court_order", "title": "Sealed copy of the court order", "source": "uploaded", "required": true }, { "key": "covering_letter", "title": "Covering letter to the Registrar", "source": "generated", "required": true }, { "key": "name_change_resolution", "title": "Directors' resolution and notice if restored under the registered number", "source": "generated", "required": false }, { "key": "gazette_restoration_notice", "title": "Gazette notice of restoration", "source": "registry_issued", "required": true }, { "key": "registry_confirmation", "title": "Companies House record showing the company restored", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "registry_idv" } ], "approvals": [], "signatures": [ { "document_key": "covering_letter", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "name_change_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Copy of the court order", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "order_not_sealed", "type": "requirement_error", "when": "The order is not sealed by the court." }, { "code": "order_not_a_restoration_order", "type": "requirement_error", "when": "The order does not restore the company under s1031." }, { "code": "restoration_name_unavailable", "type": "requirement_error", "when": "The name cannot be registered and the order names no alternative; the company will take its number as name and must change it within 14 days." }, { "code": "entity_not_dissolved", "type": "invalid_request_error", "when": "The entity is still on the register." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_creditors_voluntary_liquidation_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type being wound up.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company or LLP is registered.", "examples": [ "england_wales" ] }, "reason_for_winding_up": { "type": "string", "description": "Why the company or LLP cannot pay its debts.", "examples": [ "Largest customer insolvent; unable to meet HMRC and trade creditors" ] }, "ceased_trading_on": { "type": "string", "format": "date", "description": "Date trading stopped, if it has.", "examples": [ "2026-09-30" ] }, "statement_of_affairs_date": { "type": "string", "format": "date", "description": "Date the statement of affairs speaks as of.", "examples": [ "2026-10-20" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members pass the resolution for voluntary winding up.", "examples": [ "2026-10-26" ] }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How the members resolve.", "examples": [ "written_resolution" ] }, "qualifying_floating_charge_holders": { "type": "array", "items": {}, "description": "Holders of a qualifying floating charge (IA 1986 s84).", "examples": [ "[]" ] }, "liquidator_nomination": { "type": "string", "enum": [ "entiva_partner", "customer_nominated" ], "description": "Who the company nominates as liquidator.", "examples": [ "entiva_partner" ] }, "customer_nominated_liquidator": { "type": "object", "description": "Required when liquidator_nomination is customer_nominated: {name, ip_number, firm, email}." }, "creditors_decision_procedure": { "type": "string", "enum": [ "deemed_consent", "virtual_meeting", "physical_meeting" ], "description": "How creditors decide on the liquidator.", "examples": [ "deemed_consent" ] }, "creditors_decision_date": { "type": "string", "format": "date", "description": "Decision date.", "examples": [ "2026-10-30" ] }, "directors": { "type": "array", "items": {}, "description": "person_ref values for the directors who will verify the statement of affairs.", "examples": [ "[\"per_5Tq8NwXc\"]" ] }, "creditors_list": { "type": "string", "pattern": "^doc_", "description": "Uploaded list of every creditor with address, amount owed, security held and date security was given (IA 1986 s99).", "examples": [ "doc_3Hs7LmPz" ] }, "assets_and_liabilities_schedule": { "type": "string", "pattern": "^doc_", "description": "Uploaded schedule of assets, debts and liabilities, including contingent and prospective liabilities.", "examples": [ "doc_9Bn2KdRv" ] }, "estimated_assets_value": { "$ref": "#/components/schemas/Money", "description": "Estimated total realisable value of assets, in minor units.", "examples": [ "{\"amount\": 1850000, \"currency\": \"GBP\"}" ] }, "estimated_liabilities": { "$ref": "#/components/schemas/Money", "description": "Total liabilities including contingent and prospective, in minor units.", "examples": [ "{\"amount\": 14230000, \"currency\": \"GBP\"}" ] }, "employee_count": { "type": "integer", "description": "Employees at the date of the resolution.", "examples": [ "0" ] }, "has_secured_creditors": { "type": "boolean", "description": "True if any creditor holds a fixed or floating charge.", "examples": [ "false" ] }, "charity_registration_number": { "type": "string", "description": "Required when entity_type is charitable_company: the Charity Commission, OSCR or CCNI registration number, used to notify the regulator." } }, "required": [ "entity_type", "registration_jurisdiction", "reason_for_winding_up", "statement_of_affairs_date", "resolution_date", "resolution_method", "creditors_decision_procedure", "creditors_decision_date", "directors", "creditors_list", "assets_and_liabilities_schedule", "estimated_assets_value", "estimated_liabilities", "employee_count", "has_secured_creditors" ], "description": "Directors propose the winding up, members pass the resolution, the directors verify a statement of affairs, creditors decide on the liquidator and a licensed insolvency practitioner is appointed, who files with Companies House and The." }, "Create_uk_creditors_voluntary_liquidation_commence": { "type": "object", "properties": { "type": { "const": "uk.creditors_voluntary_liquidation.commence" }, "params": { "$ref": "#/components/schemas/Params_uk_creditors_voluntary_liquidation_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Start a creditors' voluntary liquidation", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "board_decision", "title": "Directors' decision to propose winding up", "source": "generated", "required": true }, { "key": "winding_up_resolution", "title": "Resolution for voluntary winding up", "source": "generated", "required": true }, { "key": "floating_charge_holder_notice", "title": "Notice to qualifying floating charge holder", "source": "generated", "required": false }, { "key": "statement_of_affairs", "title": "Statement of affairs", "source": "generated", "required": true }, { "key": "creditors_list", "title": "List of creditors", "source": "uploaded", "required": true }, { "key": "assets_and_liabilities_schedule", "title": "Schedule of assets, debts and liabilities", "source": "uploaded", "required": true }, { "key": "creditors_decision_notice", "title": "Notice seeking creditors' decision on the liquidator", "source": "generated", "required": true }, { "key": "liquidator_consent_to_act", "title": "Liquidator's consent to act", "source": "generated", "required": true }, { "key": "liquidator_appointment_notice", "title": "Notice of appointment of liquidator", "source": "generated", "required": true }, { "key": "gazette_notice_resolution", "title": "Gazette notice of the winding-up resolution", "source": "generated", "required": true }, { "key": "gazette_notice_appointment", "title": "Gazette notice of the liquidator's appointment", "source": "generated", "required": true }, { "key": "companies_house_acceptance", "title": "Companies House acceptance of the filings", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "none" }, { "role": "director", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_decision", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "winding_up_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "winding_up_resolution", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "statement_of_affairs", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "statement_of_affairs", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "statement_of_affairs", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "liquidator_appointment_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "Copy of the special resolution", "channel": "online", "government_fee": { "amount": 96.55, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "company_appears_solvent", "type": null, "when": "[requirement_error] estimated_assets_value exceeds estimated_liabilities and the directors have not confirmed insolvency; a members' voluntary liquidation is the route for a." }, { "code": "winding_up_already_in_progress", "type": null, "when": "[invalid_request_error] The entity is already in liquidation or administration, or a compulsory winding-up petition is open." }, { "code": "floating_charge_notice_missing", "type": null, "when": "[requirement_error] A qualifying floating charge holder has not had 5 business days' written notice and has not consented in writing (IA 1986 s84-)." }, { "code": "resolution_threshold_not_met", "type": null, "when": "[requirement_error] A written resolution has less than 75% of total voting rights, or a meeting vote is below 75%." }, { "code": "statement_of_affairs_date_invalid", "type": null, "when": "[invalid_request_error] statement_of_affairs_date is more than 14 days before resolution_date (England and Wales, IR 2016 r6.3)." }, { "code": "creditors_decision_date_invalid", "type": null, "when": "[invalid_request_error] creditors_decision_date is earlier than 3 business days after the notice or later than 14 days after the resolution (IR 2016 r6.14)." }, { "code": "creditor_objection_threshold_reached", "type": null, "when": "[requirement_error] Creditors holding 10% in value object to deemed consent, so no decision is made and a meeting is required (IA 1986 s246ZF; IR 2016 r6.14)." }, { "code": "liquidator_unavailable", "type": null, "when": "[jurisdiction_error] No partner insolvency practitioner can accept the nomination for this registration_jurisdiction and entity_type; supply customer_nominated_liquidator." }, { "code": "charity_registration_missing", "type": null, "when": "[invalid_request_error] entity_type is charitable_company and charity_registration_number was not given." } ] } }, "Params_uk_creditors_voluntary_liquidation_complete": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "description": "Entity type in liquidation.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the company or LLP is registered.", "examples": [ "england_wales" ] }, "liquidation_action_id": { "type": "string", "description": "act_ id of the uk.creditors_voluntary_liquidation.start action, if the liquidation was started through Entiva.", "examples": [ "act_1QxP7mBk2Lw" ] }, "final_account": { "type": "string", "pattern": "^doc_", "description": "The liquidator's final account showing how the winding up was conducted and the company's property disposed of (IA 1986 s106; content per IR 2016 r18.14).", "examples": [ "doc_6Wc4NxQd" ] }, "final_account_made_up_on": { "type": "string", "format": "date", "description": "Date the account was made up once the affairs were fully wound up.", "examples": [ "2027-04-12" ] }, "account_delivered_on": { "type": "string", "format": "date", "description": "Date a copy of the account, with the notice on release rights, was delivered to members and to creditors other than opted-out creditors.", "examples": [ "2027-04-20" ] }, "creditor_objected_to_release": { "type": "boolean", "description": "Set by the liquidator after the objection period: whether any creditor objected to the liquidator's release.", "examples": [ "false" ] } }, "required": [ "entity_type", "registration_jurisdiction", "final_account", "final_account_made_up_on", "account_delivered_on" ], "description": "When the affairs are fully wound up the liquidator makes up the final account, sends it to members and creditors, waits out the creditors' objection period and files it with the registrar, which dissolves the company 3 months after." }, "Create_uk_creditors_voluntary_liquidation_complete": { "type": "object", "properties": { "type": { "const": "uk.creditors_voluntary_liquidation.complete" }, "params": { "$ref": "#/components/schemas/Params_uk_creditors_voluntary_liquidation_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Conclude a creditors' voluntary liquidation: final account and dissolution", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "charitable_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "final_account", "title": "Liquidator's final account", "source": "uploaded", "required": true }, { "key": "release_rights_notice", "title": "Notice to creditors on objection to the liquidator's release", "source": "generated", "required": true }, { "key": "liq14_notice", "title": "Notice of final account prior to dissolution in CVL", "source": "generated", "required": true }, { "key": "companies_house_acceptance", "title": "Companies House registration of the final account", "source": "registry_issued", "required": true }, { "key": "dissolution_record", "title": "Companies House record of dissolution", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "final_account", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "liq14_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LIQ14 notice of final account prior to dissolution in CVL, with a copy of the account and ", "channel": "online", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "liquidation_not_open", "type": null, "when": "[invalid_request_error] The entity is not in creditors' voluntary liquidation or has no appointed liquidator." }, { "code": "affairs_not_fully_wound_up", "type": null, "when": "[requirement_error] The liquidator has not confirmed that all assets are realised and distributed and all claims dealt with." }, { "code": "objection_period_running", "type": null, "when": "[requirement_error] The creditors' objection period has not ended, or a request or court application about remuneration is undetermined, so filing is held (IR 2016 r6.28)." }, { "code": "final_account_deadline_missed", "type": null, "when": "[invalid_request_error] The account was not filed within the 7-day period after the objection period; the liquidator commits an offence (IA 1986 s106) and the response lists the." }, { "code": "members_voluntary_liquidation_required", "type": null, "when": "[invalid_request_error] The entity is in a members' voluntary liquidation; its final account is a different filing." } ] } }, "Params_uk_general_partnership_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "general_partnership", "scottish_qualifying_partnership" ], "description": "general_partnership, or scottish_qualifying_partnership.", "examples": [ "general_partnership" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Law the partnership is governed by.", "examples": [ "england_wales" ] }, "dissolution_basis": { "type": "string", "enum": [ "term_expired", "venture_completed", "notice_by_partner", "partners_agreement", "death_bankruptcy_or_charge", "illegality", "court_order" ], "description": "Why the partnership is dissolved.", "examples": [ "partners_agreement" ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date the partnership is dissolved.", "examples": [ "2026-09-30" ] }, "trading_ceased_on": { "type": "string", "format": "date", "description": "Date the partnership's trade ceased.", "examples": [ "2026-09-30" ] }, "business_continues": { "type": "boolean", "description": "Must be false.", "examples": [ "false" ] }, "partners": { "type": "array", "items": {}, "description": "person_ref values for every partner, including corporate partners.", "examples": [ "[\"per_2Lf6RkUd\", \"per_9Wn3ZcYt\"]" ] }, "nominated_partner": { "type": "string", "pattern": "^per_", "description": "per_ id of the partner HMRC knows as the nominated partner, who approves the final SA800.", "examples": [ "per_2Lf6RkUd" ] }, "partnership_utr": { "type": "string", "description": "The partnership's 10-digit Unique Taxpayer Reference, used on the SA800.", "examples": [ "1234567890" ] }, "final_return_tax_year": { "type": "string", "description": "Tax year of the final partnership return.", "examples": [ "2026-27" ] }, "winding_up_status": { "type": "string", "enum": [ "complete", "in_progress" ], "description": "Whether the partnership's property has been applied and its debts settled.", "examples": [ "complete" ] }, "final_accounts": { "type": "string", "pattern": "^doc_", "description": "Uploaded partnership accounts and profit allocation to the cessation date, used for the SA800.", "examples": [ "doc_4Pj9XeMb" ] }, "partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "Uploaded partnership agreement, if there is a written one." }, "court_order": { "type": "string", "pattern": "^doc_", "description": "Required when dissolution_basis is court_order." }, "vat_registered": { "type": "boolean", "description": "True creates a child uk.vat_registration.cancel action.", "examples": [ "true" ] }, "vat_registration_number": { "type": "string", "description": "Required when vat_registered is true.", "examples": [ "GB234567890" ] }, "paye_registered": { "type": "boolean", "description": "True creates a child uk.paye_scheme.close action.", "examples": [ "false" ] }, "notify_hmrc_individual_partners": { "type": "boolean", "description": "Default true.", "examples": [ "true" ] }, "publish_gazette_notice": { "type": "boolean", "description": "Default false.", "examples": [ "true" ] }, "sqp_registered_number": { "type": "string", "description": "Required when entity_type is scottish_qualifying_partnership: the Companies House registered number." } }, "required": [ "entity_type", "registration_jurisdiction", "dissolution_basis", "dissolution_date", "trading_ceased_on", "business_continues", "partners", "nominated_partner", "partnership_utr", "final_return_tax_year", "winding_up_status", "final_accounts", "vat_registered", "paye_registered" ], "description": "Records the dissolution under the partnership agreement or the Partnership Act 1890, has the nominated partner approve and Entiva file the final SA800 partnership return, tells HMRC each partner has stopped, optionally advertises the." }, "Create_uk_general_partnership_dissolve": { "type": "object", "properties": { "type": { "const": "uk.general_partnership.dissolve" }, "params": { "$ref": "#/components/schemas/Params_uk_general_partnership_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a general partnership and close its HMRC registrations", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "general_partnership", "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "dissolution_instrument", "title": "Dissolution agreement or notice of dissolution", "source": "generated", "required": true }, { "key": "final_accounts", "title": "Final partnership accounts", "source": "uploaded", "required": true }, { "key": "court_order", "title": "Court order dissolving the partnership", "source": "uploaded", "required": false }, { "key": "hmrc_agent_authorisation", "title": "HMRC agent authorisation", "source": "generated", "required": true }, { "key": "sa800_final_return", "title": "Final Partnership Tax Return", "source": "generated", "required": true }, { "key": "gazette_notice_dissolution", "title": "Gazette notice of dissolution", "source": "generated", "required": false }, { "key": "hmrc_final_return_receipt", "title": "HMRC receipt for the final SA800", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dissolution_instrument", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "hmrc_agent_authorisation", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sa800_final_return", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sa800_final_return", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "Final SA800 Partnership Tax Return", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "business_continues", "type": null, "when": "[invalid_request_error] business_continues is true; a change of partners is not a dissolution and is not a closure action." }, { "code": "sqp_requires_scotland", "type": null, "when": "[jurisdiction_error] entity_type is scottish_qualifying_partnership and registration_jurisdiction is not scotland." }, { "code": "partners_incomplete", "type": null, "when": "[requirement_error] The partners listed do not match the partnership record, or a partner has no verification at the level the role needs." }, { "code": "nominated_partner_missing", "type": null, "when": "[requirement_error] No partner is recorded as the nominated partner with HMRC." }, { "code": "court_order_required", "type": null, "when": "[requirement_error] dissolution_basis is court_order and no court order was uploaded." }, { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] HMRC has not yet recorded the partnership's or a partner's authorisation of Entiva for Self Assessment." }, { "code": "final_return_overdue", "type": null, "when": "[requirement_error] The final SA800 deadline has passed; late-filing penalties apply and Entiva files as soon as the nominated partner approves." } ] } }, "Params_uk_limited_partnership_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "pflp", "slp" ], "description": "lp, pflp or slp.", "examples": [ "lp" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where registered; slp is always scotland.", "examples": [ "england_wales" ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution at law; LP6 is due within 7 days of it.", "examples": [ "2026-10-14" ] }, "dissolution_ground": { "type": "string", "enum": [ "term_expired", "event_in_agreement", "partners_agreement", "no_general_partner", "no_limited_partner", "only_insolvent_or_disqualified_general_partners", "court_order", "other" ], "description": "Why it was dissolved.", "examples": [ "partners_agreement" ] }, "winding_up_by": { "type": "string", "enum": [ "general_partners", "limited_partners_appoint_non_partner", "non_partner_appointed", "court_appointed" ], "description": "Who winds up.", "examples": [ "general_partners" ] }, "general_partners": { "type": "array", "items": {}, "description": "person_ref[] of the general partners who sign for the firm and act in the winding up.", "examples": [ "[\"per_1Q8xMa1bCr3G\"]" ] }, "closure_description": { "type": "string", "description": "Text for LP6 section f.", "examples": [ "Partnership dissolved on 14 October 2026 by agreement of all partners" ] }, "final_settlement_confirmed": { "type": "boolean", "description": "General partners confirm creditors are paid or provided for and capital and profits distributed per the agreement and default rules.", "examples": [ "true" ] }, "publish_gazette_notice": { "type": "boolean", "description": "Publish a dissolution notice in the Gazette for the firm's principal place of business; it is notice to people who had not dealt with the firm (Partnership Act.", "examples": [ "true" ] }, "tax_closure_status": { "type": "string", "enum": [ "completed", "handled_by_entiva_action", "not_applicable", "outstanding" ], "description": "State of the final SA800 and HMRC registrations; separate actions.", "examples": [ "handled_by_entiva_action" ] } }, "required": [ "entity_type", "registration_jurisdiction", "dissolution_date", "dissolution_ground", "winding_up_by", "general_partners", "final_settlement_confirmed" ], "description": "Records a limited partnership's dissolution, supports the winding up under the partnership agreement and Partnership Act 1890, and reports the closure to Companies House on LP6, which GOV.UK lists for 'closure'. No in-force route removes a." }, "Create_uk_limited_partnership_dissolve": { "type": "object", "properties": { "type": { "const": "uk.limited_partnership.dissolve" }, "params": { "$ref": "#/components/schemas/Params_uk_limited_partnership_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve and wind up a limited partnership", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "lp", "pflp", "slp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dissolution_evidence", "title": "Evidence of the dissolution event: agreement, notice, expiry of term or court order", "source": "uploaded", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement and amendments", "source": "uploaded", "required": true }, { "key": "lp6_statement", "title": "LP6 statement of change, signed by the firm", "source": "generated", "required": true }, { "key": "final_accounts_and_distribution", "title": "Final accounts and distribution statement", "source": "generated", "required": false }, { "key": "gazette_notice", "title": "Gazette notice of dissolution", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dissolution_evidence", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp6_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gazette_notice", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LP6 'Statement specifying the nature of a change in the limited partnership'", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lp_deregistration_not_in_force", "type": "jurisdiction_error", "when": "A Companies House dissolution notice or deregistration was requested; neither is in force, so Entiva files LP6 and records the dissolution." }, { "code": "registry_notice_not_available_for_pflp", "type": "jurisdiction_error", "when": "pflp: LP6 sections e and f do not apply, so no section reports closure; the action records and winds up without a registry filing." }, { "code": "dissolution_event_not_established", "type": "requirement_error", "when": "The evidence shows no dissolution ground." }, { "code": "no_winding_up_party", "type": "requirement_error", "when": "No solvent, non-disqualified partner can wind up and none is appointed." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_members_voluntary_liquidation_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "examples": [ "england_wales" ] }, "declarants": { "type": "array", "items": {}, "description": "person_ref[] of the directors who make the declaration: all if one or two, a majority if more (s89; NI art 75).", "examples": [ "[\"per_1Q8xNa1cDs4J\",\"per_1Q8xNa2dEt5K\"]" ] }, "declaration_meeting_date": { "type": "string", "format": "date", "description": "Directors' meeting date.", "examples": [ "2026-11-02" ] }, "debt_payment_period_months": { "type": "integer", "description": "Months, at most 12 from the start of the winding up, in which debts and interest at the official rate will be paid in full (s89).", "examples": [ "12" ] }, "assets_liabilities_statement_date": { "type": "string", "format": "date", "description": "Date of the statement of assets and liabilities: the latest practicable date before the declaration (s89).", "examples": [ "2026-10-30" ] }, "estimated_realisable_assets": { "$ref": "#/components/schemas/Money", "description": "Estimated assets at that date; used for the liquidator's risk and fee check.", "examples": [ "{\"amount\":18500000,\"currency\":\"GBP\"}" ] }, "estimated_liabilities": { "$ref": "#/components/schemas/Money", "description": "Estimated liabilities including contingent ones.", "examples": [ "{\"amount\":2100000,\"currency\":\"GBP\"}" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members pass the winding-up special resolution and appoint the liquidator: not before the declaration, within 5 weeks after it.", "examples": [ "2026-11-09" ] }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "general_meeting" ], "description": "Special resolution needs 75%: of total voting rights for a written resolution, of votes cast at a meeting.", "examples": [ "written_resolution" ] }, "liquidator": { "type": "object", "description": "{mode: 'entiva_partner' | 'nominated', person?, ip_number?}.", "examples": [ "{\"mode\":\"entiva_partner\"}" ] }, "qualifying_floating_charge_holders": { "type": "array", "items": {}, "description": "Holders of a qualifying floating charge: {holder_name, notice_sent_date, written_consent_received}.", "examples": [ "[]" ] }, "distribution_plan": { "type": "object", "description": "{in_specie, interim_distribution_expected}.", "examples": [ "{\"in_specie\":false,\"interim_distribution_expected\":true}" ] }, "cic_asset_plan": { "type": "object", "description": "Required for a CIC: {asset_locked_body_name, regulator_consent_reference?}.", "examples": [ "{\"asset_locked_body_name\":\"Riverside Community Trust\"}" ] }, "llp_agreement": { "type": "string", "pattern": "^doc_", "description": "Required for an LLP: the LLP agreement.", "examples": [ "doc_1Q8xNb3fFu6L" ] }, "pending_strike_off_action_id": { "type": "string", "description": "Any pending DS01 must be withdrawn first: winding-up circumstances are a s1009 event.", "examples": [ "act_1Q8xKd0aBvN4" ] } }, "required": [ "entity_type", "registration_jurisdiction", "declarants", "declaration_meeting_date", "debt_payment_period_months", "assets_liabilities_statement_date", "resolution_date", "resolution_method", "liquidator", "qualifying_floating_charge_holders" ], "description": "Starts a solvent winding up under IA 1986 Part IV: the directors swear a statutory declaration of solvency in person, the members pass the 75% winding-up resolution and appoint an authorised insolvency practitioner, and the practitioner." }, "Create_uk_members_voluntary_liquidation_commence": { "type": "object", "properties": { "type": { "const": "uk.members_voluntary_liquidation.commence" }, "params": { "$ref": "#/components/schemas/Params_uk_members_voluntary_liquidation_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Start a members' voluntary liquidation", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "directors_board_minute", "title": "Minute of the directors' meeting: full inquiry into affairs, decision to declare", "source": "generated", "required": true }, { "key": "declaration_of_solvency", "title": "Statutory declaration of solvency, text (form 4.25 in Scotland)", "source": "generated", "required": true }, { "key": "sworn_declaration_of_solvency", "title": "Declaration sworn in ink before a solicitor, notary or commissioner for oaths", "source": "uploaded", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities at the latest practicable date (s89)", "source": "uploaded", "required": true }, { "key": "floating_charge_notice", "title": "Notice to each qualifying floating charge holder, and any consent (s84)", "source": "generated", "required": false }, { "key": "members_resolution_winding_up", "title": "Special resolution to wind up voluntarily (s84)", "source": "generated", "required": true }, { "key": "members_resolution_liquidator", "title": "Resolution appointing the liquidator (s91)", "source": "generated", "required": true }, { "key": "liquidator_statement_and_consent", "title": "Liquidator's statement of qualification and consent to act", "source": "uploaded", "required": true }, { "key": "certificate_of_appointment", "title": "Certificate of appointment by the chair, or a director or secretary for a written resolution", "source": "generated", "required": true }, { "key": "liq01_notice", "title": "LIQ01 notice of declaration of solvency with the declaration and statement attached", "source": "generated", "required": true }, { "key": "form_600ch_notice", "title": "Form 600CH notice of appointment of liquidator", "source": "generated", "required": true }, { "key": "special_resolution_copy", "title": "Copy of the special resolution for the registrar", "source": "generated", "required": true }, { "key": "gazette_notice_resolution", "title": "Gazette notice of the resolution", "source": "registry_issued", "required": true }, { "key": "gazette_notice_appointment", "title": "Gazette notice of the liquidator's appointment", "source": "registry_issued", "required": true }, { "key": "creditor_notice_of_appointment", "title": "Notice of appointment to creditors within 28 days", "source": "generated", "required": false }, { "key": "registry_acknowledgement", "title": "Companies House acknowledgement of the filings", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "beneficial_owner", "verification_level": "registry_idv" }, { "role": "shareholder", "verification_level": "none" }, { "role": "liquidator", "verification_level": "none" }, { "role": "witness", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_board_minute", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "sworn_declaration_of_solvency", "signer_role": "declarant", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "members_resolution_winding_up", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution_liquidator", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_appointment", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liquidator_statement_and_consent", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "liq01_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "form_600ch_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LIQ01", "channel": "both", "government_fee": { "amount": 96.55, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "declaration_out_of_window", "type": "requirement_error", "when": "The declaration is or would be more than 5 weeks before the resolution, or after it; it then has no effect (s89)." }, { "code": "solvency_period_exceeds_12_months", "type": "invalid_request_error", "when": "debt_payment_period_months is above 12." }, { "code": "declarants_not_a_majority", "type": "invalid_request_error", "when": "declarants is not everyone or a majority." }, { "code": "floating_charge_notice_missing", "type": "requirement_error", "when": "A qualifying floating charge holder has had no notice, and neither 5 business days nor written consent has been obtained." }, { "code": "resolution_threshold_not_met", "type": "requirement_error", "when": "Less than 75% support, or the LLP agreement's threshold is not met." }, { "code": "liquidator_not_authorised", "type": "requirement_error", "when": "The liquidator is not an authorised insolvency practitioner, has not consented, or cannot act in this part of the UK." }, { "code": "company_appears_insolvent", "type": "requirement_error", "when": "Checks show the directors could not reasonably hold the s89 opinion (s89 offence)." }, { "code": "strike_off_pending", "type": "requirement_error", "when": "A strike-off application is pending and not withdrawn (s1009)." }, { "code": "statutory_declaration_not_witnessed", "type": "requirement_error", "when": "The declaration has no jurat or was not sworn in the officer's presence." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_members_voluntary_liquidation_complete": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type in liquidation.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "England and Wales uses LIQ13, Scotland LIQ13.", "examples": [ "england_wales" ] }, "proposed_final_account": { "type": "string", "pattern": "^doc_", "description": "The proposed final account sent to members.", "examples": [ "doc_1Q8xNf7jIy1Q" ] }, "members_notice_sent_date": { "type": "string", "format": "date", "description": "Date the r5.9 notice went to members: at least 8 weeks before the delivery date.", "examples": [ "2027-09-20" ] }, "requests_or_applications_outstanding": { "type": "boolean", "description": "True if a member's request or court application about remuneration or expenses is undetermined; the affairs are then not fully wound up.", "examples": [ "false" ] }, "all_members_confirmed_no_request": { "type": "boolean", "description": "True if every member confirmed in writing they will make no request or application; the liquidator may then conclude early.", "examples": [ "false" ] }, "affairs_fully_wound_up_date": { "type": "string", "format": "date", "description": "The latest of: notice period ending with no request, any request determined, any court application determined.", "examples": [ "2027-11-15" ] }, "final_account_date": { "type": "string", "format": "date", "description": "Date the final account is made up; members get it first, the registrar's copy within 14 days of this date.", "examples": [ "2027-11-15" ] }, "final_account": { "type": "string", "pattern": "^doc_", "description": "The final account: how the winding up was conducted and the property disposed of (s94; r18.14).", "examples": [ "doc_1Q8xNf8kJz2R" ] }, "assets_fully_distributed": { "type": "boolean", "description": "All assets realised and distributed or provided for.", "examples": [ "true" ] }, "cic_surplus_evidence": { "type": "string", "pattern": "^doc_", "description": "Required for a CIC: surplus went to the asset-locked body or an approved body.", "examples": [ "doc_1Q8xNf9lKa3S" ] } }, "required": [ "entity_type", "registration_jurisdiction", "proposed_final_account", "members_notice_sent_date", "requests_or_applications_outstanding", "affairs_fully_wound_up_date", "final_account_date", "final_account", "assets_fully_distributed" ], "description": "Ends the liquidation: at least 8 weeks' notice and the proposed final account go to members, the final account is made up when the affairs are fully wound up and sent to members, then to Companies House on LIQ13 within 14 days. The." }, "Create_uk_members_voluntary_liquidation_complete": { "type": "object", "properties": { "type": { "const": "uk.members_voluntary_liquidation.complete" }, "params": { "$ref": "#/components/schemas/Params_uk_members_voluntary_liquidation_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Conclude a members' voluntary liquidation: final account and dissolution", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "rule_5_9_notice", "title": "Notice to members with the proposed final account: 8 weeks' notice, release on filing", "source": "generated", "required": true }, { "key": "proposed_final_account", "title": "Proposed final account", "source": "generated", "required": true }, { "key": "members_written_confirmations", "title": "Members' written confirmations for early conclusion", "source": "uploaded", "required": false }, { "key": "final_account", "title": "Final account of the winding up", "source": "generated", "required": true }, { "key": "members_delivery_record", "title": "Proof the final account reached every member (s94)", "source": "generated", "required": true }, { "key": "liq13_notice", "title": "LIQ13 (LIQ13 in Scotland) with the notice that members received the account", "source": "generated", "required": true }, { "key": "dissolution_confirmation", "title": "Companies House record that the company is dissolved", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "none" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "liq13_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "final_account", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "members_written_confirmations", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LIQ13", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notice_period_too_short", "type": "requirement_error", "when": "Less than 8 weeks since the r5.9 notice and not every member has confirmed in writing." }, { "code": "request_or_application_outstanding", "type": "requirement_error", "when": "A member's request or court application under rr18.9 or 18.34 is undetermined." }, { "code": "assets_not_fully_distributed", "type": "requirement_error", "when": "assets_fully_distributed is false, so the final account cannot be made up." }, { "code": "filing_window_missed", "type": "requirement_error", "when": "More than 14 days since final_account_date; the liquidator is liable to a fine under s94 and Entiva flags it." }, { "code": "company_insolvent", "type": "requirement_error", "when": "The liquidator holds the s95 opinion that debts cannot be paid in the declared period; convert to a creditors' voluntary liquidation." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_members_voluntary_liquidation_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type in liquidation.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales" ], "examples": [ "england_wales" ] }, "period_start": { "type": "string", "format": "date", "description": "First day of the 12-month period.", "examples": [ "2026-11-09" ] }, "period_end": { "type": "string", "format": "date", "description": "Last day of the period; the report is due within 2 months after it.", "examples": [ "2027-11-08" ] }, "receipts_and_payments": { "type": "object", "description": "{receipts, payments, balance_held} as money.", "examples": [ "{\"receipts\":{\"amount\":18200000,\"currency\":\"GBP\"},\"payments\":{\"amount\":900000,\"currency\":\"GBP\"},\"balance_held\":{\"amount\":17300000,\"currency\":\"GBP\"}}" ] }, "distributions": { "$ref": "#/components/schemas/Money", "description": "Total distributed to members in the period.", "examples": [ "{\"amount\":17000000,\"currency\":\"GBP\"}" ] }, "work_remaining": { "type": "string", "description": "What remains to be done.", "examples": [ "Obtain HMRC clearance; pay final distribution." ] } }, "required": [ "entity_type", "registration_jurisdiction", "period_start", "period_end", "receipts_and_payments" ], "description": "The liquidator's progress report for each 12-month period of the winding up, sent to the members and to Companies House on LIQ03 within 2 months after the period ends. Entiva practitioner prepares it; Entiva creates the action about." }, "Create_uk_members_voluntary_liquidation_file": { "type": "object", "properties": { "type": { "const": "uk.members_voluntary_liquidation.file" }, "params": { "$ref": "#/components/schemas/Params_uk_members_voluntary_liquidation_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the liquidator's annual progress report", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "progress_report", "title": "Progress report: appointment, progress, receipts and payments, remuneration and expenses.", "source": "generated", "required": true }, { "key": "liq03_notice", "title": "LIQ03 notice of progress report in voluntary winding up", "source": "generated", "required": true }, { "key": "members_delivery_record", "title": "Proof of delivery to the members", "source": "generated", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "none" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "progress_report", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "liq03_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "LIQ03 with the progress report", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "period_not_aligned", "type": "invalid_request_error", "when": "The period is not 12 months from the appointment or the end of the last period." }, { "code": "report_not_due", "type": "requirement_error", "when": "The period has not ended, or the final-account notice has been sent." }, { "code": "liquidator_not_assigned", "type": "requirement_error", "when": "No appointed liquidator is recorded for the entity." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_overseas_entity_remove": { "type": "object", "properties": { "overseas_entity_id": { "type": "string", "description": "Overseas Entity ID issued on registration.", "examples": [ "OE123456" ] }, "land_jurisdictions": { "type": "array", "items": {}, "description": "Jurisdictions where the entity held registered land.", "examples": [ "[\"england_wales\"]" ] }, "land_disposals": { "type": "array", "items": {}, "description": "Each interest disposed of: {jurisdiction, title_or_property_reference, disposal_date, land_register_updated_on}.", "examples": [ "[{\"jurisdiction\":\"england_wales\",\"title_or_property_reference\":\"BL123456\",\"disposal_date\":\"2026-05-14\",\"land_register_updated_on\":\"2026-06-02\"}]" ] }, "confirm_not_registered_proprietor": { "type": "boolean", "description": "s9 statement: not registered as proprietor of a relevant interest in land anywhere in the UK.", "examples": [ "true" ] }, "update_statements_current": { "type": "boolean", "description": "All update statements due have been delivered; a pending update means refusal.", "examples": [ "true" ] }, "schedule_6_information_filed": { "type": "boolean", "description": "Disposals after 28 Feb 2022 have had their Schedule 6 information delivered; a pending duty means refusal.", "examples": [ "true" ] }, "beneficial_ownership_change_statement": { "type": "string", "enum": [ "none_became_or_ceased", "some_became_or_ceased" ], "description": "s9 statement for the period since registration or the last update: no person became or ceased to be a registrable beneficial owner, or some did.", "examples": [ "none_became_or_ceased" ] }, "former_beneficial_owners": { "type": "array", "items": {}, "description": "When some did: [{person, ceased_on}] with the dates they stopped.", "examples": [ "[{\"person\":\"per_1Q8xLc3pTn8D\",\"ceased_on\":\"2026-05-14\"}]" ] }, "registrable_beneficial_owners": { "type": "array", "items": {}, "description": "Current registrable beneficial owners, person_ref[]; if none, give managing_officers.", "examples": [ "[]" ] }, "managing_officers": { "type": "array", "items": {}, "description": "Directors, managers or secretaries, person_ref[]; required when no beneficial owner is active.", "examples": [ "[\"per_1Q8xLc4qUo9E\"]" ] }, "identification_steps_confirmed": { "type": "boolean", "description": "s9 statement: the entity complied with s12.", "examples": [ "true" ] }, "contact_individual": { "type": "string", "pattern": "^per_", "description": "Individual Companies House may contact (s9); shown in the application.", "examples": [ "per_1Q8xLc4qUo9E" ] }, "authentication_code": { "type": "string", "description": "Write-only.", "examples": [ "A1B2C3" ] } }, "required": [ "overseas_entity_id", "land_jurisdictions", "land_disposals", "confirm_not_registered_proprietor", "update_statements_current", "schedule_6_information_filed", "beneficial_ownership_change_statement", "identification_steps_confirmed", "contact_individual" ], "description": "Applies under ECTEA 2022 s9 for an overseas entity to leave the ROE once it no longer holds registered UK land. Entiva checks all three land registers, update statements and Schedule 6 disposals, has changed or new owners and officers." }, "Create_uk_overseas_entity_remove": { "type": "object", "properties": { "type": { "const": "uk.overseas_entity.remove" }, "params": { "$ref": "#/components/schemas/Params_uk_overseas_entity_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove an overseas entity from the Register of Overseas Entities", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "roe_overseas_entity" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "removal_application", "title": "Removal application data set", "source": "generated", "required": true }, { "key": "land_register_evidence", "title": "Official copies or searches showing the entity is no longer registered proprietor", "source": "uploaded", "required": true }, { "key": "overseas_entity_verification_statement", "title": "Agent's verification checks statement", "source": "generated", "required": false }, { "key": "beneficial_ownership_evidence", "title": "Evidence for new or changed owner and officer details, trust deeds if trustees are involved", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Entity resolution approving removal and naming the authorised and contact individuals", "source": "generated", "required": true }, { "key": "overseas_entity_kyb_pack", "title": "Certificate of incorporation, registry extract under 3 months old, constitution, ownership chart", "source": "uploaded", "required": true }, { "key": "registry_removal_notice", "title": "Registrar's notice of removal and its date", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "removal_application", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "overseas_entity_verification_statement", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House: Register of Overseas Entities", "form": "Application for removal, online", "channel": "online", "government_fee": { "amount": 301, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "land_register_still_lists_entity", "type": "requirement_error", "when": "Entiva's pre-check finds the entity still registered proprietor; filing would lose the GBP 301 fee." }, { "code": "update_statement_overdue", "type": "requirement_error", "when": "An update period ended without the s7 update statement." }, { "code": "schedule_6_information_outstanding", "type": "requirement_error", "when": "A disposal after 28 Feb 2022 has no Schedule 6 information delivered." }, { "code": "protected_information_blocks_removal", "type": "requirement_error", "when": "An owner or officer has protected information or a pending application; the online service cannot be used." }, { "code": "agent_verification_expired", "type": "requirement_error", "when": "Information changed or owners/officers were added and the agent's checks are missing or over 3 months old." }, { "code": "removal_refused", "type": "registry_error", "when": "The Registrar refused; the fee is not refunded." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_paye_scheme_close": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company", "general_partnership", "scottish_qualifying_partnership", "charitable_company", "cio", "scio", "registered_society" ], "description": "Entity type whose PAYE scheme is closed.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered or governed.", "examples": [ "england_wales" ] }, "paye_reference": { "type": "string", "description": "Employer PAYE reference.", "examples": [ "123/AB456" ] }, "accounts_office_reference": { "type": "string", "description": "HMRC Accounts Office reference used for payments and RTI submissions.", "examples": [ "123PA00012345" ] }, "permanent_closure_confirmed": { "type": "boolean", "description": "Must be true.", "examples": [ "true" ] }, "date_scheme_ceased": { "type": "string", "format": "date", "description": "Date the PAYE scheme closed.", "examples": [ "2026-10-16" ] }, "final_pay_date": { "type": "string", "format": "date", "description": "Date of the last payment to employees, which sets the final tax month.", "examples": [ "2026-10-16" ] }, "final_submission_type": { "type": "string", "enum": [ "fps", "eps" ], "description": "Whether the final payroll return is an FPS or an EPS.", "examples": [ "fps" ] }, "employee_count": { "type": "integer", "description": "Employees on the payroll at closure.", "examples": [ "3" ] }, "issue_p45s": { "type": "boolean", "description": "Whether Entiva produces the P45s.", "examples": [ "true" ] }, "has_expenses_and_benefits": { "type": "boolean", "description": "Whether the employer must send expenses and benefits returns.", "examples": [ "false" ] }, "ers_scheme_references": { "type": "array", "items": {}, "description": "References of any Employment Related Securities schemes; closing the PAYE scheme requires telling HMRC about closing each one.", "examples": [ "[]" ] }, "outstanding_paye_nic": { "$ref": "#/components/schemas/Money", "description": "Outstanding PAYE tax and National Insurance to deduct and pay, in minor units.", "examples": [ "{\"amount\": 482150, \"currency\": \"GBP\"}" ] }, "payment_method": { "type": "string", "enum": [ "electronic", "cheque" ], "description": "How the outstanding PAYE and NIC are paid.", "examples": [ "electronic" ] }, "final_payroll_data": { "type": "string", "pattern": "^doc_", "description": "Uploaded final payroll data, or reference a connected payroll through the integration.", "examples": [ "doc_5Yt7MqHc" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "per_ id of the person who approves the final submission.", "examples": [ "per_5Tq8NwXc" ] } }, "required": [ "entity_type", "registration_jurisdiction", "paye_reference", "accounts_office_reference", "permanent_closure_confirmed", "date_scheme_ceased", "final_pay_date", "employee_count", "has_expenses_and_benefits", "outstanding_paye_nic", "payment_method", "final_payroll_data", "signatory" ], "description": "Submits the final Full Payment Submission or Employer Payment Summary marked 'Final submission because scheme ceased' with the date the scheme ceased, issues P45s, sends the expenses and benefits returns, closes any Employment Related." }, "Create_uk_paye_scheme_close": { "type": "object", "properties": { "type": { "const": "uk.paye_scheme.close" }, "params": { "$ref": "#/components/schemas/Params_uk_paye_scheme_close" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Close a PAYE employer scheme on cessation", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company", "general_partnership", "scottish_qualifying_partnership", "charitable_company", "cio", "scio", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "hmrc_agent_authorisation", "title": "HMRC agent authorisation", "source": "generated", "required": true }, { "key": "final_payroll_data", "title": "Final payroll data", "source": "uploaded", "required": true }, { "key": "final_payroll_submission", "title": "Final FPS or EPS", "source": "generated", "required": true }, { "key": "p45_forms", "title": "P45 for each employee", "source": "generated", "required": false }, { "key": "expenses_and_benefits_returns", "title": "Expenses and benefits returns", "source": "generated", "required": false }, { "key": "ers_closure_notice", "title": "Notice closing Employment Related Securities schemes", "source": "generated", "required": false }, { "key": "hmrc_rti_acknowledgement", "title": "HMRC RTI acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "hmrc_agent_authorisation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_payroll_submission", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_payroll_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "Final FPS or EPS with 'Final submission because scheme ceased' and the date scheme ceased", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "date_scheme_ceased_in_future", "type": null, "when": "[invalid_request_error] date_scheme_ceased is after today; HMRC does not accept a future date." }, { "code": "temporary_stop_not_closure", "type": null, "when": "[invalid_request_error] permanent_closure_confirmed is false; the scheme stays open when employing stops for less than a whole tax year." }, { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] HMRC has not yet recorded the client's authorisation of Entiva as PAYE agent." }, { "code": "payroll_data_incomplete", "type": null, "when": "[requirement_error] An employee has no leaving date or the final pay run does not reconcile with outstanding_paye_nic." }, { "code": "ers_scheme_open", "type": null, "when": "[requirement_error] ers_scheme_references lists a scheme that has not been closed with HMRC." }, { "code": "paye_payment_deadline_missed", "type": null, "when": "[requirement_error] Outstanding PAYE and NIC were not paid within 17 days; late payment interest and penalties apply." } ] } }, "Params_uk_registered_society_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_society" ], "description": "Always registered_society.", "examples": [ "registered_society" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "england_wales or scotland.", "examples": [ "scotland" ] }, "society_type": { "type": "string", "enum": [ "co_operative_society", "community_benefit_society" ], "description": "Co-operative society or community benefit society.", "examples": [ "co_operative_society" ] }, "fca_registration_number": { "type": "string", "description": "Society registration number on the FCA Mutuals Public Register.", "examples": [ "2891RS" ] }, "request_context": { "type": "string", "enum": [ "no_or_minimal_assets", "never_traded" ], "description": "Why a cancellation is used instead of a dissolution: the society has no or minimal assets, or it registered but never really started trading.", "examples": [ "never_traded" ] }, "net_assets_after_liabilities": { "$ref": "#/components/schemas/Money", "description": "Assets less liabilities at the request date, in minor units.", "examples": [ "{\"amount\": 0, \"currency\": \"GBP\"}" ] }, "members_agreed_on": { "type": "string", "format": "date", "description": "Date the members agreed to the cancellation following the process in the registered rules.", "examples": [ "2026-10-05" ] }, "members_agreement_process": { "type": "string", "description": "How agreement was reached under the rules.", "examples": [ "Ordinary resolution at a general meeting on 5 October 2026 under rule 28" ] }, "financial_statement": { "type": "string", "pattern": "^doc_", "description": "Uploaded statement of the society's latest financial position.", "examples": [ "doc_8Gt3NvLq" ] }, "annual_returns_up_to_date": { "type": "boolean", "description": "Whether annual returns and accounts are up to date.", "examples": [ "true" ] }, "fsma_permissions_active": { "type": "boolean", "description": "True if the society holds FSMA Part 4A permissions; they must be cancelled first.", "examples": [ "false" ] }, "is_insolvent": { "type": "boolean", "description": "True if the society cannot pay its debts; insolvent societies use an insolvency practitioner.", "examples": [ "false" ] }, "secretary": { "type": "string", "pattern": "^per_", "description": "per_ id of the secretary who signs the request.", "examples": [ "per_5Hd9ZtRw" ] }, "committee_members": { "type": "array", "items": {}, "description": "person_ref values for committee members who sign or approve, if the rules or the form require it." } }, "required": [ "entity_type", "registration_jurisdiction", "society_type", "fca_registration_number", "request_context", "net_assets_after_liabilities", "members_agreed_on", "members_agreement_process", "financial_statement", "annual_returns_up_to_date", "fsma_permissions_active", "is_insolvent", "secretary" ], "description": "A society with no or minimal assets, or one that registered but never traded, asks the FCA to cancel its registration without a full dissolution, using the Request to Cancel form with a financial statement. The FCA advertises the." }, "Create_uk_registered_society_cancel": { "type": "object", "properties": { "type": { "const": "uk.registered_society.cancel" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a registered society's registration on request", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "request_to_cancel", "title": "Request to Cancel", "source": "generated", "required": true }, { "key": "members_agreement_record", "title": "Record of members' agreement", "source": "generated", "required": true }, { "key": "irreversibility_acknowledgement", "title": "Acknowledgement that cancellation cannot be reversed", "source": "generated", "required": true }, { "key": "financial_statement", "title": "Financial statement", "source": "uploaded", "required": true }, { "key": "fca_cancellation_confirmation", "title": "FCA confirmation of cancellation", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "request_to_cancel", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_agreement_record", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "irreversibility_acknowledgement", "signer_role": "company_secretary", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority", "form": "Request to Cancel", "channel": "paper", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "society_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is a credit union, friendly society, building society or Northern Ireland society; their cancellation routes differ and are not covered." }, { "code": "assets_exceed_cancellation_guidance", "type": null, "when": "[requirement_error] net_assets_after_liabilities exceeds £1,000 and the society did not register without trading; the FCA expects an instrument of dissolution unless it agrees." }, { "code": "annual_returns_overdue", "type": null, "when": "[requirement_error] Annual returns or accounts are not up to date, which the FCA expects before cancelling." }, { "code": "fsma_permissions_active", "type": null, "when": "[requirement_error] FSMA Part 4A permissions must be cancelled before the society is cancelled." }, { "code": "society_insolvent", "type": null, "when": "[requirement_error] is_insolvent is true; an insolvency practitioner submits the paperwork under the Insolvency Act 1986 as modified for societies." }, { "code": "irreversibility_not_acknowledged", "type": null, "when": "[requirement_error] The secretary has not acknowledged that cancellation cannot be undone." } ] } }, "Params_uk_registered_society_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "registered_society" ], "description": "Always registered_society.", "examples": [ "registered_society" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland" ], "description": "england_wales or scotland.", "examples": [ "england_wales" ] }, "society_type": { "type": "string", "enum": [ "co_operative_society", "community_benefit_society" ], "description": "Co-operative society or community benefit society.", "examples": [ "community_benefit_society" ] }, "fca_registration_number": { "type": "string", "description": "Society registration number on the FCA Mutuals Public Register.", "examples": [ "34567R" ] }, "approval_method": { "type": "string", "enum": [ "members_75_percent_signatures", "special_resolution_dormant_society" ], "description": "How members approve the instrument (CCBSA 2014 s119): at least 75% of members consent, testified by their signatures; or, for a dormant society that is not a.", "examples": [ "members_75_percent_signatures" ] }, "instrument_date": { "type": "string", "format": "date", "description": "Date of the instrument.", "examples": [ "2026-09-30" ] }, "members_total": { "type": "integer", "description": "Number of members at the instrument date.", "examples": [ "48" ] }, "members_consenting": { "type": "integer", "description": "Members who signed the instrument.", "examples": [ "41" ] }, "first_meeting_date": { "type": "string", "format": "date", "description": "Dormant route: date of the first general meeting (two-thirds of eligible members voting, s120)." }, "second_meeting_date": { "type": "string", "format": "date", "description": "Dormant route: date of the confirming meeting, 14 days to one month after the first; over half of eligible members voting must confirm (s120-)." }, "assets_total": { "$ref": "#/components/schemas/Money", "description": "Assets in detail at the instrument date, in minor units.", "examples": [ "{\"amount\": 1275000, \"currency\": \"GBP\"}" ] }, "liabilities_total": { "$ref": "#/components/schemas/Money", "description": "Liabilities at the instrument date, in minor units.", "examples": [ "{\"amount\": 0, \"currency\": \"GBP\"}" ] }, "creditors_provision": { "type": "string", "description": "Creditors' claims and the provision for paying them (s119).", "examples": [ "No creditors' claims; all trade accounts settled" ] }, "distribution_method": { "type": "string", "enum": [ "per_instrument", "left_to_fca_award" ], "description": "per_instrument: the instrument sets the appropriation or division of funds and property. left_to_fca_award: the instrument leaves it to the award of the FCA or.", "examples": [ "per_instrument" ] }, "distribution_plan": { "type": "string", "description": "Required when distribution_method is per_instrument: who receives what, consistent with the registered rules.", "examples": [ "Surplus funds to Riverside Food Bank, a charity with similar purposes, as rule 31 requires" ] }, "accounts_to_instrument_date": { "type": "string", "pattern": "^doc_", "description": "Uploaded accounts made up to the instrument date.", "examples": [ "doc_1Ep6RwTz" ] }, "latest_annual_return_filed": { "type": "boolean", "description": "Whether the annual return for the last year of account is filed.", "examples": [ "true" ] }, "secretary": { "type": "string", "pattern": "^per_", "description": "per_ id of the society's secretary, who makes the statutory declaration and signs the s126 certificate.", "examples": [ "per_3Rf7NaKp" ] }, "declaring_members": { "type": "array", "items": {}, "description": "Three person_ref values for members who make the statutory declaration with the secretary (s121); two registered-society members if the society consists solely.", "examples": [ "[\"per_6Gt2WqBd\", \"per_9Lx4CmYe\", \"per_2Vh8TsNz\"]" ] }, "fsma_permissions_active": { "type": "boolean", "description": "True if the society holds FSMA Part 4A permissions.", "examples": [ "false" ] }, "is_insolvent": { "type": "boolean", "description": "True if the society cannot pay its debts as they fall due.", "examples": [ "false" ] }, "registered_rules": { "type": "string", "pattern": "^doc_", "description": "Uploaded registered rules, to check who may receive surplus funds." } }, "required": [ "entity_type", "registration_jurisdiction", "society_type", "fca_registration_number", "approval_method", "instrument_date", "members_total", "assets_total", "liabilities_total", "creditors_provision", "distribution_method", "accounts_to_instrument_date", "latest_annual_return_filed", "secretary", "declaring_members", "fsma_permissions_active", "is_insolvent" ], "description": "Members approve an instrument of dissolution that sets out assets, liabilities, creditors' claims and the intended distribution; the secretary and three members make a statutory declaration; the FCA registers the instrument and advertises." }, "Create_uk_registered_society_dissolve": { "type": "object", "properties": { "type": { "const": "uk.registered_society.dissolve" }, "params": { "$ref": "#/components/schemas/Params_uk_registered_society_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a registered society by instrument of dissolution", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "instrument_of_dissolution", "title": "Instrument of dissolution", "source": "generated", "required": true }, { "key": "statutory_declaration", "title": "Statutory declaration of compliance", "source": "generated", "required": true }, { "key": "special_resolution_copy", "title": "Copy special resolution", "source": "generated", "required": false }, { "key": "accounts_to_instrument_date", "title": "Accounts to the instrument date", "source": "uploaded", "required": true }, { "key": "annual_return_ar30", "title": "Latest annual return", "source": "uploaded", "required": false }, { "key": "fca_registration_confirmation", "title": "FCA confirmation of registration and advertisement", "source": "registry_issued", "required": true }, { "key": "section_126_certificate", "title": "Section 126 certificate", "source": "generated", "required": true }, { "key": "fca_cancellation_confirmation", "title": "FCA confirmation of cancellation", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "instrument_of_dissolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statutory_declaration", "signer_role": "company_secretary", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "special_resolution_copy", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "section_126_certificate", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Financial Conduct Authority", "form": "Instrument of Dissolution", "channel": "both", "government_fee": { "amount": null, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "society_type_not_supported", "type": null, "when": "[jurisdiction_error] The entity is a credit union, friendly society, building society or Northern Ireland society; their routes differ and are not covered." }, { "code": "approval_threshold_not_met", "type": null, "when": "[requirement_error] Fewer than 75% of members have consented, or the dormant-society special resolution meetings do not meet s120." }, { "code": "annual_return_missing", "type": null, "when": "[requirement_error] The AR30 for the last year of account is not filed; the FCA will not register the instrument (s121)." }, { "code": "accounts_date_mismatch", "type": null, "when": "[invalid_request_error] The accounts are not made up to instrument_date." }, { "code": "fsma_permissions_active", "type": null, "when": "[requirement_error] FSMA Part 4A permissions must be cancelled before the society is dissolved." }, { "code": "society_insolvent", "type": null, "when": "[requirement_error] is_insolvent is true; the insolvency practitioner, not this action, submits the paperwork under the Insolvency Act 1986 as modified for societies." }, { "code": "declaring_members_incomplete", "type": null, "when": "[requirement_error] The statutory declaration needs the secretary and 3 members." }, { "code": "challenge_window_open", "type": null, "when": "[requirement_error] The s126 certificate was requested before the 3-month challenge window closed or before property was conveyed." } ] } }, "Params_uk_scio_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "scio" ], "description": "Always scio.", "examples": [ "scio" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Always scotland.", "examples": [ "scotland" ] }, "scottish_charity_number": { "type": "string", "description": "Scottish charity number.", "examples": [ "SC123456" ] }, "route": { "type": "string", "enum": [ "solvent", "insolvent" ], "description": "solvent: SSI 2011/237 reg 3. insolvent: reg 4, only if the SCIO owes at least £1,500; the estate is sequestrated and the Accountant in Bankruptcy acts as.", "examples": [ "solvent" ] }, "members_resolution_date": { "type": "string", "format": "date", "description": "Date the members passed the resolution.", "examples": [ "2026-10-14" ] }, "application_date": { "type": "string", "format": "date", "description": "Planned submission date to OSCR.", "examples": [ "2026-10-21" ] }, "resolution_certified_by": { "type": "string", "enum": [ "two_thirds_of_trustees", "one_authorised_trustee" ], "description": "Who certifies the resolution: at least two-thirds of the charity trustees, or one trustee authorised to sign for them (reg 3).", "examples": [ "two_thirds_of_trustees" ] }, "trustees_signing": { "type": "array", "items": {}, "description": "person_ref values for the trustees who certify and sign the declaration.", "examples": [ "[\"per_4Zs8PqTn\", \"per_7Hy2WmLc\", \"per_3Dk5BxRe\"]" ] }, "surplus_asset_recipients": { "type": "array", "items": {}, "description": "Bodies that will receive surplus assets.", "examples": [ "[{\"name\": \"Highland Youth Trust\", \"charity_number\": \"SC098765\", \"purposes_match_confirmed\": true}]" ] }, "assets_total": { "$ref": "#/components/schemas/Money", "description": "Assets at the application date, in minor units.", "examples": [ "{\"amount\": 214000, \"currency\": \"GBP\"}" ] }, "liabilities_total": { "$ref": "#/components/schemas/Money", "description": "Liabilities at the application date, in minor units.", "examples": [ "{\"amount\": 0, \"currency\": \"GBP\"}" ] }, "funds_to_return_to_funders": { "type": "string", "description": "Funds to be returned to a funding body or other body under contract or other terms (reg 3).", "examples": [ "None" ] }, "liability_settlement_proposals": { "type": "string", "description": "How the outstanding liabilities will be met (reg 3).", "examples": [ "No outstanding liabilities" ] }, "known_creditors": { "type": "string", "pattern": "^doc_", "description": "Uploaded list of known creditors.", "examples": [ "doc_7Mv3TcXa" ] }, "constitution": { "type": "string", "pattern": "^doc_", "description": "Uploaded constitution including amendments." }, "aib_fee_payment": { "type": "string", "enum": [ "entiva_pays_at_cost", "customer_pays_aib_directly" ], "description": "Insolvent route only: who pays the debtor application fee to the Accountant in Bankruptcy within 21 days of AiB receiving the application.", "examples": [ "customer_pays_aib_directly" ] } }, "required": [ "entity_type", "registration_jurisdiction", "scottish_charity_number", "route", "members_resolution_date", "application_date", "resolution_certified_by", "trustees_signing", "surplus_asset_recipients", "assets_total", "liabilities_total", "liability_settlement_proposals", "known_creditors" ], "description": "A SCIO applies to OSCR to be removed from the Scottish Charity Register and so dissolved, on the solvent route or the insolvent route. OSCR dissolves it by removing it from the Register." }, "Create_uk_scio_dissolve": { "type": "object", "properties": { "type": { "const": "uk.scio.dissolve" }, "params": { "$ref": "#/components/schemas/Params_uk_scio_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a Scottish charitable incorporated organisation through OSCR", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "scio" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' resolution", "source": "generated", "required": true }, { "key": "oscr_application", "title": "Application to OSCR", "source": "generated", "required": true }, { "key": "proposed_dissolution_statement", "title": "Statement outlining the proposed dissolution", "source": "generated", "required": true }, { "key": "creditor_notification_statement", "title": "Signed statement that known creditors will be notified", "source": "generated", "required": true }, { "key": "constitution", "title": "Constitution", "source": "uploaded", "required": false }, { "key": "register_of_charity_trustees", "title": "Register of charity trustees", "source": "generated", "required": true }, { "key": "declaration_of_solvency", "title": "Declaration of solvency", "source": "generated", "required": false }, { "key": "declaration_of_insolvency", "title": "Declaration of insolvency", "source": "generated", "required": false }, { "key": "notice_of_application_for_dissolution", "title": "Notice of application for dissolution", "source": "generated", "required": true }, { "key": "sequestration_application", "title": "Application to the Accountant in Bankruptcy for sequestration", "source": "generated", "required": false }, { "key": "wind_up_completion_evidence", "title": "Evidence that the SCIO has wound up", "source": "uploaded", "required": false }, { "key": "oscr_decision", "title": "OSCR decision", "source": "registry_issued", "required": true }, { "key": "oscr_removal_confirmation", "title": "Removal from the Scottish Charity Register", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting" }, { "kind": "corporate", "body": "trustees", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "declaration_of_solvency", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "declaration_of_insolvency", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "sequestration_application", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "oscr_application", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "creditor_notification_statement", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "OSCR", "form": "Application for Consent to Dissolve a Solvent SCIO", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "scio_scotland_only", "type": null, "when": "[jurisdiction_error] entity_type is not a SCIO registered in Scotland; use uk.cio.dissolve for England and Wales CIOs." }, { "code": "resolution_out_of_time", "type": null, "when": "[requirement_error] application_date is more than 21 days after members_resolution_date; OSCR cannot process a late application and a new resolution is needed." }, { "code": "recipient_missing_or_unsuitable", "type": null, "when": "[requirement_error] No surplus-asset recipient was named, its purposes do not match the SCIO's, or it is a Third Sector Interface." }, { "code": "trustee_signatures_insufficient", "type": null, "when": "[requirement_error] Fewer than two-thirds of the trustees have signed and no authorised single trustee is named." }, { "code": "insolvent_debts_below_minimum", "type": null, "when": "[invalid_request_error] route is insolvent but liabilities_total is below £1,500; OSCR has no provision to dissolve an apparently insolvent SCIO below that." }, { "code": "oscr_consent_refused", "type": null, "when": "[registry_error] OSCR refused or attached conditions; the SCIO has a right of review." }, { "code": "aib_fee_unpaid", "type": null, "when": "[requirement_error] Insolvent route: the debtor application fee was not paid to AiB within 21 days; AiB must refuse the application." } ] } }, "Params_uk_scottish_qualifying_partnership_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "scottish_qualifying_partnership" ], "description": "Always scottish_qualifying_partnership.", "examples": [ "scottish_qualifying_partnership" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "scotland" ], "description": "Always scotland.", "examples": [ "scotland" ] }, "ceased_to_qualify_on": { "type": "string", "format": "date", "description": "Date the partnership ceased to be a qualifying partnership.", "examples": [ "2026-10-09" ] }, "reason": { "type": "string", "enum": [ "dissolved", "no_longer_meets_qualifying_definition" ], "description": "Why it ceased to qualify.", "examples": [ "dissolved" ] }, "signing_partner": { "type": "string", "pattern": "^per_", "description": "per_ id of the partner who signs SQP3.", "examples": [ "per_7Kc2VbNx" ] }, "evidence_of_cessation": { "type": "string", "pattern": "^doc_", "description": "Uploaded dissolution agreement or other evidence of the date and reason." }, "dissolution_action_id": { "type": "string", "description": "act_ id of the uk.general_partnership.dissolve action that created this child action.", "examples": [ "act_1R2P4tYz9Em" ] } }, "required": [ "entity_type", "registration_jurisdiction", "ceased_to_qualify_on", "reason", "signing_partner" ], "description": "Files form SQP3 with Companies House within 14 days to say a registered Scottish qualifying partnership is no longer a qualifying partnership, for example because it was dissolved. After the notice the partnership owes no further PSC or." }, "Create_uk_scottish_qualifying_partnership_cease": { "type": "object", "properties": { "type": { "const": "uk.scottish_qualifying_partnership.cease" }, "params": { "$ref": "#/components/schemas/Params_uk_scottish_qualifying_partnership_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify Companies House that a Scottish qualifying partnership has ceased", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "scottish_qualifying_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sqp3_notice", "title": "Notice of ceasing to be a Scottish qualifying partnership", "source": "generated", "required": true }, { "key": "evidence_of_cessation", "title": "Evidence of cessation", "source": "uploaded", "required": false }, { "key": "companies_house_acceptance", "title": "Companies House acceptance of SQP3", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "sqp3_notice", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "SQP3 Notice of ceasing to be a Scottish qualifying partnership", "channel": "online", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "partnership_still_qualifying", "type": null, "when": "[invalid_request_error] Entiva's record shows every partner still meets the qualifying definition and the partnership is not dissolved." }, { "code": "sqp3_deadline_passed", "type": null, "when": "[invalid_request_error] More than 14 days have passed since ceased_to_qualify_on; Entiva files at once and records the late delivery." }, { "code": "former_partner_required", "type": null, "when": "[requirement_error] reason is dissolved but signing_partner is not a former partner of the partnership." }, { "code": "sqp_not_registered", "type": null, "when": "[invalid_request_error] The partnership has no Companies House SQP registration to cease." } ] } }, "Params_uk_strike_off_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where registered; decides the registrar and the Gazette.", "examples": [ "england_wales" ] }, "applicants": { "type": "array", "items": {}, "description": "person_ref[] of the directors who will authenticate: the sole director, both if two, a majority if more.", "examples": [ "[\"per_1Q8xKd4mRtV2\",\"per_1Q8xKd9nWz7B\"]" ] }, "eligibility_declaration": { "type": "object", "description": "DS01 section 2 statements, all true: no_name_change_in_3_months, no_trading_in_3_months, no_disposal_for_value_in_3_months, no_other_activity_in_3_months.", "examples": [ "{\"no_name_change_in_3_months\":true,\"no_trading_in_3_months\":true,\"no_disposal_for_value_in_3_months\":true,\"no_other_activity_in_3_months\":true,\"no_s1005_proceedings\":true}" ] }, "interested_parties": { "type": "array", "items": {}, "description": "Everyone entitled to a copy: members, employees, creditors including HMRC, pension fund managers or trustees, non-applicant directors.", "examples": [ "[{\"party_type\":\"creditor\",\"name\":\"HM Revenue & Customs\",\"address\":\"Debt Management, Newcastle upon Tyne\"}]" ] }, "remaining_assets_acknowledged": { "type": "boolean", "description": "Applicants accept that remaining property passes to the Crown as bona vacantia and that director and member liability continues (s1003).", "examples": [ "true" ] }, "cic_asset_transfer": { "type": "object", "description": "Required for a CIC: {asset_locked_body_name, transfer_completed, regulator_consent_reference?}.", "examples": [ "{\"asset_locked_body_name\":\"Riverside Community Trust\",\"transfer_completed\":true}" ] }, "filing_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online is the default; paper is slower and needs wet-ink signatures.", "examples": [ "online" ] } }, "required": [ "entity_type", "registration_jurisdiction", "applicants", "eligibility_declaration", "interested_parties", "remaining_assets_acknowledged" ], "description": "Voluntary strike-off of a solvent, non-trading company, CIC or LLP under CA 2006 s1003. Entiva tests eligibility, prepares DS01 / LL DS01, gets personal authentication from the sole director, both directors or a majority, files it." }, "Create_uk_strike_off_apply": { "type": "object", "properties": { "type": { "const": "uk.strike_off.apply" }, "params": { "$ref": "#/components/schemas/Params_uk_strike_off_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to strike off a company or LLP", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ds01_application", "title": "DS01 or LL DS01 data set", "source": "generated", "required": true }, { "key": "section_1006_notice_copy", "title": "Copy of the application for interested parties", "source": "generated", "required": true }, { "key": "notice_service_record", "title": "Proof of posting or delivery of each copy", "source": "generated", "required": true }, { "key": "cic_asset_transfer_evidence", "title": "CIC only: asset transfer evidence or Regulator consent", "source": "uploaded", "required": false }, { "key": "registry_acknowledgement", "title": "Companies House acknowledgement or rejection", "source": "registry_issued", "required": true }, { "key": "gazette_notice_proposed", "title": "First Gazette notice (s1003)", "source": "registry_issued", "required": true }, { "key": "gazette_notice_dissolution", "title": "Second Gazette notice: struck off and dissolved (s1003-)", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "director", "verification_level": "none" }, { "role": "other", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ds01_application", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ds01_application", "signer_role": "member", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ds01_application", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "section_1006_notice_copy", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "DS01", "channel": "both", "government_fee": { "amount": 13, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "strike_off_not_eligible", "type": "requirement_error", "when": "A declaration is false or data shows a name change, trading, disposal or other activity in the last 3 months." }, { "code": "insolvency_proceedings_pending", "type": "requirement_error", "when": "A s1005 proceeding exists." }, { "code": "applicants_not_a_majority", "type": "invalid_request_error", "when": "applicants is not the sole director, both directors or a majority." }, { "code": "notice_recipients_incomplete", "type": "requirement_error", "when": "A known member or director is missing from interested_parties, or a recipient has no address." }, { "code": "cic_assets_not_transferred", "type": "requirement_error", "when": "CIC assets are not yet with the asset-locked body." }, { "code": "strike_off_already_pending", "type": "invalid_request_error", "when": "The entity already has a pending application." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_strike_off_withdraw": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "description": "Entity type with the pending application.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where registered.", "examples": [ "england_wales" ] }, "strike_off_action_id": { "type": "string", "description": "act_ id of the pending uk.strike_off.apply.", "examples": [ "act_1Q8xKd0aBvN4" ] }, "reason": { "type": "string", "enum": [ "name_changed", "traded_or_carried_on_business", "disposal_for_value_or_other_activity", "compromise_or_arrangement_application", "voluntary_arrangement_proposed", "administration_application_or_appointment", "winding_up_circumstances_arisen", "winding_up_petition_presented", "receiver_or_manager_appointed", "judicial_factor_appointed", "other_s1009_event", "change_of_mind" ], "description": "Why.", "examples": [ "traded_or_carried_on_business" ] }, "event_date": { "type": "string", "format": "date", "description": "Date of the event or decision.", "examples": [ "2026-10-16" ] }, "authorising_person": { "type": "string", "pattern": "^per_", "description": "A director who authenticates.", "examples": [ "per_1Q8xKd4mRtV2" ] }, "filing_channel": { "type": "string", "enum": [ "online", "paper" ], "description": "online is quicker; paper uses DS02 / LL DS02 by post.", "examples": [ "online" ] } }, "required": [ "entity_type", "registration_jurisdiction", "reason", "event_date", "authorising_person" ], "description": "Withdraws a pending strike-off application when the company stops being eligible or the directors change their minds. The duty is 'forthwith', so Entiva treats it as urgent." }, "Create_uk_strike_off_withdraw": { "type": "object", "properties": { "type": { "const": "uk.strike_off.withdraw" }, "params": { "$ref": "#/components/schemas/Params_uk_strike_off_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a strike-off application", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ds02_withdrawal", "title": "DS02 or LL DS02", "source": "generated", "required": true }, { "key": "triggering_event_evidence", "title": "Evidence of the event that ended eligibility", "source": "uploaded", "required": false }, { "key": "registry_acknowledgement", "title": "Companies House acknowledgement of the withdrawal", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" } ], "approvals": [], "signatures": [ { "document_key": "ds02_withdrawal", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ds02_withdrawal", "signer_role": "member", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "DS02", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_pending_strike_off", "type": "invalid_request_error", "when": "No pending application, or strike_off_action_id does not refer to one." }, { "code": "strike_off_already_completed", "type": "registry_error", "when": "The company is already dissolved; use uk.court_restoration.apply." }, { "code": "withdrawal_authentication_missing", "type": "requirement_error", "when": "No director has authenticated yet; the duty to withdraw is still running." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_uk_establishment_close": { "type": "object", "properties": { "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the establishment is registered; decides the registrar's address.", "examples": [ "england_wales" ] }, "overseas_company_number": { "type": "string", "description": "Companies House number of the overseas company; it and its name must match the register.", "examples": [ "FC031234" ] }, "close_all_establishments": { "type": "boolean", "description": "True if every UK establishment is closing.", "examples": [ "false" ] }, "uk_establishments": { "type": "array", "items": {}, "description": "Establishments being closed when close_all_establishments is false: {establishment_number, name}.", "examples": [ "[{\"establishment_number\":\"BR012345\",\"name\":\"Meridian Freight (UK Branch)\"}]" ] }, "closure_date": { "type": "string", "format": "date", "description": "Date of closure.", "examples": [ "2026-09-30" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "Who signs for the overseas company: a director, secretary or permanent representative.", "examples": [ "per_1Q8xLa1wHn5C" ] }, "signatory_capacity": { "type": "string", "enum": [ "director", "secretary", "permanent_representative" ], "description": "Capacity of the signatory.", "examples": [ "director" ] } }, "required": [ "registration_jurisdiction", "overseas_company_number", "close_all_establishments", "closure_date", "signatory", "signatory_capacity" ], "description": "Tells Companies House an overseas company has closed one or more registered UK establishments, as Overseas Companies Regulations 2009 reg 77 requires forthwith. Once registered, the company no longer has to deliver documents for that." }, "Create_uk_uk_establishment_close": { "type": "object", "properties": { "type": { "const": "uk.uk_establishment.close" }, "params": { "$ref": "#/components/schemas/Params_uk_uk_establishment_close" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Close a UK establishment of an overseas company", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "os_ds01_notice", "title": "OS DS01 notice of closure", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Overseas company resolution approving closure and authorising the signatory", "source": "generated", "required": true }, { "key": "overseas_company_kyb_pack", "title": "Certificate of incorporation, registry extract under 3 months old, constitution, ownership chart", "source": "uploaded", "required": true }, { "key": "registry_confirmation", "title": "Companies House register entry showing the closure", "source": "registry_issued", "required": false } ], "people": [ { "role": "other", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "os_ds01_notice", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Companies House", "form": "OS DS01 'Notice of closure of a UK establishment of an overseas company'", "channel": "paper", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "establishment_not_registered", "type": "invalid_request_error", "when": "An establishment number is not registered to this company, or is already closed." }, { "code": "closure_date_in_future", "type": "invalid_request_error", "when": "closure_date is later than today." }, { "code": "signatory_not_authorised", "type": "requirement_error", "when": "The signatory is not a director, secretary or permanent representative, or the office cannot be confirmed." }, { "code": "overseas_company_details_mismatch", "type": "registry_error", "when": "Number or name does not match the register, so the form is returned." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent key tried a step only the person can take." }, { "code": "registry_rejected", "type": "registry_error", "when": "The registry or court rejected or returned the filing; the message carries its reason." } ] } }, "Params_uk_vat_registration_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company", "general_partnership", "scottish_qualifying_partnership", "charitable_company", "cio", "scio", "registered_society" ], "description": "Entity type whose VAT registration is cancelled.", "examples": [ "private_ltd_shares" ] }, "registration_jurisdiction": { "type": "string", "enum": [ "england_wales", "scotland", "northern_ireland" ], "description": "Where the entity is registered or governed.", "examples": [ "england_wales" ] }, "vat_registration_number": { "type": "string", "description": "The entity's VAT registration number.", "examples": [ "GB123456789" ] }, "cancellation_reason": { "type": "string", "enum": [ "stopped_trading", "turnover_below_deregistration_threshold", "stopped_taxable_supplies", "zero_rated_exemption", "legal_status_changed_new_number", "business_sold_number_not_kept", "vat_group_disbanding", "stopped_trading_after_liquidation" ], "description": "Why the registration is ending.", "examples": [ "stopped_trading" ] }, "reason_effective_date": { "type": "string", "format": "date", "description": "When the reason took effect, for example the day trading stopped.", "examples": [ "2026-09-30" ] }, "requested_cancellation_date": { "type": "string", "format": "date", "description": "The date to ask HMRC to cancel from." }, "in_vat_group": { "type": "boolean", "description": "Whether the entity is a member of a VAT group.", "examples": [ "false" ] }, "entity_in_liquidation": { "type": "boolean", "description": "True if the entity is in liquidation.", "examples": [ "false" ] }, "vat_on_stock_and_assets": { "$ref": "#/components/schemas/Money", "description": "VAT due on stock and other assets held at the cancellation date on which VAT was or could have been reclaimed, in minor units.", "examples": [ "{\"amount\": 0, \"currency\": \"GBP\"}" ] }, "file_final_return": { "type": "boolean", "description": "Whether Entiva prepares and files the final VAT return.", "examples": [ "true" ] }, "final_vat_workings": { "type": "string", "pattern": "^doc_", "description": "Uploaded workings or ledger extract for the final period, up to and including the cancellation date.", "examples": [ "doc_8Fv2JtLs" ] }, "final_return_due_date": { "type": "string", "format": "date", "description": "Due date for the final return as shown in the VAT online account or on HMRC's letter." }, "signatory": { "type": "string", "pattern": "^per_", "description": "per_ id of the person who approves the cancellation and, on the paper route, signs VAT7.", "examples": [ "per_5Tq8NwXc" ] }, "eori_number": { "type": "string", "description": "EORI number, if any." } }, "required": [ "entity_type", "registration_jurisdiction", "vat_registration_number", "cancellation_reason", "reason_effective_date", "in_vat_group", "entity_in_liquidation", "vat_on_stock_and_assets", "signatory" ], "description": "Cancels the entity's VAT registration with HMRC and prepares the final VAT return, including VAT on stock and assets over £1,000. Entiva files as the entity's authorised tax agent after the client authorises it and approves the return." }, "Create_uk_vat_registration_cancel": { "type": "object", "properties": { "type": { "const": "uk.vat_registration.cancel" }, "params": { "$ref": "#/components/schemas/Params_uk_vat_registration_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a VAT registration on cessation", "x-entiva": { "jurisdiction": "uk", "stage": "closure", "applies_to": [ "private_ltd_shares", "private_ltd_guarantee", "private_unlimited", "plc", "cic", "llp", "lp", "pflp", "slp", "foreign_company", "general_partnership", "scottish_qualifying_partnership", "charitable_company", "cio", "scio", "registered_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "hmrc_agent_authorisation", "title": "HMRC agent authorisation", "source": "generated", "required": true }, { "key": "vat_cancellation_request", "title": "VAT cancellation request", "source": "generated", "required": true }, { "key": "vat7_form", "title": "Form VAT7", "source": "generated", "required": false }, { "key": "final_vat_workings", "title": "Final period workings", "source": "uploaded", "required": false }, { "key": "final_vat_return", "title": "Final VAT return", "source": "generated", "required": false }, { "key": "hmrc_cancellation_confirmation", "title": "HMRC confirmation of cancellation", "source": "registry_issued", "required": true }, { "key": "final_return_receipt", "title": "HMRC receipt for the final return", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "registry_idv" }, { "role": "member", "verification_level": "registry_idv" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "hmrc_agent_authorisation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "vat_cancellation_request", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "final_vat_return", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "vat7_form", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "HMRC", "form": "Online VAT cancellation, or form VAT7", "channel": "both", "government_fee": { "amount": 0, "currency": "GBP" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "[jurisdiction_error] entity_type cannot take this action; the message names the action type that applies instead." }, { "code": "verification_required", "type": null, "when": "[requirement_error] A person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "[requirement_error] An open sanctions or PEP alert on a person in this action pauses the action until compliance resolves it." }, { "code": "human_presence_required", "type": null, "when": "[permission_error] An agent key tried a personal step; the response links the person's hosted page." }, { "code": "registry_rejected", "type": null, "when": "[registry_error] The registry or regulator rejected the filing; the message carries its reason and the action moves to rejected." }, { "code": "vat_transfer_required", "type": null, "when": "[invalid_request_error] The legal status changed or the business was sold and the registration number is being kept; HMRC says to transfer the registration, not cancel it." }, { "code": "vat_group_amendment_required", "type": null, "when": "[invalid_request_error] A single company in a VAT group is closing; the VAT group is changed with the VAT50-51 amend form, not cancellation." }, { "code": "agent_authorisation_missing", "type": null, "when": "[requirement_error] HMRC has not yet recorded the client's authorisation of Entiva as tax agent for VAT." }, { "code": "paper_route_required", "type": null, "when": "[requirement_error] The reason or the liquidation means HMRC takes the request by post; a VAT7 signature requirement is added." }, { "code": "vat_registration_not_found", "type": null, "when": "[invalid_request_error] vat_registration_number does not match HMRC's record for this entity." }, { "code": "cancellation_overdue", "type": null, "when": "[invalid_request_error] reason_effective_date is more than 30 days ago; the action proceeds but the quote flags late-deregistration penalty exposure." }, { "code": "final_return_overdue", "type": null, "when": "[requirement_error] The final return due date has passed; Entiva files it as soon as the client approves it." } ] } }, "Params_ky_building_society_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Society name.", "examples": [ "Seven Mile Beach Building Society" ] }, "chief_office": { "$ref": "#/components/schemas/Address", "description": "Chief office or place of meeting for the society's business, which the rules must set out (s.4).", "examples": [ "{\"line1\":\"45 Church Street\",\"city\":\"George Town\",\"postal_code\":\"KY1-1102\",\"country\":\"KY\"}" ] }, "purposes_of_funds": { "type": "string", "description": "Purposes to which the society's funds are applied and how they are invested (s.4).", "examples": [ "Advances to members on first-charge security over freehold residential property in the Islands." ] }, "share_value": { "$ref": "#/components/schemas/Money", "description": "Value of each share.", "examples": [ "{\"amount\":100,\"currency\":\"KYD\"}" ] }, "share_types": { "type": "array", "items": {}, "description": "Share classes the rules provide for: subscription, paid_up, preferential (s.4-).", "examples": [ "[\"subscription\",\"paid_up\"]" ] }, "borrowing": { "type": "object", "description": "Whether the society intends to borrow and the limit, not exceeding the Law's limits (s.4, s.19).", "examples": [ "{\"intends_to_borrow\":false,\"limit\":null}" ] }, "dispute_resolution": { "type": "string", "enum": [ "court", "arbitration" ], "description": "Whether disputes with members are settled by the Court or by arbitration (s.4).", "examples": [ "arbitration" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day of the financial year end, MM-DD.", "examples": [ "12-31" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for the board of directors or committee of management.", "examples": [ "[\"per_b1\",\"per_b2\",\"per_b3\"]" ] }, "clerk_or_secretary": { "type": "string", "pattern": "^per_", "description": "The clerk or secretary who countersigns the transcripts (s.7).", "examples": [ "per_b4" ] }, "senior_officers": { "type": "array", "items": {}, "description": "Array of person_ref for senior officers other than directors and the secretary.", "examples": [ "[\"per_b5\"]" ] }, "founding_shareholders": { "type": "array", "items": {}, "description": "Founding shareholders.", "examples": [ "[{\"holder\":\"per_b1\",\"shares\":200},{\"holder\":\"per_b2\",\"shares\":200},{\"holder\":\"per_b3\",\"shares\":100}]" ] }, "fit_and_proper_action_id": { "type": "string", "description": "The completed action id of ky.fit_and_proper_determination.request with society_type building_society.", "examples": [ "act_5Rk7Vp3NqLb" ] }, "rules_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the society's own draft rules.", "examples": [ "doc_4Wg6Hs" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva.", "examples": [ "per_b4" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "chief_office", "purposes_of_funds", "share_value", "share_types", "borrowing", "dispute_resolution", "financial_year_end", "directors", "clerk_or_secretary", "founding_shareholders", "fit_and_proper_action_id", "authorised_representative", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Incorporates a building society in three steps: CIMA determines that the proposed directors and senior officers are fit and proper, the Attorney General certifies the society's rules, and the Registrar of Companies registers the society." }, "Create_ky_building_society_incorporate": { "type": "object", "properties": { "type": { "const": "ky.building_society.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_building_society_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a building society", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "building_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "proposed_rules", "title": "Rules of the society", "source": "generated", "required": true }, { "key": "rules_transcripts", "title": "Two transcripts of the rules for the Attorney General", "source": "generated", "required": true }, { "key": "attorney_general_submission", "title": "Covering submission to the Attorney General", "source": "generated", "required": true }, { "key": "fit_and_proper_determination", "title": "CIMA fit-and-proper determination", "source": "registry_issued", "required": true }, { "key": "certified_transcript", "title": "Transcript certified by the Attorney General", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "rules_transcripts", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "rules_transcripts", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "attorney_general_submission", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Attorney General's Chambers", "form": "Two transcripts of the rules signed", "channel": "paper", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "fit_and_proper_determination_missing", "type": "requirement_error", "when": "fit_and_proper_action_id is missing, not completed, or covers different directors and senior officers (s.3)." }, { "code": "rules_need_three_directors", "type": "requirement_error", "when": "Fewer than three directors are listed to sign the transcripts (s.7)." }, { "code": "rules_submission_late", "type": "jurisdiction_error", "when": "More than one month has passed since the rules were made and the transcripts have not gone to the Attorney General (s.7)." }, { "code": "share_value_over_limit", "type": "invalid_request_error", "when": "share_value exceeds the CI$500 estimated ultimate value in s.53." }, { "code": "name_conflict", "type": "registry_error", "when": "The name is identical to, or so like an existing society's name as to deceive (s.3 proviso)." }, { "code": "attorney_general_refused_to_certify", "type": "registry_error", "when": "The Attorney General refuses to certify the rules." } ] } }, "Params_ky_cooperative_society_register": { "type": "object", "properties": { "name": { "type": "string", "description": "Proposed society name.", "examples": [ "Brac Fishers Cooperative Society Limited" ] }, "society_kind": { "type": "string", "enum": [ "primary", "secondary", "credit_union" ], "description": "primary: promotes the economic interest of its members under co-operative principles with at least ten members qualified under s.23 (s.4). secondary.", "examples": [ "primary" ] }, "liability": { "type": "string", "enum": [ "limited", "unlimited" ], "description": "Liability of members.", "examples": [ "limited" ] }, "objects": { "type": "string", "description": "Objects of the society.", "examples": [ "To promote the economic interest of its members who fish commercially from Cayman Brac through joint purchasing, cold storage and marketing." ] }, "common_bond": { "type": "object", "description": "Required for primary societies and credit unions.", "examples": [ "{\"type\":\"occupation\",\"description\":\"Commercial fishers licensed and based in Cayman Brac\"}" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Address to which notices and communications are sent.", "examples": [ "{\"line1\":\"12 Stake Bay Road\",\"city\":\"Cayman Brac\",\"postal_code\":\"KY2-2101\",\"country\":\"KY\"}" ] }, "founding_members": { "type": "array", "items": {}, "description": "Required for primary societies and credit unions.", "examples": [ "[\"per_a1\",\"per_a2\",\"per_a3\",\"per_a4\",\"per_a5\",\"per_a6\",\"per_a7\",\"per_a8\",\"per_a9\",\"per_a10\"]" ] }, "member_societies": { "type": "array", "items": {}, "description": "Required for secondary societies.", "examples": [ "[]" ] }, "committee": { "type": "array", "items": {}, "description": "Governing committee and officers.", "examples": [ "[{\"person\":\"per_a1\",\"office\":\"chairperson\"},{\"person\":\"per_a2\",\"office\":\"secretary\"},{\"person\":\"per_a3\",\"office\":\"treasurer\"}]" ] }, "fit_and_proper_action_id": { "type": "string", "description": "Required when society_kind is credit_union.", "examples": [ "act_3Fq8Zr2KxTn" ] }, "rules_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the customer's own proposed rules.", "examples": [ "doc_6Rt2Mp" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva.", "examples": [ "per_a1" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "society_kind", "liability", "objects", "registered_office", "authorised_representative", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Registers a primary co-operative society, a secondary society or a credit union with the Registrar of Cooperative Societies. Entiva drafts the application and the three copies of the rules, verifies every signer, collects wet-ink." }, "Create_ky_cooperative_society_register": { "type": "object", "properties": { "type": { "const": "ky.cooperative_society.register" }, "params": { "$ref": "#/components/schemas/Params_ky_cooperative_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a co-operative society or credit union", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Application for registration signed by the qualifying members", "source": "generated", "required": true }, { "key": "proposed_rules", "title": "Proposed rules", "source": "generated", "required": true }, { "key": "member_society_authority", "title": "Authority of the person signing for a member society", "source": "uploaded", "required": false }, { "key": "fit_and_proper_determination", "title": "CIMA fit-and-proper determination", "source": "registry_issued", "required": false }, { "key": "registrar_information_response", "title": "Response to the Registrar's information request", "source": "uploaded", "required": false }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true }, { "key": "registered_rules", "title": "Registered rules", "source": "registry_issued", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "application_form", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "General Registry: Registrar of Cooperative Societies", "form": "Application to the Registrar signed", "channel": "paper", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_missing_cooperative_word", "type": "jurisdiction_error", "when": "The name lacks 'cooperative' (s.5), or a limited-liability society's name does not end in 'Limited' (s.5)." }, { "code": "name_conflict", "type": "registry_error", "when": "The name is identical to, or so like an existing society's name as to mislead the public (s.5)." }, { "code": "too_few_founding_members", "type": "requirement_error", "when": "Fewer than ten qualified individuals sign a primary society or credit union application (s.4, s.6)." }, { "code": "member_not_qualified", "type": "requirement_error", "when": "A signer is under 18 or the common bond is missing." }, { "code": "member_societies_missing", "type": "requirement_error", "when": "A secondary society has fewer than two registered societies among its members (s.4)." }, { "code": "limited_liability_required", "type": "jurisdiction_error", "when": "A society with a registered society among its members is set to unlimited liability (s.5)." }, { "code": "fit_and_proper_determination_missing", "type": "requirement_error", "when": "society_kind is credit_union and fit_and_proper_action_id is missing or not completed (ss.5, 7)." }, { "code": "registrar_refused", "type": "registry_error", "when": "The Registrar refuses registration." } ] } }, "Params_ky_ein_apply": { "type": "object", "properties": { "reason_for_applying": { "type": "string", "enum": [ "started_new_business", "hired_employees", "banking_purpose", "changed_type_of_organization", "purchased_going_business", "created_a_trust", "created_a_pension_plan", "compliance_with_irs_withholding_regulations", "other" ], "description": "Form SS-4 line 10; check one only.", "examples": [ "compliance_with_irs_withholding_regulations" ] }, "reason_detail": { "type": "string", "description": "Line 10 detail: the type of business, the banking purpose, or the other reason described in a few words.", "examples": [ "Entity will receive US-source income and must furnish Form W-8BEN-E to its US payer" ] }, "needed_for": { "type": "string", "enum": [ "w8_or_w9", "fatca_registration", "entity_classification_election", "us_tax_return", "us_bank_account", "other" ], "description": "Why the EIN is needed.", "examples": [ "w8_or_w9" ] }, "legal_name": { "type": "string", "description": "Line 1: the legal name exactly as in the governing document.", "examples": [ "Reefline Holdings Ltd." ] }, "trade_name": { "type": "string", "description": "Line 2: trade name only if it differs from the legal name." }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Lines 4a-4b: where the IRS mails the EIN notice.", "examples": [ "{\"line1\":\"PO Box 1234\",\"city\":\"George Town\",\"postal_code\":\"KY1-1108\",\"country\":\"KY\"}" ] }, "street_address": { "$ref": "#/components/schemas/Address", "description": "Lines 5a-5b: physical address, only if different from the mailing address.", "examples": [ "{\"line1\":\"1 Elgin Avenue\",\"city\":\"George Town\",\"country\":\"KY\"}" ] }, "responsible_party": { "type": "string", "pattern": "^per_", "description": "Line 7a: the individual who ultimately owns or controls the entity.", "examples": [ "per_e1" ] }, "responsible_party_tin": { "type": "string", "description": "Line 7b: the responsible party's SSN or ITIN, if any." }, "is_llc": { "type": "boolean", "description": "Line 8a.", "examples": [ "false" ] }, "llc_member_count": { "type": "integer", "description": "Line 8b.", "examples": [ "1" ] }, "us_entity_type": { "type": "string", "enum": [ "partnership", "corporation", "trust", "other" ], "description": "Line 9a, as declared by the customer.", "examples": [ "corporation" ] }, "return_form": { "type": "string", "description": "The income tax return the entity expects to file, as declared by the customer on line 9a.", "examples": [ "1120-F" ] }, "date_started": { "type": "string", "format": "date", "description": "Line 11: date the business started or was acquired.", "examples": [ "2026-03-02" ] }, "closing_month": { "type": "integer", "description": "Line 12: last month of the accounting year, 1-12.", "examples": [ "12" ] }, "expected_employees": { "type": "integer", "description": "Line 13: highest number of employees expected in the next 12 months. 0 if none.", "examples": [ "0" ] }, "first_wages_date": { "type": "string", "format": "date", "description": "Line 15: date wages or annuities were first paid, or the date the entity began paying income to a nonresident alien if it is a withholding agent." }, "nature_of_business": { "type": "string", "enum": [ "construction", "real_estate", "rental_and_leasing", "manufacturing", "transportation_and_warehousing", "finance_and_insurance", "health_care_and_social_assistance", "accommodation_and_food_services", "wholesale_agent_or_broker", "wholesale_other", "retail", "other" ], "description": "Line 16: the one category that best describes the principal activity.", "examples": [ "finance_and_insurance" ] }, "principal_line_of_business": { "type": "string", "description": "Line 17: specific detail of the principal line of business.", "examples": [ "Holding company for investments in US securities" ] }, "previously_issued_ein": { "type": "boolean", "description": "Line 18: whether the entity has had an EIN before.", "examples": [ "false" ] }, "submission_method": { "type": "string", "enum": [ "fax", "phone", "mail" ], "description": "How the form reaches the IRS. fax: about four business days, EIN returned by fax cover sheet to Entiva as designee. phone: international applicants only.", "examples": [ "fax" ] }, "designee": { "type": "string", "enum": [ "entiva", "none" ], "description": "entiva: Entiva is named as third-party designee to answer IRS questions and receive the EIN; its authority ends once the EIN is assigned. none: the.", "examples": [ "entiva" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "The duly authorised person who signs the form.", "examples": [ "per_e1" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva.", "examples": [ "per_e1" ] } }, "required": [ "reason_for_applying", "reason_detail", "mailing_address", "responsible_party", "us_entity_type", "return_form", "date_started", "closing_month", "nature_of_business", "principal_line_of_business", "previously_issued_ein", "authorised_signatory", "authorised_representative" ], "description": "Obtains a US employer identification number from the IRS for an existing Cayman entity that has no US principal place of business, so the online EIN tool is unavailable. Entiva completes Form SS-4 from the entity record, collects an." }, "Create_ky_ein_apply": { "type": "object", "properties": { "type": { "const": "ky.ein.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_ein_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain a US EIN for a Cayman entity", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "llc", "elp", "llp", "foundation_company", "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_ss4", "title": "Form SS-4, Application for Employer Identification Number", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution authorising the EIN application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation or registration", "source": "uploaded", "required": false }, { "key": "ein_confirmation", "title": "IRS EIN confirmation", "source": "registry_issued", "required": true }, { "key": "ein_assignment_notice", "title": "IRS EIN assignment notice", "source": "uploaded", "required": false } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_ss4", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "US Internal Revenue Service, EIN International Operation", "form": "IRS Form SS-4", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ein_already_issued", "type": "requirement_error", "when": "previously_issued_ein is true or Entiva finds an EIN on the entity." }, { "code": "responsible_party_not_individual", "type": "invalid_request_error", "when": "The responsible party is not an individual." }, { "code": "us_entity_type_required", "type": "invalid_request_error", "when": "us_entity_type is corporation and return_form is empty." }, { "code": "llc_member_count_required", "type": "invalid_request_error", "when": "is_llc is true and llc_member_count is missing." }, { "code": "address_is_po_box", "type": "invalid_request_error", "when": "street_address is a P.O. box." }, { "code": "phone_method_unavailable", "type": "requirement_error", "when": "submission_method is phone but the designee's address or phone matches the entity's." }, { "code": "irs_daily_limit", "type": "registry_error", "when": "The IRS refuses a second EIN for the same applicant on the same day." }, { "code": "irs_rejected_form", "type": "registry_error", "when": "The IRS returns the form for missing or inconsistent lines." }, { "code": "irs_no_response", "type": "registry_error", "when": "No EIN is returned within ten business days of a fax." } ] } }, "Params_ky_elp_register": { "type": "object", "properties": { "name": { "type": "string", "description": "Must include Limited Partnership, L.P. or LP (ELP Act s.6); may include a partner's name; an ELP carrying on SEZ business must include special economic zone or.", "examples": [ "Northwind Ventures I, L.P." ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.llc_partnership_name.reserve action.", "examples": [ "act_1R4m2Vx7Lc" ] }, "registration_basis": { "type": "string", "enum": [ "new", "re_registration" ], "description": "new forms a new ELP. re_registration registers an existing Partnership Act limited partnership or a foreign partnership as an ELP (s.40); that does not create.", "examples": [ "new" ] }, "existing_partnership": { "type": "object", "description": "Required for re_registration: {name, registration_number, governing_law}." }, "nature_of_business": { "type": "string", "description": "General nature of the business, stated in the registration statement (s.9).", "examples": [ "Venture capital investment in early-stage technology companies outside the Cayman Islands" ] }, "term": { "type": "object", "description": "Omit for unlimited duration." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the ELP commences, stated in the registration statement (s.9).", "examples": [ "2026-11-02" ] }, "general_partners": { "type": "array", "items": {}, "description": "Array of {person_id or inline person, qualifying_gp}.", "examples": [ "[{person_id: per_8Rv5Tk2Ld, qualifying_gp: true}]" ] }, "limited_partners": { "type": "array", "items": {}, "description": "Array of {person_id, commitment, interest_percent}.", "examples": [ "[{person_id: per_3Gc9Wm6Zy, commitment: {amount: 2000000, currency: USD}, interest_percent: 80}, {person_id: per_1Nb4Qf8Hx, commitment: {amount: 500000, currency: USD}, interest_percent: 20}]" ] }, "general_partner_commitment": { "$ref": "#/components/schemas/Money", "description": "Capital commitment of the general partner, if any.", "examples": [ "{amount: 1, currency: USD}" ] }, "fund_vehicle": { "type": "boolean", "description": "true if the ELP will be registered with CIMA as a private or mutual fund.", "examples": [ "true" ] }, "no_business_with_public_declaration": { "type": "boolean", "description": "The customer confirms the ELP will not undertake business with the public in the Islands other than as necessary for its business outside the Islands (s.9.", "examples": [ "true" ] }, "partnership_agreement_source": { "type": "string", "enum": [ "entiva_template", "uploaded" ], "description": "entiva_template generates a partnership agreement with a power-of-attorney clause for Entiva and Entiva. uploaded uses.", "examples": [ "entiva_template" ] }, "partnership_agreement_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when partnership_agreement_source is uploaded." }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no interest, such as an investment manager with GP-removal rights." }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, for example fund_management, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}: origin of the partners' contributions.", "examples": [ "{summary: Capital commitments from limited partners' investment portfolios, origin_countries: [US, SG]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_8Rv5Tk2Ld" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500 (ELP Act s.13).", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "name", "nature_of_business", "general_partners", "limited_partners", "no_business_with_public_declaration", "source_of_funds", "instructing", "countries_of_operation", "beneficial_owners" ], "description": "Registers an exempted limited partnership by filing a statement signed by or on behalf of a general partner and paying the Registry fee. Limited partners are not named in the filing." }, "Create_ky_elp_register": { "type": "object", "properties": { "type": { "const": "ky.elp.register" }, "params": { "$ref": "#/components/schemas/Params_ky_elp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Cayman exempted limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Corporate GP: certificate of incorporation", "source": "uploaded", "required": false }, { "key": "certificate_of_good_standing", "title": "Corporate GP: certificate of good standing", "source": "uploaded", "required": false }, { "key": "certificate_of_registration", "title": "ELP or foreign LP as GP: certificate of registration and good standing", "source": "uploaded", "required": false }, { "key": "ownership_chart", "title": "Ownership and control chart to individuals", "source": "uploaded", "required": false }, { "key": "constitution", "title": "Corporate party: constitution and board resolution", "source": "uploaded", "required": false }, { "key": "partnership_agreement_upload", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "elp_registration_statement", "title": "ELP registration statement (s.9)", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": false }, { "key": "gp_consent_to_act", "title": "General partner consent to act", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "certificate_of_registration_issued", "title": "Certificate of registration", "source": "registry_issued", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "no_business_with_public_confirmation", "title": "No business with public confirmation", "source": "generated", "required": true }, { "key": "cap_elp_filing", "title": "Cap elp filing", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "elp_registration_statement", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gp_consent_to_act", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "no_business_with_public_confirmation", "signer_role": "general_partner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_elp_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "ELP registration statement under Exempted Limited Partnership Act s.9", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "elp_no_qualifying_gp", "type": null, "when": "requirement_error, 422." }, { "code": "elp_gp_documents_missing", "type": null, "when": "requirement_error, 422." }, { "code": "elp_declaration_required", "type": null, "when": "jurisdiction_error, 422. no_business_with_public_declaration is false or missing (s.9)." }, { "code": "elp_name_invalid", "type": null, "when": "invalid_request_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "reregistration_basis_missing", "type": null, "when": "invalid_request_error, 422. registration_basis is re_registration without existing_partnership details (s.40)." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_exempted_company_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name.", "examples": [ "Northwind Holdings Ltd." ] }, "name_reservation_action_id": { "type": "string", "description": "Id of a completed ky.name.reserve action for this name.", "examples": [ "act_1R4kZp8Qe2" ] }, "dual_foreign_name": { "type": "string", "description": "Optional dual foreign name in any script, preceding or following the name (s.7, s.31).", "examples": [ "Northwind Holdings" ] }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee", "unlimited" ], "description": "Mode of limiting members' liability.", "examples": [ "limited_by_shares" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Authorised capital as {amount, currency}.", "examples": [ "{amount: 50000, currency: USD}" ] }, "share_structure": { "type": "object", "description": "Share classes: {class_name, par_value, number_of_shares}.", "examples": [ "{class_name: Ordinary, par_value: {amount: 1, currency: USD}, number_of_shares: 50000}" ] }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required when liability is limited_by_guarantee: the maximum amount each member undertakes to contribute on winding up (s.9).", "examples": [ "{amount: 1, currency: USD}" ] }, "nature_of_business": { "type": "string", "description": "Plain description of the business and the countries it will operate in.", "examples": [ "Holding of equity interests in software operating companies outside the Cayman Islands" ] }, "memorandum_objects": { "type": "string", "description": "Optional restricted objects clause." }, "operations_outside_islands": { "type": "boolean", "description": "The customer confirms the company's operations will be conducted mainly outside the Islands, or under a licence to carry on business in the Islands.", "examples": [ "true" ] }, "subscriber_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "Who signs the memorandum and articles as subscriber.", "examples": [ "licensed_partner_nominee" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "Required when subscriber_mode is customer." }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id or inline person, role}, appointed on incorporation.", "examples": [ "[{person_id: per_3Fm8Kx2Qa, role: director}, {person_id: per_9Tn2Lw4Vb, role: director}]" ] }, "officers": { "type": "array", "items": {}, "description": "Optional array of {person_id, title} for a secretary or other officers." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Array of {person_id, share_class, number_of_shares, paid_up}.", "examples": [ "[{person_id: per_3Fm8Kx2Qa, share_class: Ordinary, number_of_shares: 30000}, {person_id: per_9Tn2Lw4Vb, share_class: Ordinary, number_of_shares: 20000}]" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "People who exercise ultimate effective control without shares, for example by the right to appoint or remove directors, or nominee principals (BOTA s.4; BO." }, "articles_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "entiva_standard generates articles. custom uses the document in custom_articles_document_id and adds legal review by Entiva.", "examples": [ "entiva_standard" ] }, "custom_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of uploaded custom articles." }, "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end as MM-DD.", "examples": [ "12-31" ] }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Relevant activities the company expects to carry on under the Cayman economic substance regime, or an empty array for none.", "examples": [ "[holding_company]" ] }, "source_of_funds": { "type": "object", "description": "Source of the funds for the initial capital and activity: {summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Founders' savings and proceeds of the sale of a prior software business, origin_countries: [US, GB]}" ] }, "introducer_account_id": { "type": "string", "description": "acct_ id of a platform that introduced the customer, where the partner is asked to rely on its CDD." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_3Fm8Kx2Qa" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds the Registry's CI$500 express fee: same working day if the application and fees reach the Registry by 12 noon, otherwise by 12 noon the next.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "nature_of_business", "operations_outside_islands", "directors", "initial_shareholders", "source_of_funds", "instructing", "countries_of_operation", "shareholders", "share_classes", "beneficial_owners" ], "description": "Incorporates an exempted company by filing the memorandum and articles, the s.165 declaration that operations will be conducted mainly outside the Islands, and the notice of registered office on CAP. Entiva's licensed Entiva is the." }, "Create_ky_exempted_company_incorporate": { "type": "object", "properties": { "type": { "const": "ky.exempted_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Cayman exempted company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart to individuals", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party: certificate of incorporation or registration", "source": "uploaded", "required": false }, { "key": "certificate_of_good_standing", "title": "Corporate party: certificate of good standing", "source": "uploaded", "required": false }, { "key": "constitution", "title": "Corporate party: constitution", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Corporate party: board resolution", "source": "uploaded", "required": false }, { "key": "custom_articles", "title": "Custom articles of association", "source": "uploaded", "required": false }, { "key": "source_of_wealth_evidence", "title": "Source of wealth evidence", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "section_165_declaration", "title": "Exempted company declaration", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "operations_declaration_confirmation", "title": "Operations declaration confirmation", "source": "generated", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "alternate_director", "verification_level": "identity_address" }, { "role": "nominee", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "filing_agent", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "memorandum_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "nominee", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "section_165_declaration", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "operations_declaration_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Memorandum and articles of association, s.165 declaration and notice of registered office", "channel": "online", "government_fee": { "amount": 700, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "name_restricted_word", "type": null, "when": "invalid_request_error, 422." }, { "code": "operations_declaration_required", "type": null, "when": "jurisdiction_error, 422. operations_outside_islands is false or the click_consent confirmation is missing." }, { "code": "authorised_capital_invalid", "type": null, "when": "invalid_request_error, 422." }, { "code": "director_required", "type": null, "when": "requirement_error, 422." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422. approve is called while a person's verification is outstanding; requirement points to the person." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_exempted_ldc_convert": { "type": "object", "properties": { "name": { "type": "string", "description": "New name ending Limited Duration Company or LDC (s.179).", "examples": [ "Redwood Partners LDC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action for the new name." }, "duration_years": { "type": "integer", "description": "Duration to write into the memorandum, 30 or less.", "examples": [ "30" ] }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How the two special resolutions are passed. general_meeting needs a two-thirds majority of votes cast at a meeting with notice of the special resolution.", "examples": [ "written_resolution" ] }, "management_structure": { "type": "string", "enum": [ "board_of_directors", "members_equally", "members_pro_rata" ], "description": "Optional amendment of the articles under s.24 to use the LDC management provisions in s.180-.", "examples": [ "board_of_directors" ] }, "share_transfer_requires_unanimous_consent": { "type": "boolean", "description": "Optional articles amendment under s.180.", "examples": [ "false" ] }, "articles_amendment_document_id": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the proposed articles amendments, if any." }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500 (Sch.5 Pt 9 item 2; s.200).", "examples": [ "standard" ] } }, "required": [ "name", "resolution_method" ], "description": "Re-registers an existing exempted company, already an Entiva entity, as an exempted limited duration company under Companies Act ss.178-179. The members pass special resolutions limiting duration to 30 years or less and changing the name." }, "Create_ky_exempted_ldc_convert": { "type": "object", "properties": { "type": { "const": "ky.exempted_ldc.convert" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_ldc_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an existing exempted company into an LDC", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "certified_memorandum", "title": "Current memorandum and articles with amendments", "source": "uploaded", "required": false }, { "key": "special_resolution_duration", "title": "Special resolution limiting duration to 30 years or less", "source": "generated", "required": false }, { "key": "special_resolution_name", "title": "Special resolution changing the name to an LDC name", "source": "generated", "required": true }, { "key": "articles_amendment_resolution", "title": "Special resolution amending the articles", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Board resolution recommending the conversion", "source": "generated", "required": true }, { "key": "ldc_application", "title": "Application to register as an LDC", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation on change of name, certifying LDC status", "source": "registry_issued", "required": true }, { "key": "meeting_minutes", "title": "Meeting minutes", "source": "generated", "required": true }, { "key": "cap_ldc_filing", "title": "Cap ldc filing", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_name", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_duration", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_ldc_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.178 with certified copies of the special resolutions", "channel": "online", "government_fee": { "amount": 400, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ldc_minimum_members", "type": null, "when": "requirement_error, 422." }, { "code": "ldc_duration_exceeds_30_years", "type": null, "when": "invalid_request_error, 422." }, { "code": "ldc_name_suffix_required", "type": null, "when": "invalid_request_error, 422. new_name does not end Limited Duration Company or LDC." }, { "code": "written_resolution_not_permitted", "type": null, "when": "requirement_error, 422. resolution_method is written_resolution but the articles do not allow written special resolutions or not all members have signed (s.60)." }, { "code": "entity_not_exempted", "type": null, "when": "jurisdiction_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_exempted_ldc_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must end with Limited Duration Company or LDC (s.179) and pass s.30.", "examples": [ "Redwood Partners LDC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action." }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee", "unlimited" ], "description": "Default limited_by_shares.", "examples": [ "limited_by_shares" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Sets the fee band: the exempted band plus the CI$200 LDC application fee (s.178): CI$900, 1,200, 2,184 or 2,768 for capital up to CI$42,000, CI$820,000.", "examples": [ "{amount: 50000, currency: USD}" ] }, "share_structure": { "type": "object", "description": "{class_name, par_value, number_of_shares}.", "examples": [ "{class_name: Ordinary, par_value: {amount: 1, currency: USD}, number_of_shares: 50000}" ] }, "duration_years": { "type": "integer", "description": "Duration of the company in years, 30 or less, written into the memorandum (s.179).", "examples": [ "30" ] }, "management_structure": { "type": "string", "enum": [ "board_of_directors", "members_equally", "members_pro_rata" ], "description": "The articles may vest management in the members equally per capita or in proportion to their interests, in which case the members are directors but may.", "examples": [ "board_of_directors" ] }, "share_transfer_requires_unanimous_consent": { "type": "boolean", "description": "The articles may require the unanimous resolution of the other members to any transfer of a share or interest (s.180).", "examples": [ "false" ] }, "nature_of_business": { "type": "string", "description": "Business description for the s.165 declaration, the business profile and the ES questionnaire.", "examples": [ "Co-investment vehicle holding minority interests in technology companies" ] }, "operations_outside_islands": { "type": "boolean", "description": "The customer confirms operations will be conducted mainly outside the Islands or under a licence.", "examples": [ "true" ] }, "subscriber_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "An LDC needs at least two subscribers or two members (s.179).", "examples": [ "customer" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "At least two entries {person_id, shares} when subscriber_mode is customer.", "examples": [ "[{person_id: per_6Rb3Mc8Td, shares: 1}, {person_id: per_2Jk5Ne7Yp, shares: 1}]" ] }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id, role}.", "examples": [ "[{person_id: per_6Rb3Mc8Td, role: director}]" ] }, "officers": { "type": "array", "items": {}, "description": "Optional {person_id, title}." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Array of {person_id, share_class, number_of_shares}.", "examples": [ "[{person_id: per_6Rb3Mc8Td, share_class: Ordinary, number_of_shares: 25000}, {person_id: per_2Jk5Ne7Yp, share_class: Ordinary, number_of_shares: 25000}]" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "People with control but no shares: array of {person_id, control_basis}." }, "articles_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Default entiva_standard.", "examples": [ "entiva_standard" ] }, "custom_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when articles_template is custom." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD, used for deadlines.", "examples": [ "12-31" ] }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Capital contributions from the two members out of employment income and prior investments, origin_countries: [SG]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_6Rb3Mc8Td" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500 (s.200).", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "duration_years", "nature_of_business", "operations_outside_islands", "directors", "initial_shareholders", "source_of_funds", "instructing", "countries_of_operation", "shareholders", "share_classes", "beneficial_owners" ], "description": "Incorporates a new exempted company that is registered at the same time as an exempted limited duration company under Companies Act ss.178-179: at least two subscribers or members, a memorandum limiting duration to 30 years or less, and a." }, "Create_ky_exempted_ldc_incorporate": { "type": "object", "properties": { "type": { "const": "ky.exempted_ldc.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_ldc_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Cayman exempted limited duration company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_ldc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "section_165_declaration", "title": "Exempted company declaration", "source": "generated", "required": true }, { "key": "ldc_application", "title": "Application to register as an LDC", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation certifying LDC status", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "operations_declaration_confirmation", "title": "Operations declaration confirmation", "source": "generated", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "nominee", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "section_165_declaration", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "operations_declaration_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ldc_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Memorandum and articles, s.165 declaration, notice of registered office and application to", "channel": "online", "government_fee": { "amount": 900, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "ldc_minimum_members", "type": null, "when": "requirement_error, 422." }, { "code": "ldc_duration_exceeds_30_years", "type": null, "when": "invalid_request_error, 422. duration_years is above 30 or missing (s.179)." }, { "code": "ldc_name_suffix_required", "type": null, "when": "invalid_request_error, 422." }, { "code": "operations_declaration_required", "type": null, "when": "jurisdiction_error, 422. operations_outside_islands is false or the confirmation is missing." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409. s.30 refusal or expired reservation." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_exempted_spc_convert": { "type": "object", "properties": { "name": { "type": "string", "description": "New name including SPC or Segregated Portfolio Company, adopted by special resolution under s.31.", "examples": [ "Meridian Cell Structure SPC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action for the new name." }, "balance_sheet_date": { "type": "string", "format": "date", "description": "Date of the statement of assets and liabilities, which must fall within three months before the date of the directors' declaration (s.214).", "examples": [ "2026-09-30" ] }, "expected_intervening_events": { "type": "string", "description": "Any transaction or event between the balance sheet date and registration that would materially change the assets and liabilities (s.214).", "examples": [ "None expected" ] }, "portfolios": { "type": "array", "items": {}, "description": "Array of {name, assets_and_liabilities_to_transfer} for each portfolio the SPC intends to operate (s.214).", "examples": [ "[{name: Alpha Segregated Portfolio, assets_and_liabilities_to_transfer: doc_4Tb2Jn6Xd}]" ] }, "creditor_consent_basis": { "type": "string", "enum": [ "all_creditors_consented", "notice_given_95_percent_by_value" ], "description": "Either every creditor consented in writing to the transfer, or adequate notice was given and creditors holding 95% by value consented (s.214,).", "examples": [ "all_creditors_consented" ] }, "declaring_directors": { "type": "array", "items": {}, "description": "At least two directors who make the declaration: array of {person_id}.", "examples": [ "[{person_id: per_8Gh4Ls1Wm}, {person_id: per_5Vr9Pq3Ze}]" ] }, "cima_licensed": { "type": "boolean", "description": "true if the company holds a CIMA licence under the regulatory laws; CIMA's written consent is then attached (s.214).", "examples": [ "false" ] }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How the special resolutions are passed (s.60).", "examples": [ "written_resolution" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500.", "examples": [ "standard" ] } }, "required": [ "name", "balance_sheet_date", "portfolios", "creditor_consent_basis", "declaring_directors", "cima_licensed", "resolution_method" ], "description": "Re-registers an existing exempted company as a segregated portfolio company under Companies Act ss.213-214. At least two directors declare the assets and liabilities, the planned portfolios and solvency and creditor consents; the members." }, "Create_ky_exempted_spc_convert": { "type": "object", "properties": { "type": { "const": "ky.exempted_spc.convert" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_spc_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an existing exempted company into a segregated portfolio company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "portfolio_transfer_schedule", "title": "Schedule of assets and liabilities to transfer into each portfolio", "source": "uploaded", "required": true }, { "key": "creditor_consents", "title": "Written creditor consents, or creditor notice and consent tally", "source": "uploaded", "required": true }, { "key": "cima_consent", "title": "CIMA written consent", "source": "uploaded", "required": false }, { "key": "directors_declaration_s214", "title": "Directors' declaration (s.214)", "source": "generated", "required": true }, { "key": "special_resolution_transfer", "title": "Special resolution authorising the transfer into segregated portfolios", "source": "generated", "required": true }, { "key": "special_resolution_name", "title": "Special resolution changing the name to an SPC name", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "spc_application", "title": "Application to register as an SPC", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Registry certificate recording SPC registration", "source": "registry_issued", "required": true }, { "key": "cap_spc_filing", "title": "Cap spc filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "each", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "directors_declaration_s214", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_transfer", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_name", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "creditor_consents", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "cap_spc_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.213 with the s.214", "channel": "online", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "spc_declaration_directors_minimum", "type": null, "when": "requirement_error, 422." }, { "code": "spc_balance_sheet_stale", "type": null, "when": "invalid_request_error, 422. balance_sheet_date is more than three months before the declaration date (s.214)." }, { "code": "spc_creditor_consent_missing", "type": null, "when": "requirement_error, 422." }, { "code": "spc_cima_consent_missing", "type": null, "when": "requirement_error, 422. cima_licensed is true without CIMA's written consent (s.214)." }, { "code": "spc_name_designation_required", "type": null, "when": "invalid_request_error, 422. new_name lacks SPC or Segregated Portfolio Company, or a portfolio name lacks its designation (s.216)." }, { "code": "written_resolution_not_permitted", "type": null, "when": "requirement_error, 422." }, { "code": "entity_not_exempted", "type": null, "when": "jurisdiction_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_exempted_spc_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must include the letters SPC or the words Segregated Portfolio Company.", "examples": [ "Meridian Cell Structure SPC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action." }, "limited_duration": { "type": "boolean", "description": "true registers an SPC-LDC: the SPC is also an LDC (s.213; fee CI$1,400 to 3,268).", "examples": [ "false" ] }, "duration_years": { "type": "integer", "description": "Required when limited_duration is true: 30 or less (s.179)." }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee", "unlimited" ], "description": "Default limited_by_shares.", "examples": [ "limited_by_shares" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Sets the fee band.", "examples": [ "{amount: 50000, currency: USD}" ] }, "share_structure": { "type": "object", "description": "{class_name, par_value, number_of_shares}.", "examples": [ "{class_name: Management, par_value: {amount: 1, currency: USD}, number_of_shares: 100}" ] }, "intended_use": { "type": "string", "enum": [ "investment_fund", "insurance", "structured_finance", "other" ], "description": "Planned use.", "examples": [ "investment_fund" ] }, "cima_registration_planned": { "type": "boolean", "description": "Whether CIMA registration or licensing is planned.", "examples": [ "true" ] }, "initial_segregated_portfolios": { "type": "array", "items": {}, "description": "Optional names of portfolios planned.", "examples": [ "[Alpha Segregated Portfolio]" ] }, "nature_of_business": { "type": "string", "description": "Business description for the s.165 declaration and business profile.", "examples": [ "Multi-strategy fund platform with separate portfolios for each investor group" ] }, "operations_outside_islands": { "type": "boolean", "description": "The customer confirms operations will be conducted mainly outside the Islands or under a licence.", "examples": [ "true" ] }, "subscriber_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "Default licensed_partner_nominee.", "examples": [ "licensed_partner_nominee" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "When subscriber_mode is customer: {person_id, shares}." }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id, role}.", "examples": [ "[{person_id: per_8Gh4Ls1Wm, role: director}]" ] }, "officers": { "type": "array", "items": {}, "description": "Optional {person_id, title}." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Array of {person_id, share_class, number_of_shares}.", "examples": [ "[{person_id: per_8Gh4Ls1Wm, share_class: Management, number_of_shares: 100}]" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no shares, such as an investment manager with director-appointment rights." }, "articles_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Default entiva_standard.", "examples": [ "custom" ] }, "custom_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when articles_template is custom.", "examples": [ "doc_2Hn8Qv5Ac" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD.", "examples": [ "12-31" ] }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, for example fund_management, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Seed capital from the sponsor's balance sheet, origin_countries: [GB]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_8Gh4Ls1Wm" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "intended_use", "nature_of_business", "operations_outside_islands", "directors", "initial_shareholders", "source_of_funds", "instructing", "countries_of_operation", "shareholders", "share_classes", "beneficial_owners" ], "description": "Incorporates a new exempted company that is registered at the same time as a segregated portfolio company under Companies Act s.213, optionally also as a limited duration company. The name must include SPC or Segregated Portfolio Company." }, "Create_ky_exempted_spc_incorporate": { "type": "object", "properties": { "type": { "const": "ky.exempted_spc.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_spc_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Cayman segregated portfolio company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_spc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "custom_articles", "title": "Custom articles of association", "source": "uploaded", "required": false }, { "key": "drla_registration_evidence", "title": "Directors Registration and Licensing Act registration or licence", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "section_165_declaration", "title": "Exempted company declaration", "source": "generated", "required": true }, { "key": "spc_application", "title": "Application to register as an SPC", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "operations_declaration_confirmation", "title": "Operations declaration confirmation", "source": "generated", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "nominee", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "section_165_declaration", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "operations_declaration_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "spc_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Memorandum and articles, s.165 declaration, notice of registered office and application to", "channel": "online", "government_fee": { "amount": 1200, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "spc_name_designation_required", "type": null, "when": "invalid_request_error, 422." }, { "code": "ldc_minimum_members", "type": null, "when": "requirement_error, 422. limited_duration is true with fewer than two subscribers or members (s.179)." }, { "code": "ldc_duration_exceeds_30_years", "type": null, "when": "invalid_request_error, 422. limited_duration is true and duration_years is missing or above 30." }, { "code": "operations_declaration_required", "type": null, "when": "jurisdiction_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409. s.30 refusal or expired reservation." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_exempted_trust_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_trust" ], "description": "Must be exempted_trust." }, "trust_name": { "type": "string", "description": "Name of the trust." }, "governing_law": { "type": "string", "description": "Cayman Islands law for a trust under the Trusts Act." }, "instrument_type": { "type": "string", "enum": [ "declaration_of_trust", "deed_of_settlement_or_other_deed" ], "description": "Decides stamp duty: CI$40 declaration of trust, CI$50 other deeds." }, "instrument_date": { "type": "string", "format": "date", "description": "Date the trust instrument is executed." }, "draft_approval_action_id": { "type": "string", "description": "Completed ky.exempted_trust_draft.submit; the trust must be created within 28 days of approval." }, "settlor": { "type": "string", "pattern": "^per_", "description": "Settlor, individual or corporate." }, "trustees": { "type": "array", "items": {}, "description": "At least one." }, "protector_or_enforcer": { "type": "array", "items": {}, "description": "person_ref of each protector or enforcer." }, "beneficiaries": { "type": "array", "items": {}, "description": "Items {person: person_ref} or {class_description: string}, each with residence_country." }, "no_islands_resident_beneficiaries": { "type": "boolean", "description": "No beneficiary is or is likely to be resident or domiciled in the Islands, other than objects of a charitable trust or power (s.74)." }, "request_tax_undertaking": { "type": "boolean", "description": "Also seek a Financial Secretary undertaking under s.81." }, "tax_undertaking_term_years": { "type": "integer", "description": "At most 50 (s.81); required if request_tax_undertaking is true." }, "express": { "type": "boolean", "description": "Pay the CI$500 express fee." } }, "required": [ "entity_type", "trust_name", "governing_law", "instrument_type", "instrument_date", "settlor", "trustees", "beneficiaries", "no_islands_resident_beneficiaries" ], "description": "Registers a Cayman trust as an exempted trust with the Registrar of Trusts: the trustees apply and lodge the trust instrument and a copy. Available where no beneficiary is, or is likely to be, resident or domiciled in the Islands." }, "Create_ky_exempted_trust_register": { "type": "object", "properties": { "type": { "const": "ky.exempted_trust.register" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_trust_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an exempted trust", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trust_instrument", "title": "Trust instrument and a copy", "source": "uploaded", "required": true }, { "key": "registration_application", "title": "Trustees' application to register as an exempted trust", "source": "generated", "required": true }, { "key": "trustee_licence_evidence", "title": "CIMA trust licence or PTC registration of each trustee acting by way of business", "source": "uploaded", "required": false }, { "key": "beneficiary_non_residence_declarations", "title": "Beneficiary declarations of non-residence", "source": "generated", "required": false }, { "key": "source_of_wealth_declaration", "title": "Settlor's source of funds and wealth", "source": "uploaded", "required": true }, { "key": "submission_cover_letter", "title": "Cover letter to the Registrar of Trusts", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true }, { "key": "certified_copy_of_instrument", "title": "Registrar's certified copy (s.76)", "source": "registry_issued", "required": true } ], "people": [ { "role": "settlor", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trust_instrument", "signer_role": "settlor", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "trust_instrument", "signer_role": "settlor", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "beneficiary_non_residence_declarations", "signer_role": "beneficiary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "submission_cover_letter", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Trustees' application to register the trust as an exempted trust, lodging the instrument a", "channel": "both", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "islands_resident_beneficiary", "type": null, "when": "A beneficiary is or is likely to be resident or domiciled in the Islands and is not an object of a charitable trust or power (s.74)." }, { "code": "trustee_not_licensed", "type": null, "when": "A trustee acting by way of business has no CIMA trust licence or PTC registration." }, { "code": "registrar_declined", "type": null, "when": "The Registrar declines to register, which it may do without reasons (s.74)." }, { "code": "draft_approval_expired", "type": null, "when": "The trust was not created within 28 days of the s.82 approval." } ] } }, "Params_ky_exempted_trust_draft_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_trust" ], "description": "Must be exempted_trust." }, "trust_name": { "type": "string", "description": "Intended name." }, "settlor": { "type": "string", "pattern": "^per_", "description": "Intending settlor; the settlor or someone on their behalf may submit." }, "intended_trustees": { "type": "array", "items": {}, "description": "At least one." }, "beneficiaries": { "type": "array", "items": {}, "description": "Items {person: person_ref} or {class_description: string}, each with residence_country." }, "no_islands_resident_beneficiaries": { "type": "boolean", "description": "No beneficiary is or is likely to be resident or domiciled in the Islands, other than objects of a charitable trust or power (s.74)." }, "intended_creation_date": { "type": "string", "format": "date", "description": "Must fall within 28 days of approval or undertaking, whichever is later, unless the Registrar allows longer." }, "request_beneficiary_declaration_exemption": { "type": "boolean", "description": "Settlor asks in writing to be excused beneficiary declarations where only a non-beneficiary's discretion can benefit beneficiaries." }, "request_tax_undertaking": { "type": "boolean", "description": "An intending trustee also applies to Cabinet for a s.81 undertaking." }, "tax_undertaking_term_years": { "type": "integer", "description": "At most 50 from creation (s.81); required if request_tax_undertaking is true." } }, "required": [ "entity_type", "trust_name", "settlor", "intended_trustees", "beneficiaries", "no_islands_resident_beneficiaries", "intended_creation_date" ], "description": "Submits the draft trust instrument to the Registrar of Trusts before signing, so the trust can be approved for registration, and a tax undertaking given, under Trusts Act s.82. The approval takes effect only if the trust is created in line." }, "Create_ky_exempted_trust_draft_file": { "type": "object", "properties": { "type": { "const": "ky.exempted_trust_draft.file" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_trust_draft_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit a draft trust for approval before execution", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "draft_trust_instrument", "title": "Draft document recording the trusts, powers and provisions", "source": "uploaded", "required": true }, { "key": "submission_letter", "title": "Submission letter to the Registrar of Trusts", "source": "generated", "required": true }, { "key": "settlor_exemption_request", "title": "Settlor's written request under s.83", "source": "generated", "required": false }, { "key": "tax_undertaking_application", "title": "Intending trustee's application for a tax undertaking", "source": "generated", "required": false }, { "key": "draft_approval_letter", "title": "Registrar's approval of the draft and any undertaking", "source": "registry_issued", "required": true } ], "people": [ { "role": "settlor", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "submission_letter", "signer_role": "settlor", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "settlor_exemption_request", "signer_role": "settlor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tax_undertaking_application", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "General Registry", "form": "Submission of the draft trust document before execution", "channel": "both", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "islands_resident_beneficiary", "type": null, "when": "A beneficiary is or is likely to be resident or domiciled in the Islands and is not an object of a charitable trust or power." }, { "code": "registrar_declined", "type": null, "when": "The Registrar declines to approve the draft, which it may do without reasons (s.74)." }, { "code": "creation_date_outside_window", "type": null, "when": "intended_creation_date is over 28 days after expected approval." }, { "code": "tax_undertaking_term_missing", "type": null, "when": "request_tax_undertaking is true without a term of at most 50 years." } ] } }, "Params_ky_fit_and_proper_determination_request": { "type": "object", "properties": { "society_type": { "type": "string", "enum": [ "credit_union", "building_society" ], "description": "credit_union for a co-operative society that will carry on credit union business; building_society for a society to be incorporated under the Building.", "examples": [ "credit_union" ] }, "name": { "type": "string", "description": "Proposed registered name.", "examples": [ "Little Cayman Savers Cooperative Credit Union Limited" ] }, "proposed_directors": { "type": "array", "items": {}, "description": "Array of person_ref for every proposed director or committee member.", "examples": [ "[\"per_8Kd2Lq\",\"per_4Nm7Xa\",\"per_9Tz3Wc\"]" ] }, "proposed_managers": { "type": "array", "items": {}, "description": "Array of person_ref for each proposed manager, if different from the directors.", "examples": [ "[]" ] }, "proposed_senior_officers": { "type": "array", "items": {}, "description": "Array of person_ref for each proposed senior officer.", "examples": [ "[\"per_2Pq6Rs\"]" ] }, "business_plan_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the business plan covering proposed staffing, systems, controls and risk management.", "examples": [ "doc_5Hj1Vb" ] }, "policies_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the policies and procedures that ensure compliance with the relevant Act and regulations.", "examples": [ "doc_7Ym4Kd" ] }, "rules_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the draft member rules.", "examples": [ "doc_3Cx9Ne" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva for the applicants.", "examples": [ "per_8Kd2Lq" ] } }, "required": [ "society_type", "name", "proposed_directors", "proposed_senior_officers", "business_plan_document", "policies_document", "authorised_representative" ], "description": "Before the Registrar can register a credit union or incorporate a building society, CIMA must determine that the proposed directors and senior officers are fit and proper. This action assembles the officer pack, the business plan, policies." }, "Create_ky_fit_and_proper_determination_request": { "type": "object", "properties": { "type": { "const": "ky.fit_and_proper_determination.request" }, "params": { "$ref": "#/components/schemas/Params_ky_fit_and_proper_determination_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request CIMA's fit-and-proper determination for a proposed credit union or building society", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "cooperative_society", "building_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_to_authority", "title": "Application to CIMA for a fit-and-proper determination", "source": "generated", "required": true }, { "key": "business_plan", "title": "Business plan", "source": "uploaded", "required": true }, { "key": "policies_and_procedures", "title": "Policies and procedures", "source": "uploaded", "required": true }, { "key": "member_rules", "title": "Draft member rules", "source": "generated", "required": true }, { "key": "personal_questionnaire", "title": "CIMA personal questionnaire", "source": "generated", "required": true }, { "key": "financial_reference", "title": "Financial reference", "source": "uploaded", "required": true }, { "key": "character_references", "title": "Character references", "source": "uploaded", "required": true }, { "key": "police_clearance_certificate", "title": "Police clearance certificate", "source": "uploaded", "required": true }, { "key": "cima_determination", "title": "CIMA fit-and-proper determination and non-objection letter", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "personal_questionnaire", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "application_to_authority", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Application in the prescribed form for a fit-and-proper determination", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "officer_pack_incomplete", "type": "requirement_error", "when": "A proposed director, manager or senior officer is missing a questionnaire, financial reference, two character references or a police clearance certificate." }, { "code": "society_type_unsupported", "type": "invalid_request_error", "when": "society_type is not credit_union or building_society." }, { "code": "no_senior_officer", "type": "requirement_error", "when": "proposed_senior_officers is empty." }, { "code": "proposed_officer_not_fit_and_proper", "type": "registry_error", "when": "CIMA determines that a proposed director or senior officer is not fit and proper." }, { "code": "sanctions_alert_open", "type": "requirement_error", "when": "An open sanctions alert on a proposed officer pauses the action." } ] } }, "Params_ky_foreign_company_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Must be foreign_company." }, "name": { "type": "string", "description": "Name as registered at home." }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 code plus region, for example US-DE." }, "home_registration_number": { "type": "string", "description": "Registration number with the home authority." }, "incorporation_date": { "type": "string", "format": "date", "description": "Date of incorporation or formation at home." }, "home_registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office at home." }, "place_of_business_start_date": { "type": "string", "format": "date", "description": "Date it set up a place of business or began business in the Islands; starts the one-month clock (ss.183, 184)." }, "cayman_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Place of business in the Islands, if any." }, "nature_of_cayman_business": { "type": "string", "description": "What it does in the Islands." }, "liability_limited": { "type": "boolean", "description": "If true it must say so on Cayman stationery and premises." }, "directors": { "type": "array", "items": {}, "description": "person_ref of each director for the s.184 list." }, "cayman_process_agents": { "type": "array", "items": {}, "description": "At least one Cayman-resident person_ref authorised to accept service (s.184)." }, "good_standing_basis": { "type": "string", "enum": [ "certificate_of_good_standing", "director_declaration" ], "description": "director_declaration only if the home authority issues no certificates (s.184)." }, "express": { "type": "boolean", "description": "Pay the CI$500 express fee." } }, "required": [ "entity_type", "name", "home_jurisdiction", "home_registration_number", "incorporation_date", "home_registered_office", "place_of_business_start_date", "nature_of_cayman_business", "liability_limited", "directors", "cayman_process_agents", "good_standing_basis" ], "description": "Registers an overseas company that has established a place of business, or started business, in the Cayman Islands. The filing is due within one month." }, "Create_ky_foreign_company_register": { "type": "object", "properties": { "type": { "const": "ky.foreign_company.register" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a foreign company under Part 9 of the Companies Act", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "certified_certificate_of_incorporation", "title": "Certified certificate of formation or incorporation", "source": "uploaded", "required": true }, { "key": "certificate_of_good_standing", "title": "Certificate of good standing dated within one month before delivery", "source": "uploaded", "required": false }, { "key": "director_good_standing_declaration", "title": "Director's declaration of good standing", "source": "generated", "required": false }, { "key": "certified_constitution", "title": "Certified charter, bye-laws or memorandum and articles filed at home", "source": "uploaded", "required": true }, { "key": "list_of_directors", "title": "List of directors", "source": "generated", "required": true }, { "key": "process_agent_acceptance", "title": "Acceptance by each Cayman process agent", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising registration and the process agents", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart to individuals", "source": "uploaded", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "process_agent", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_good_standing_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "process_agent_acceptance", "signer_role": "process_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Section 184", "channel": "online", "government_fee": { "amount": 1500, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "good_standing_stale", "type": null, "when": "Certificate or declaration is dated over one month before delivery." }, { "code": "certified_copy_not_acceptable", "type": null, "when": "A copy is not certified by the authority, a notary, a lawyer or another person the Registrar accepts." }, { "code": "process_agent_not_resident", "type": null, "when": "A process agent is not resident in the Islands." }, { "code": "filing_window_exceeded", "type": null, "when": "place_of_business_start_date is over a month ago; the s.193 penalty applies." } ] } }, "Params_ky_foreign_lp_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_lp" ], "description": "Must be foreign_lp." }, "name": { "type": "string", "description": "Name as formed abroad, plus any dual foreign and translated name (s.42)." }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 code plus region." }, "formation_date": { "type": "string", "format": "date", "description": "Date of formation abroad." }, "is_separate_legal_person": { "type": "boolean", "description": "Whether it is a separate legal person at home (s.42)." }, "controlling_person": { "type": "string", "pattern": "^per_", "description": "Managing member or controller if a separate legal person and not a listed GP (s.42)." }, "home_registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office at home (s.42)." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref of each general partner, if any (s.42)." }, "cayman_process_agents": { "type": "array", "items": {}, "description": "At least one Cayman-resident person_ref authorised to accept service (s.42)." }, "good_standing_basis": { "type": "string", "enum": [ "certificate_of_good_standing", "authorised_person_declaration" ], "description": "authorised_person_declaration only if the home authority cannot issue a certificate (s.42)." }, "target_elp": { "type": "string", "pattern": "^ent_", "description": "The ELP it will act as GP of, if already registered." }, "express": { "type": "boolean", "description": "Pay the CI$500 express fee." } }, "required": [ "entity_type", "name", "home_jurisdiction", "formation_date", "is_separate_legal_person", "home_registered_office", "cayman_process_agents", "good_standing_basis" ], "description": "Registers a limited partnership or LLP formed in a recognised jurisdiction so it can act as general partner of a Cayman exempted limited partnership. It names Cayman-resident persons to accept service and pays an annual fee each January." }, "Create_ky_foreign_lp_register": { "type": "object", "properties": { "type": { "const": "ky.foreign_lp.register" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_lp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a foreign limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "certified_certificate_of_formation", "title": "Certified certificate of formation or equivalent", "source": "uploaded", "required": true }, { "key": "certificate_of_good_standing", "title": "Certified good standing certificate dated within one month", "source": "uploaded", "required": false }, { "key": "good_standing_declaration", "title": "Declaration of good standing", "source": "generated", "required": false }, { "key": "foreign_lp_statement", "title": "Statement under s.42", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement or equivalent", "source": "uploaded", "required": true }, { "key": "process_agent_acceptance", "title": "Acceptance by each Cayman process agent", "source": "generated", "required": true }, { "key": "gp_authority_resolution", "title": "GP's authority to register and appoint process agents", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration (s.42)", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "process_agent", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_authority_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "foreign_lp_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "good_standing_declaration", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "process_agent_acceptance", "signer_role": "process_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Registration under ELP Act s.42: certified certificate of formation, good standing certifi", "channel": "online", "government_fee": { "amount": 1500, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "jurisdiction_not_recognised", "type": null, "when": "home_jurisdiction is not prescribed under s.42." }, { "code": "good_standing_stale", "type": null, "when": "Certificate or declaration is dated over one month before delivery." }, { "code": "process_agent_not_resident", "type": null, "when": "A process agent is not resident in the Islands." }, { "code": "controlling_person_missing", "type": null, "when": "A separate legal person names no controlling person or GP." } ] } }, "Params_ky_foundation_company_convert": { "type": "object", "properties": { "objects": { "type": "string", "description": "Objects to state in the altered memorandum (FCA s.4).", "examples": [ "To hold and apply assets for the preservation of coastal heritage sites and related education" ] }, "surplus_assets_disposal": { "type": "string", "description": "Disposal of surplus assets on winding up (FCA s.4).", "examples": [ "To a charitable purpose entity with similar objects chosen by the supervisors" ] }, "members_mode": { "type": "string", "enum": [ "with_members", "no_members" ], "description": "Whether members remain after conversion.", "examples": [ "with_members" ] }, "supervisors": { "type": "array", "items": {}, "description": "Array of {person_id}." }, "founder": { "type": "string", "pattern": "^per_", "description": "The person recorded as founder for CDD and BO purposes.", "examples": [ "per_6Dh1Nk7Sy" ] }, "constitution_template": { "type": "string", "enum": [ "model_schedule_2", "custom" ], "description": "model_schedule_2 uses the FCA Schedule 2 model forms. custom uses constitution_document_id.", "examples": [ "model_schedule_2" ] }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_template is custom." }, "name": { "type": "string", "description": "Optional new name by special resolution (Companies Act s.31); the FCA text reviewed imposes no special wording." }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How the special resolution altering the memorandum, and adopting articles, is passed (Companies Act s.60).", "examples": [ "written_resolution" ] }, "service_level": { "type": "string", "enum": [ "standard" ], "description": "Only standard is offered: the Registry schedule lists no express option for this CI$500 re-registration.", "examples": [ "standard" ] } }, "required": [ "objects", "surplus_assets_disposal", "founder", "resolution_method" ], "description": "Applies, on behalf of the directors and members of an existing company, for the Registrar to declare it a foundation company and issue a new certificate of incorporation containing the declaration (Foundation Companies Act s.5). The." }, "Create_ky_foundation_company_convert": { "type": "object", "properties": { "type": { "const": "ky.foundation_company.convert" }, "params": { "$ref": "#/components/schemas/Params_ky_foundation_company_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register an existing Cayman company as a foundation company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "special_resolution_memorandum", "title": "Special resolution altering the memorandum for foundation status", "source": "generated", "required": true }, { "key": "special_resolution_articles", "title": "Special resolution adopting articles", "source": "generated", "required": false }, { "key": "secretary_appointment_and_consent", "title": "Qualified-person secretary appointment and consent", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "foundation_company_application", "title": "Application for foundation company declaration (FCA s.5)", "source": "generated", "required": true }, { "key": "constitution_custom", "title": "Custom constitution", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation_issued", "title": "New certificate of incorporation with foundation company declaration", "source": "registry_issued", "required": true } ], "people": [ { "role": "founder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_memorandum", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_articles", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "secretary_appointment_and_consent", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "foundation_company_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application", "channel": "online", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foundation_requirements_unmet", "type": null, "when": "requirement_error, 422." }, { "code": "foundation_secretary_not_qualified", "type": null, "when": "requirement_error, 422." }, { "code": "foundation_no_members_no_supervisor", "type": null, "when": "invalid_request_error, 422. members_mode is no_members with no supervisor (FCA s.8)." }, { "code": "written_resolution_not_permitted", "type": null, "when": "requirement_error, 422." }, { "code": "entity_not_eligible", "type": null, "when": "jurisdiction_error, 422." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_foundation_company_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name; must pass Companies Act s.30.", "examples": [ "Seabright Heritage Foundation Company" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action." }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee" ], "description": "A foundation company must be limited by shares or by guarantee, with or without share capital (FCA s.4).", "examples": [ "limited_by_guarantee" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Sets the exempted-company fee band.", "examples": [ "{amount: 0, currency: USD}" ] }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required when liability is limited_by_guarantee.", "examples": [ "{amount: 1, currency: USD}" ] }, "objects": { "type": "string", "description": "The objects, described generally or specifically (FCA s.4).", "examples": [ "To hold and apply assets for the preservation of coastal heritage sites and related education" ] }, "surplus_assets_disposal": { "type": "string", "description": "How surplus assets are disposed of on winding up, in the memorandum directly or by reference to the articles (FCA s.4).", "examples": [ "To a charitable purpose entity with similar objects chosen by the supervisors" ] }, "members_mode": { "type": "string", "enum": [ "with_members", "no_members" ], "description": "A foundation company may have no members if its memorandum permits and it keeps at least one supervisor (FCA s.8).", "examples": [ "no_members" ] }, "founder": { "type": "string", "pattern": "^per_", "description": "The person on whose instructions the company is formed and who endows it.", "examples": [ "per_6Dh1Nk7Sy" ] }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id, role}.", "examples": [ "[{person_id: per_6Dh1Nk7Sy, role: director}]" ] }, "supervisors": { "type": "array", "items": {}, "description": "Array of {person_id}.", "examples": [ "[{person_id: per_2Pl9Vt4Qx}]" ] }, "guardian_or_protectors": { "type": "array", "items": {}, "description": "Array of person_id for any guardian or protector named in the constitution." }, "initial_members": { "type": "array", "items": {}, "description": "Array of {person_id, shares}." }, "beneficiaries": { "type": "array", "items": {}, "description": "Array of {person_id or class_description}.", "examples": [ "[{class_description: Visitors to the supported heritage sites}]" ] }, "duty_to_carry_out_objects": { "type": "boolean", "description": "Whether the memorandum declares a duty to carry out the objects and designates who may enforce it (FCA s.7).", "examples": [ "false" ] }, "constitution_template": { "type": "string", "enum": [ "model_schedule_2", "custom" ], "description": "model_schedule_2 uses the model constitution in FCA Schedule 2. custom uses constitution_document_id and legal review by the partner.", "examples": [ "model_schedule_2" ] }, "constitution_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when constitution_template is custom." }, "initial_endowment": { "type": "object", "description": "{amount, source, source_countries}.", "examples": [ "{amount: {amount: 250000, currency: USD}, source: Sale of the founder's property portfolio, source_countries: [GB]}" ] }, "nature_of_business": { "type": "string", "description": "Activities and countries, for the s.165 declaration and business profile.", "examples": [ "Grant-making and holding of investments, with activities outside the Cayman Islands" ] }, "operations_outside_islands": { "type": "boolean", "description": "The customer confirms operations will be conducted mainly outside the Islands or under a licence, since the company is registered as an exempted company.", "examples": [ "true" ] }, "subscriber_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "Default licensed_partner_nominee.", "examples": [ "licensed_partner_nominee" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "When subscriber_mode is customer: {person_id, shares}." }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no interest, such as a guardian who can appoint or remove directors." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD.", "examples": [ "12-31" ] }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Endowment from the founder's property sale, origin_countries: [GB]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_6Dh1Nk7Sy" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "objects", "surplus_assets_disposal", "founder", "directors", "nature_of_business", "operations_outside_islands", "source_of_funds", "instructing", "countries_of_operation", "beneficial_owners" ], "description": "Incorporates a new company under the Companies Act that the Registrar declares to be a foundation company in its certificate of incorporation (Foundation Companies Act s.5). The memorandum must state it is a foundation company, describe." }, "Create_ky_foundation_company_incorporate": { "type": "object", "properties": { "type": { "const": "ky.foundation_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_foundation_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a Cayman foundation company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds and source of wealth for the endowment", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "constitution_custom", "title": "Custom constitution", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "section_165_declaration", "title": "Exempted company declaration", "source": "generated", "required": true }, { "key": "foundation_company_declaration_request", "title": "Request for the Registrar's foundation company declaration", "source": "generated", "required": true }, { "key": "secretary_appointment_and_consent", "title": "Secretary appointment and consent", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director and supervisor consent to act", "source": "generated", "required": true }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation with foundation company declaration", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "operations_declaration_confirmation", "title": "Operations declaration confirmation", "source": "generated", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "founder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "nominee", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "section_165_declaration", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "operations_declaration_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "founder", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Company registration under the Companies Act with a memorandum meeting Foundation Companie", "channel": "online", "government_fee": { "amount": 1200, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "foundation_requirements_unmet", "type": null, "when": "requirement_error, 422." }, { "code": "foundation_secretary_not_qualified", "type": null, "when": "requirement_error, 422." }, { "code": "foundation_no_members_no_supervisor", "type": null, "when": "invalid_request_error, 422. members_mode is no_members with no supervisor (FCA s.8)." }, { "code": "endowment_notice_pending", "type": null, "when": "requirement_error, 409." }, { "code": "operations_declaration_required", "type": null, "when": "jurisdiction_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409. s.30 refusal or expired reservation." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_friendly_society_register": { "type": "object", "properties": { "name": { "type": "string", "description": "Society name entered on the register with its place of business.", "examples": [ "Bodden Town Mutual Aid Friendly Society" ] }, "purposes": { "type": "string", "description": "All purposes for which the society is established and how its money is to be applied, as the rules must declare.", "examples": [ "To raise a fund by member subscriptions for the mutual relief of members and their families in sickness and old age, and to pay funeral benefits." ] }, "benefits_provided": { "type": "array", "items": {}, "description": "Array of benefit classes.", "examples": [ "[\"sickness\",\"advanced_age\"]" ] }, "other_contingency_description": { "type": "string", "description": "Required when benefits_provided includes other_contingency.", "examples": [ "Funeral expenses of a member" ] }, "district": { "type": "string", "description": "District in which the society is formed.", "examples": [ "Bodden Town" ] }, "meeting_places": { "type": "array", "items": {}, "description": "Array of address objects: every place at which the society intends to hold its meetings.", "examples": [ "[{\"line1\":\"Bodden Town Civic Centre\",\"city\":\"Bodden Town\",\"country\":\"KY\"}]" ] }, "place_of_business": { "$ref": "#/components/schemas/Address", "description": "Place of business entered on the register beside the society's name.", "examples": [ "{\"line1\":\"Bodden Town Civic Centre\",\"city\":\"Bodden Town\",\"postal_code\":\"KY1-1401\",\"country\":\"KY\"}" ] }, "rule_signatories": { "type": "array", "items": {}, "description": "Array of exactly three person_ref for the members who sign the two rules transcripts (s.5).", "examples": [ "[\"per_f1\",\"per_f2\",\"per_f3\"]" ] }, "clerk_or_secretary": { "type": "string", "pattern": "^per_", "description": "The clerk or secretary who countersigns the transcripts and confers with the Registrar if required (s.5-).", "examples": [ "per_f4" ] }, "officers": { "type": "array", "items": {}, "description": "Other officers the society appoints.", "examples": [ "[{\"person\":\"per_f5\",\"office\":\"treasurer\"},{\"person\":\"per_f1\",\"office\":\"president\"}]" ] }, "founding_members": { "type": "array", "items": {}, "description": "Array of person_ref for any further founding members to record on the society's register.", "examples": [ "[]" ] }, "rules_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the society's own draft rules.", "examples": [ "doc_2Ab8Wd" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva.", "examples": [ "per_f4" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "purposes", "benefits_provided", "district", "meeting_places", "place_of_business", "rule_signatories", "clerk_or_secretary", "authorised_representative", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Registers a friendly society by getting the Registrar to certify its rules. Entiva drafts the rules, prepares two transcripts for signature by three members and countersignature by the clerk or secretary, lodges them through the." }, "Create_ky_friendly_society_register": { "type": "object", "properties": { "type": { "const": "ky.friendly_society.register" }, "params": { "$ref": "#/components/schemas/Params_ky_friendly_society_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a friendly society", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "friendly_society" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "proposed_rules", "title": "Proposed rules of the society", "source": "generated", "required": true }, { "key": "rules_transcripts", "title": "Two transcripts of the rules for certification", "source": "generated", "required": true }, { "key": "rules_book", "title": "Society rules book", "source": "generated", "required": true }, { "key": "certified_transcript", "title": "Transcript certified by the Registrar", "source": "registry_issued", "required": true }, { "key": "registrar_certificate", "title": "Registrar's certificate of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "rules_transcripts", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "rules_transcripts", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "General Registry: Registrar of Companies, who is the Registrar for friendly societies", "form": "Two transcripts of the rules signed", "channel": "paper", "government_fee": { "amount": 3.2, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "rules_need_three_signatories", "type": "requirement_error", "when": "rule_signatories does not contain exactly three members (s.5)." }, { "code": "countersignature_missing", "type": "requirement_error", "when": "The clerk or secretary has not countersigned the transcripts (s.5)." }, { "code": "purpose_outside_friendly_society_law", "type": "jurisdiction_error", "when": "The benefits are not mutual relief for contingencies that can be calculated by average (s.3), or the rules are repugnant to the laws of the Islands (s.3)." }, { "code": "meeting_place_outside_district", "type": "invalid_request_error", "when": "A meeting place is outside the district in which the society was formed." }, { "code": "registrar_refused_to_certify", "type": "registry_error", "when": "The Registrar points out repugnant rules and refuses to certify." } ] } }, "Params_ky_general_partnership_form": { "type": "object", "properties": { "firm_name": { "type": "string", "description": "The firm-name under which the business is carried on.", "examples": [ "Bodden & Ebanks Marine Services" ] }, "business_description": { "type": "string", "description": "The business carried on in common with a view to profit (s.3). 'Business' includes every trade, occupation or profession.", "examples": [ "Boat charter and marine maintenance services in Grand Cayman" ] }, "partners": { "type": "array", "items": {}, "description": "At least two partners; a partnership is a relation between persons carrying on business in common (s.3).", "examples": [ "[{\"party\":\"per_g1\",\"capital_contribution\":{\"amount\":25000,\"currency\":\"KYD\"},\"profit_share_percent\":50},{\"party\":\"per_g2\",\"capital_contribution\":{\"amount\":25000,\"currency\":\"KYD\"},\"profit_share_percent\":50}]" ] }, "term": { "type": "string", "enum": [ "at_will", "fixed_term" ], "description": "at_will: any partner may end it on notice. fixed_term: ends on expiry or the stated undertaking.", "examples": [ "at_will" ] }, "end_date": { "type": "string", "format": "date", "description": "Required when term is fixed_term.", "examples": [ "2031-12-31" ] }, "management": { "type": "string", "enum": [ "all_partners", "managing_partner" ], "description": "all_partners: every partner may take part in management (default rule, s.24). managing_partner: one partner manages and the agreement limits the others'.", "examples": [ "all_partners" ] }, "managing_partner": { "type": "string", "pattern": "^per_", "description": "Required when management is managing_partner.", "examples": [ "per_g1" ] }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Where the business is carried on.", "examples": [ "{\"line1\":\"Harbour Drive\",\"city\":\"George Town\",\"postal_code\":\"KY1-1205\",\"country\":\"KY\"}" ] }, "carries_on_business_in_islands": { "type": "boolean", "description": "True if the partnership will carry on a trade or business in the Cayman Islands.", "examples": [ "true" ] }, "trade_and_business_licence": { "type": "string", "enum": [ "held", "to_apply", "not_required" ], "description": "Status of the licence: held, to_apply or not_required.", "examples": [ "to_apply" ] }, "agreement_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the partners' own written agreement.", "examples": [ "doc_8Jn3Kt" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva.", "examples": [ "per_g1" ] } }, "required": [ "firm_name", "business_description", "partners", "term", "management", "principal_place_of_business", "carries_on_business_in_islands", "authorised_representative" ], "description": "Records a Cayman general partnership and generates its written partnership agreement. A general partnership arises from the partners' agreement and is not registered anywhere, so there is no registry filing, no registered office and no." }, "Create_ky_general_partnership_form": { "type": "object", "properties": { "type": { "const": "ky.general_partnership.form" }, "params": { "$ref": "#/components/schemas/Params_ky_general_partnership_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a general partnership", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": true }, { "key": "corporate_partner_authority", "title": "Authority of a corporate partner's signatory", "source": "uploaded", "required": false }, { "key": "trade_and_business_licence", "title": "Trade and Business Licence", "source": "uploaded", "required": false }, { "key": "executed_partnership_agreement", "title": "Executed partnership agreement", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. A general partnership is not registered with the General Registry or any other regis", "form": "Partnership agreement, written or oral", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "too_few_partners", "type": "requirement_error", "when": "fewer than two partners are listed (s.3)." }, { "code": "profit_shares_invalid", "type": "invalid_request_error", "when": "profit_share_percent values are given for some partners but not all, or do not total 100." }, { "code": "end_date_missing", "type": "invalid_request_error", "when": "term is fixed_term and end_date is missing." }, { "code": "managing_partner_not_a_partner", "type": "invalid_request_error", "when": "management is managing_partner and managing_partner is not among the partners." }, { "code": "licence_status_required", "type": "invalid_request_error", "when": "carries_on_business_in_islands is true and trade_and_business_licence is missing." }, { "code": "registered_entity_not_partnership", "type": "jurisdiction_error", "when": "The parties are members of a company or other registered association; the Act says that relation is not a partnership (s.3)." }, { "code": "sanctions_alert_open", "type": "requirement_error", "when": "An open sanctions alert on a partner pauses the action." } ] } }, "Params_ky_llc_register": { "type": "object", "properties": { "name": { "type": "string", "description": "LLC name.", "examples": [ "Northwind Digital LLC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.llc_partnership_name.reserve action." }, "dual_foreign_name": { "type": "string", "description": "Optional dual foreign name; entered only if its translated name conforms (s.6)." }, "initial_members": { "type": "array", "items": {}, "description": "Array of {person_id, interest, contribution}.", "examples": [ "[{person_id: per_9Wa2Ke5Rh, interest: 60%, contribution: {amount: 60000, currency: USD}}, {person_id: per_4Zx7Lc3Tn, interest: 40%, contribution: {amount: 40000, currency: USD}}]" ] }, "management": { "type": "string", "enum": [ "manager_managed", "member_managed" ], "description": "Who manages the LLC under the LLC agreement.", "examples": [ "manager_managed" ] }, "managers": { "type": "array", "items": {}, "description": "Required for manager_managed: array of {person_id or inline person, title}.", "examples": [ "[{person_id: per_9Wa2Ke5Rh, title: manager}]" ] }, "nature_of_business": { "type": "string", "description": "Nature of the business, stated in the registration statement (s.5).", "examples": [ "Software licensing and digital services to clients outside the Cayman Islands" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Date of the end of the financial year, MM-DD, stated in the registration statement (s.5).", "examples": [ "12-31" ] }, "term": { "type": "object", "description": "Omit for unlimited duration." }, "no_business_with_public_declaration": { "type": "boolean", "description": "The customer confirms the LLC will not undertake business with the public in the Islands other than as necessary for its business outside the Islands (s.5).", "examples": [ "true" ] }, "llc_agreement_source": { "type": "string", "enum": [ "entiva_template", "uploaded" ], "description": "entiva_template generates the LLC agreement for signature. uploaded uses llc_agreement_document_id.", "examples": [ "entiva_template" ] }, "llc_agreement_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when llc_agreement_source is uploaded." }, "forming_person_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "Who signs the registration statement as the person forming the LLC (s.5).", "examples": [ "licensed_partner_nominee" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no interest." }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Members' capital contributions from savings, origin_countries: [US]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_9Wa2Ke5Rh" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500: same working day if received by 12 noon.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "initial_members", "management", "nature_of_business", "financial_year_end", "no_business_with_public_declaration", "source_of_funds", "instructing", "countries_of_operation", "members", "beneficial_owners" ], "description": "Registers a limited liability company under the LLC Act by filing a registration statement signed by or on behalf of the persons forming it. The LLC agreement stays private." }, "Create_ky_llc_register": { "type": "object", "properties": { "type": { "const": "ky.llc.register" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a Cayman limited liability company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "llc_agreement_upload", "title": "LLC agreement", "source": "uploaded", "required": false }, { "key": "llc_registration_statement", "title": "LLC registration statement", "source": "generated", "required": true }, { "key": "llc_agreement", "title": "LLC agreement", "source": "generated", "required": false }, { "key": "manager_consent_to_act", "title": "Manager consent to act", "source": "generated", "required": false }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "no_business_with_public_confirmation", "title": "No business with public confirmation", "source": "generated", "required": true }, { "key": "cap_llc_filing", "title": "Cap llc filing", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "llc_registration_statement", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "llc_agreement", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "manager_consent_to_act", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "no_business_with_public_confirmation", "signer_role": "member", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_llc_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "LLC registration statement under Limited Liability Companies Act s.5", "channel": "online", "government_fee": { "amount": 900, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "llc_no_member", "type": null, "when": "invalid_request_error, 422. initial_members is empty; an LLC needs at least one member at all times (s.5)." }, { "code": "llc_declaration_required", "type": null, "when": "jurisdiction_error, 422. no_business_with_public_declaration is false or missing (s.5)." }, { "code": "llc_name_invalid", "type": null, "when": "invalid_request_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "manager_required", "type": null, "when": "requirement_error, 422. management is manager_managed with no manager named." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_llc_partnership_name_reserve": { "type": "object", "properties": { "name": { "type": "string", "description": "Proposed name.", "examples": [ "Northwind Ventures I, L.P." ] }, "intended_entity_type": { "type": "string", "enum": [ "llc", "elp", "lp", "llp", "foreign_lp" ], "description": "Entity the name is for.", "examples": [ "elp" ] }, "reservation_period": { "type": "string", "enum": [ "shortest", "1_month", "2_months", "3_months", "maximum" ], "description": "How long to reserve. shortest is 7 days or 1 week; maximum is 120 days or 4 months.", "examples": [ "maximum" ] }, "renews_reservation_id": { "type": "string", "description": "Id of an earlier reservation for the same name, to renew on or before expiry.", "examples": [ "act_1R4kZp8Qe2" ] } }, "required": [ "name", "intended_entity_type", "reservation_period" ], "description": "Reserves a name for a limited liability company, exempted limited partnership, Partnership Act limited partnership, limited liability partnership or foreign limited partnership. The period is up to 120 days or four months, and the." }, "Create_ky_llc_partnership_name_reserve": { "type": "object", "properties": { "type": { "const": "ky.llc_partnership_name.reserve" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_partnership_name_reserve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reserve a Cayman LLC, ELP, LP, LLP or foreign LP name", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "llc", "elp", "lp", "llp", "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_application", "title": "Name reservation application", "source": "generated", "required": true }, { "key": "name_reservation_confirmation", "title": "Registry reservation confirmation and expiry date", "source": "registry_issued", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Name reservation under LLC Act s.6", "channel": "online", "government_fee": { "amount": 30, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "name_suffix_invalid", "type": null, "when": "invalid_request_error, 422." }, { "code": "name_restricted_word", "type": null, "when": "invalid_request_error, 422." }, { "code": "reservation_period_invalid", "type": null, "when": "invalid_request_error, 422." }, { "code": "reservation_not_renewable", "type": null, "when": "invalid_request_error, 422. renews_reservation_id points to a different name or an expired reservation." }, { "code": "registry_unavailable", "type": null, "when": "registry_error, 503." } ] } }, "Params_ky_llp_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llp" ], "description": "Must be llp." }, "name": { "type": "string", "description": "The suffix LLP is optional (s.8)." }, "name_reservation_action_id": { "type": "string", "description": "Completed name reservation." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office in the Islands (ss.9, 18)." }, "nature_of_business": { "type": "string", "description": "Nature of the business (s.18)." }, "partners": { "type": "array", "items": {}, "description": "At least two (s.4)." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD (s.18)." }, "term_years": { "type": "integer", "description": "Fixed term; omit for unlimited (s.18)." }, "special_economic_zone_business": { "type": "boolean", "description": "True for SEZ business." }, "express": { "type": "boolean", "description": "Pay the CI$500 express fee." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "entity_type", "name", "registered_office", "nature_of_business", "partners", "financial_year_end", "countries_of_operation", "members", "beneficial_owners" ], "description": "Registers a Cayman LLP by delivering a registration statement. The LLP is formed when the Registrar issues the certificate of registration." }, "Create_ky_llp_register": { "type": "object", "properties": { "type": { "const": "ky.llp.register" }, "params": { "$ref": "#/components/schemas/Params_ky_llp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a limited liability partnership", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "llp_registration_statement", "title": "Registration statement", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": true }, { "key": "managing_partner_entity_certificates", "title": "Incorporation or registration and good standing certificates of an entity managing partner", "source": "uploaded", "required": false }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration (s.18)", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "llp_registration_statement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Registration statement", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "partners_below_minimum", "type": null, "when": "Fewer than two partners (s.4)." }, { "code": "name_unavailable", "type": null, "when": "Name barred by s.8A or too like an existing partnership." }, { "code": "sez_name_missing", "type": null, "when": "SEZ business without 'Special Economic Zone' or 'SEZ' in the name." }, { "code": "managing_partner_entity_documents_missing", "type": null, "when": "An entity managing partner has no incorporation or registration and good standing certificates." } ] } }, "Params_ky_local_companies_control_licence_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "ordinary_resident_company", "foreign_company" ], "description": "Entity type." }, "route": { "type": "string", "enum": [ "lccl", "cabinet_exemption" ], "description": "lccl: Board licence. cabinet_exemption: Cabinet exemption in exceptional circumstances in the public interest (s.4)." }, "business_description": { "type": "string", "description": "Business carried on and proposed (s.10)." }, "caymanian_share_percent": { "type": "number", "description": "Percent of shares beneficially owned by Caymanians; at least 60 to comply (s.5)." }, "caymanian_director_percent": { "type": "number", "description": "Percent of directors who are Caymanian; at least 60 to comply (s.5)." }, "caymanian_participation_efforts": { "type": "string", "description": "Efforts to obtain Caymanian participation (s.11)." }, "additional_residents_required": { "type": "integer", "description": "People from outside the Islands who would need to reside there (s.11)." }, "requested_term_years": { "type": "integer", "description": "Licence term; over 12 needs Cabinet consent (s.11)." }, "exemption_grounds": { "type": "string", "description": "Required if route is cabinet_exemption (s.4)." }, "financial_plan_summary": { "type": "string", "description": "Finances and feasibility (s.11)." } }, "required": [ "entity_type", "route", "business_description", "caymanian_share_percent", "caymanian_director_percent", "caymanian_participation_efforts" ], "description": "Applies to the Trade and Business Licensing Board for a Local Companies Licence, or to Cabinet for an exemption, so a company that is not Caymanian controlled can carry on business in the Islands. No licence is needed if the company is." }, "Create_ky_local_companies_control_licence_apply": { "type": "object", "properties": { "type": { "const": "ky.local_companies_control_licence.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_local_companies_control_licence_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a Local Companies Licence or Cabinet exemption", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "ordinary_resident_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "lccl_application", "title": "Application in the Board's specified form", "source": "generated", "required": true }, { "key": "constitution", "title": "Copy of memorandum and articles (s.10)", "source": "uploaded", "required": true }, { "key": "nature_of_business_statement", "title": "Statement of business carried on and proposed (s.10)", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart with Caymanian status evidence (s.11)", "source": "uploaded", "required": true }, { "key": "business_plan_and_financials", "title": "Business plan and financial projections", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "lccl_licence", "title": "Licence or Cabinet exemption", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lccl_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "DCI, Trade and Business Licensing Board", "form": "Application under Local Companies", "channel": "both", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "licence_not_required", "type": null, "when": "Caymanian controlled with at least 60% Caymanian shares and directors." }, { "code": "exemption_grounds_missing", "type": null, "when": "route is cabinet_exemption without exemption_grounds." }, { "code": "term_exceeds_limit", "type": null, "when": "requested_term_years is over 12." }, { "code": "ownership_not_established", "type": null, "when": "The chart does not trace control to individuals." } ] } }, "Params_ky_lp_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "Must be lp." }, "name": { "type": "string", "description": "Must end 'Limited Partnership', 'L.P.' or 'LP' and not match an existing LP, LLP or ELP." }, "name_reservation_action_id": { "type": "string", "description": "Completed name reservation." }, "nature_of_business": { "type": "string", "description": "General nature of the business (s.49)." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office in the Islands (s.49,)." }, "general_partners": { "type": "array", "items": {}, "description": "Items {person: person_ref, place_of_residence: address}." }, "limited_partners": { "type": "array", "items": {}, "description": "Items {person: person_ref, capital_contribution: money} (s.49-)." }, "cash_contribution_confirmed": { "type": "boolean", "description": "Confirms each contribution was actually and in good faith paid in cash (s.49)." }, "commencement_date": { "type": "string", "format": "date", "description": "Date the partnership commences (s.49)." }, "term_years": { "type": "integer", "description": "Fixed term in years; omit for none." }, "express": { "type": "boolean", "description": "Pay the CI$500 express fee." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "name", "nature_of_business", "registered_office", "general_partners", "limited_partners", "cash_contribution_confirmed", "commencement_date", "countries_of_operation", "beneficial_owners" ], "description": "Registers a local limited partnership by filing a Voluntary Declarations Act declaration signed by all general partners. The LP is not formed until the declaration is filed and its contents are published in the Gazette." }, "Create_ky_lp_register": { "type": "object", "properties": { "type": { "const": "ky.lp.register" }, "params": { "$ref": "#/components/schemas/Params_ky_lp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "limited_partnership_declaration", "title": "Declaration of all general partners", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": false }, { "key": "kyb_documents", "title": "Corporate GP or LP incorporation, good standing and ownership chart", "source": "uploaded", "required": false }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true }, { "key": "gazette_notice", "title": "Gazette notice", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "limited_partnership_declaration", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Declaration under the Voluntary Declarations Act", "channel": "paper", "government_fee": { "amount": 850, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_suffix_invalid", "type": null, "when": "Name does not end with Limited Partnership, L.P. or LP." }, { "code": "name_unavailable", "type": null, "when": "Name matches or nearly matches an existing LP, LLP or ELP." }, { "code": "declaration_incomplete", "type": null, "when": "A GP has not sworn the declaration before a JP or notary." }, { "code": "cash_contribution_unconfirmed", "type": null, "when": "A limited partner has no cash contribution confirmed." } ] } }, "Params_ky_mutual_fund_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_spc", "llc", "elp" ], "description": "Fund vehicle type." }, "fund_category": { "type": "string", "enum": [ "registered_fund", "master_fund", "limited_investor_fund", "administered_fund" ], "description": "registered_fund s.4, form APP-101-22; master_fund s.4, APP-101-53; limited_investor_fund s.4, APP-101-79; administered_fund s.4, APP-101-22." }, "fund_name": { "type": "string", "description": "Must match the offering document and certificate; a mismatch is a common CIMA rejection." }, "minimum_investment": { "$ref": "#/components/schemas/Money", "description": "Registered and master funds need at least CI$80,000 or equivalent per investor unless listed (s.4)." }, "listed_exchange": { "type": "string", "description": "Gazetted exchange if relying on listing instead (s.4)." }, "investor_count": { "type": "integer", "description": "Limited investor fund: at most 15 investors, a majority able to appoint or remove the operator (s.4)." }, "sub_fund_count": { "type": "integer", "description": "Number of sub-funds; CI$750 each." }, "principal_office_address": { "$ref": "#/components/schemas/Address", "description": "Administered fund: principal office in the Islands provided by the licensed administrator (s.4)." }, "administrator": { "type": "object", "description": "{name, cima_licence_number} of the administrator whose consent letter is filed." }, "auditor_name": { "type": "string", "description": "CIMA-approved auditor for local audit sign-off." }, "operators": { "type": "array", "items": {}, "description": "person_ref of each director, GP or manager." }, "mlro": { "type": "string", "pattern": "^per_", "description": "MLRO on form MLO-154-99." }, "deputy_mlro": { "type": "string", "pattern": "^per_", "description": "Deputy MLRO on form MLO-154-99." }, "offering_document_status": { "type": "string", "enum": [ "final", "exemption_requested" ], "description": "final: current offering document filed. exemption_requested: CIMA asked to exempt filing (s.4,)." }, "investment_manager": { "type": "string", "description": "If any; must be authorised under the Securities Investment Business Act." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "entity_type", "fund_category", "fund_name", "administrator", "auditor_name", "operators", "mlro", "deputy_mlro", "offering_document_status", "financial_year_end", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a Cayman mutual fund with CIMA through REEFS under the Mutual Funds Act: a registered fund (s.4), master fund, limited investor fund (s.4) or administered fund (s.4). Licensed funds (s.4) use ky.mutual_fund.license." }, "Create_ky_mutual_fund_register": { "type": "object", "properties": { "type": { "const": "ky.mutual_fund.register" }, "params": { "$ref": "#/components/schemas/Params_ky_mutual_fund_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a mutual fund with CIMA", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "reefs_application_form", "title": "REEFS form APP-101-22, -53 or -79 with MLRO form MLO-154-99", "source": "generated", "required": true }, { "key": "electronic_records_affidavit", "title": "Affidavit for electronic records", "source": "generated", "required": true }, { "key": "certified_certificate_of_incorporation", "title": "Certified certificate of incorporation or registration", "source": "uploaded", "required": true }, { "key": "administrator_letter_of_consent", "title": "Administrator's letter of consent", "source": "uploaded", "required": true }, { "key": "auditor_letter_of_consent", "title": "Auditor's letter of consent", "source": "uploaded", "required": true }, { "key": "offering_document", "title": "Offering document", "source": "uploaded", "required": false }, { "key": "constitutional_documents_extract", "title": "Certified extract showing a majority of investors can appoint or remove the operator", "source": "uploaded", "required": false }, { "key": "drla_evidence", "title": "DRLA registration or licence evidence for each director", "source": "uploaded", "required": true }, { "key": "filing_authorisation_letter", "title": "Operator's written authorisation for the service provider to file", "source": "generated", "required": true }, { "key": "cima_registration_confirmation", "title": "CIMA registration confirmation", "source": "registry_issued", "required": true }, { "key": "reefs_submission", "title": "Authenticated REEFS submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "aml_officer", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "electronic_records_affidavit", "signer_role": "other", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "filing_authorisation_letter", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reefs_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "REEFS application APP-101-22", "channel": "online", "government_fee": { "amount": 4125, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "minimum_investment_below_threshold", "type": null, "when": "Registered or master fund below CI$80,000 and not listed." }, { "code": "investor_cap_exceeded", "type": null, "when": "Limited investor fund with over 15 investors or no majority able to appoint or remove the operator." }, { "code": "administrator_not_licensed", "type": null, "when": "Administrator is not a licensed mutual fund administrator." }, { "code": "director_not_drla_compliant", "type": null, "when": "A director is not DRLA registered or licensed." } ] } }, "Params_ky_name_reserve": { "type": "object", "properties": { "name": { "type": "string", "description": "Proposed company name in the Roman alphabet or Arabic numerals.", "examples": [ "Northwind Holdings Ltd." ] }, "intended_entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity the name is for.", "examples": [ "exempted_company" ] }, "reservation_period": { "type": "string", "enum": [ "1_week", "1_month", "2_months", "3_months", "4_months" ], "description": "How long to reserve the name.", "examples": [ "1_month" ] }, "renews_reservation_id": { "type": "string", "description": "Id of an earlier ky.name.reserve action for the same name.", "examples": [ "act_1R4kZp8Qe2" ] } }, "required": [ "name", "intended_entity_type", "reservation_period" ], "description": "Reserves a proposed company name with the General Registry for up to four months under Companies Act s.29A, so it can be used for an exempted company, LDC, SPC, SEZC, ordinary resident or non-resident company, or foundation company.." }, "Create_ky_name_reserve": { "type": "object", "properties": { "type": { "const": "ky.name.reserve" }, "params": { "$ref": "#/components/schemas/Params_ky_name_reserve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reserve a Cayman company name", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_application", "title": "Name reservation application", "source": "generated", "required": true }, { "key": "name_reservation_confirmation", "title": "Registry reservation confirmation and expiry date", "source": "registry_issued", "required": false } ], "people": [ { "role": "filing_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Name reservation application under Companies Act s.29A, filed electronically on CAP", "channel": "online", "government_fee": { "amount": 40, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "name_restricted_word", "type": null, "when": "invalid_request_error, 422." }, { "code": "name_suffix_invalid", "type": null, "when": "invalid_request_error, 422." }, { "code": "reservation_not_renewable", "type": null, "when": "invalid_request_error, 422. renews_reservation_id points to an action for a different name, or one that has already expired and been released." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "registry_unavailable", "type": null, "when": "registry_error, 503." } ] } }, "Params_ky_npo_register": { "type": "object", "properties": { "name_as_constituted": { "type": "string", "description": "Name exactly as spelt in the constitutional document: memorandum and articles for a company, trust deed for a trust, partnership agreement, or the enabling.", "examples": [ "Cayman Youth Swim Association" ] }, "purposes": { "type": "array", "items": {}, "description": "Declared purposes, at least one of: charitable, philanthropic, religious, cultural, educational, social, fraternal, public_benefit_other.", "examples": [ "[\"educational\",\"social\"]" ] }, "purposes_summary": { "type": "string", "description": "Short description of purposes and activities for the application form.", "examples": [ "Teaches swimming and water safety to children in Grand Cayman and runs inter-school competitions." ] }, "solicits_contributions": { "type": "boolean", "description": "True if the entity solicits contributions or raises funds from the public or a section of the public, in the Islands or elsewhere (s.2 limb).", "examples": [ "true" ] }, "fundraising_methods": { "type": "array", "items": {}, "description": "Array of strings: how funds are or will be raised.", "examples": [ "[\"membership subscriptions\",\"annual gala\",\"corporate sponsorship\"]" ] }, "use_of_funds": { "type": "string", "description": "How contributions are or will be applied (Schedule to the NPO Law, items-).", "examples": [ "Pool hire, coaching fees and equipment. No funds are sent outside the Islands." ] }, "funds_sent_outside_islands": { "type": "boolean", "description": "Whether any funds will be remitted outside the Islands.", "examples": [ "false" ] }, "expected_annual_income": { "$ref": "#/components/schemas/Money", "description": "Expected gross annual income.", "examples": [ "{\"amount\":120000,\"currency\":\"KYD\"}" ] }, "share_of_income_remitted_abroad_percent": { "type": "number", "description": "Percentage of gross annual income expected to be remitted outside the Islands.", "examples": [ "0" ] }, "connection_with_islands": { "type": "object", "description": "Facts the Registrar uses to decide whether the NPO has a connection with the Islands (s.7; Registration Application Regulations reg 6).", "examples": [ "{\"physical_presence\":\"premises\",\"registered_office_holds_books\":false,\"soliciting_in_islands\":true,\"distributing_in_islands\":true}" ] }, "address": { "$ref": "#/components/schemas/Address", "description": "Physical address, P.O.", "examples": [ "{\"line1\":\"Aquatic Centre, Crewe Road\",\"po_box\":\"1234\",\"city\":\"George Town\",\"postal_code\":\"KY1-1100\",\"country\":\"KY\"}" ] }, "contact": { "type": "object", "description": "Shape: {email, phone, website}.", "examples": [ "{\"email\":\"admin@caymanswim.example\",\"phone\":\"+13459490000\"}" ] }, "controllers": { "type": "array", "items": {}, "description": "Array of person_ref for the controllers: trustees, directors, general partners, managers or a society's responsible officers.", "examples": [ "[\"per_n1\",\"per_n2\"]" ] }, "senior_officers": { "type": "array", "items": {}, "description": "Array of person_ref for other senior officers or members of management personnel.", "examples": [ "[\"per_n3\"]" ] }, "bank": { "type": "object", "description": "Banking arrangements (Schedule item).", "examples": [ "{\"bank_name\":\"Cayman National Bank\",\"account_status\":\"open\",\"account_in_islands\":true}" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day of the financial year end, MM-DD.", "examples": [ "12-31" ] }, "constitution_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the constitutional document.", "examples": [ "doc_9Cd5Fw" ] }, "duty_waiver_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of any existing duty waiver or exemption.", "examples": [ "doc_1Kp7Zs" ] }, "exempt_override": { "type": "boolean", "description": "Set true to register voluntarily although the entity is exempt from registration under s.21.", "examples": [ "false" ] }, "express": { "type": "boolean", "description": "True to pay the express fee so the Registrar concludes within fifteen business days instead of thirty days (s.7).", "examples": [ "false" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva.", "examples": [ "per_n1" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" } }, "required": [ "name_as_constituted", "purposes", "purposes_summary", "solicits_contributions", "fundraising_methods", "use_of_funds", "funds_sent_outside_islands", "expected_annual_income", "connection_with_islands", "address", "contact", "controllers", "bank", "financial_year_end", "constitution_document", "authorised_representative", "name", "nature_of_business", "countries_of_operation", "directors", "members", "shareholders", "share_classes" ], "description": "Registers an existing Cayman entity as a non-profit organisation. An NPO may not solicit contributions or raise funds from the public until registered." }, "Create_ky_npo_register": { "type": "object", "properties": { "type": { "const": "ky.npo.register" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a non-profit organisation with the Registrar of NPOs", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "constitution", "title": "Constitutional document", "source": "uploaded", "required": true }, { "key": "activities_statement", "title": "Detailed purposes and activities statement", "source": "generated", "required": true }, { "key": "npo_registration_form", "title": "NPO registration form", "source": "generated", "required": true }, { "key": "controllers_acknowledgement", "title": "Controllers and senior officers acknowledgement form", "source": "generated", "required": true }, { "key": "certified_passport_copy", "title": "Certified colour copy of a valid passport", "source": "uploaded", "required": true }, { "key": "bank_evidence", "title": "Evidence of bank account or intended bank", "source": "uploaded", "required": false }, { "key": "duty_waiver", "title": "Existing duty waiver or exemption", "source": "uploaded", "required": false }, { "key": "registrar_decision_notice", "title": "Registrar's written decision", "source": "registry_issued", "required": false }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "npo_registration_form", "signer_role": "beneficial_owner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "controllers_acknowledgement", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_passport_copy", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "npo_registration_form", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry: Registrar of Non-Profit Organisations", "form": "NPO registration form", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_an_npo", "type": "jurisdiction_error", "when": "solicits_contributions is false or the purposes are not within the s.2 definition." }, { "code": "exempt_from_registration", "type": "jurisdiction_error", "when": "The entity is exempt under s.21: for example a DNFBP registered under the AML Regulations, a CIMA-regulated entity, a trust company, a government entity or one exempted by Cabinet." }, { "code": "no_connection_with_islands", "type": "jurisdiction_error", "when": "No physical presence, soliciting or distribution in the Islands (s.7; Regulations reg 6)." }, { "code": "controller_missing", "type": "requirement_error", "when": "controllers is empty." }, { "code": "acknowledgement_missing", "type": "requirement_error", "when": "A named person has not signed the acknowledgement form." }, { "code": "passport_not_certified", "type": "requirement_error", "when": "A passport copy is not a colour copy, is expired, or lacks a certifier's printed name, signature and date." }, { "code": "constitution_missing_required_clauses", "type": "requirement_error", "when": "The constitution lacks the Regulations reg 4 or reg 13 clauses." }, { "code": "name_not_acceptable", "type": "registry_error", "when": "The name differs from the constitutional name, matches another NPO, or contains a restricted word (s.7)." }, { "code": "solicitation_before_registration", "type": "requirement_error", "when": "The customer reports that funds are already being raised from the public." }, { "code": "registrar_deferred", "type": "registry_error", "when": "The Registrar defers the application and asks for more information." }, { "code": "registrar_refused", "type": "registry_error", "when": "The Registrar refuses (s.7)." } ] } }, "Params_ky_ordinary_nonresident_company_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must end with Limited or Ltd. (s.7) and pass s.30.", "examples": [ "Bluewater Services Ltd." ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action." }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee", "unlimited" ], "description": "Default limited_by_shares.", "examples": [ "limited_by_shares" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Sets the fee band: up to CI$42,000 or above (Registry schedule CI$900 and CI$1,140; the statute Sch.5 Pt 1 states CI$675 and CI$915).", "examples": [ "{amount: 50000, currency: USD}" ] }, "share_structure": { "type": "object", "description": "{class_name, par_value, number_of_shares}.", "examples": [ "{class_name: Ordinary, par_value: {amount: 1, currency: USD}, number_of_shares: 50000}" ] }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required when liability is limited_by_guarantee." }, "nature_of_business": { "type": "string", "description": "Business description and the countries it operates in.", "examples": [ "Consulting services provided to clients outside the Cayman Islands" ] }, "financial_secretary_designation_status": { "type": "string", "enum": [ "designation_held", "designation_to_be_obtained" ], "description": "An ordinary non-resident company is one designated as non-resident by the Financial Secretary under s.2 of the Local Companies Act (Companies Act s.2).", "examples": [ "designation_to_be_obtained" ] }, "subscriber_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "Default licensed_partner_nominee.", "examples": [ "licensed_partner_nominee" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "When subscriber_mode is customer: {person_id, shares}." }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id, role}.", "examples": [ "[{person_id: per_7Mn3Bv6Cq, role: director}]" ] }, "officers": { "type": "array", "items": {}, "description": "Optional {person_id, title}." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Array of {person_id, share_class, number_of_shares}.", "examples": [ "[{person_id: per_7Mn3Bv6Cq, share_class: Ordinary, number_of_shares: 50000}]" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no shares." }, "articles_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Default entiva_standard.", "examples": [ "entiva_standard" ] }, "custom_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when articles_template is custom." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD.", "examples": [ "12-31" ] }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Retained earnings of the founder's consulting practice, origin_countries: [AU]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_7Mn3Bv6Cq" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "nature_of_business", "financial_secretary_designation_status", "directors", "initial_shareholders", "source_of_funds", "instructing", "countries_of_operation", "shareholders", "share_classes", "beneficial_owners" ], "description": "Incorporates an ordinary non-resident company: a company designated as non-resident by the Financial Secretary under the Local Companies legislation, registered by filing the memorandum and articles and notice of registered office. The." }, "Create_ky_ordinary_nonresident_company_incorporate": { "type": "object", "properties": { "type": { "const": "ky.ordinary_nonresident_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_ordinary_nonresident_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Cayman ordinary non-resident company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "financial_secretary_designation", "title": "Financial Secretary non-resident designation", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "notice_of_registered_office", "title": "Notice of registered office", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "nominee", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Memorandum and articles with notice of registered office", "channel": "online", "government_fee": { "amount": 900, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "nonresident_designation_missing", "type": null, "when": "requirement_error, 422." }, { "code": "name_suffix_required", "type": null, "when": "invalid_request_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409. s.30 refusal or expired reservation." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_ordinary_resident_company_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must end with Limited or Ltd. (s.7) unless the company is an unlimited company or a s.80 association; must pass s.30.", "examples": [ "Caymanian Coffee Roasters Ltd." ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action." }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee", "unlimited" ], "description": "Default limited_by_shares.", "examples": [ "limited_by_shares" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Sets the fee band: CI$300 up to CI$42,000, CI$500 above (Sch.5 Pt 1).", "examples": [ "{amount: 10000, currency: KYD}" ] }, "share_structure": { "type": "object", "description": "{class_name, par_value, number_of_shares}.", "examples": [ "{class_name: Ordinary, par_value: {amount: 1, currency: KYD}, number_of_shares: 10000}" ] }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required when liability is limited_by_guarantee." }, "nature_of_business": { "type": "string", "description": "Business activity in the Islands.", "examples": [ "Coffee roasting and retail in Grand Cayman" ] }, "registered_office": { "type": "string", "enum": [ "entiva_partner", "own_address" ], "description": "entiva_partner uses Entiva address. own_address uses an address in the Islands given in registered_office_address and requires filing_route principal_cbp.", "examples": [ "entiva_partner" ] }, "registered_office_address": { "$ref": "#/components/schemas/Address", "description": "Required when registered_office is own_address." }, "filing_route": { "type": "string", "enum": [ "licensed_partner_cap", "principal_cbp" ], "description": "licensed_partner_cap: Entiva files on CAP. principal_cbp: a principal or connected person files on the Cayman Business Portal; the Registry verifies that.", "examples": [ "licensed_partner_cap" ] }, "cbp_principal": { "type": "string", "pattern": "^per_", "description": "Required when filing_route is principal_cbp: the director, secretary or other connected person who holds the CBP account." }, "caymanian_beneficial_ownership_percent": { "type": "number", "description": "Percentage of beneficial ownership held by Caymanians.", "examples": [ "60" ] }, "local_companies_control_status": { "type": "string", "enum": [ "not_required", "licence_held", "licence_to_be_applied" ], "description": "Status of any Local Companies Control licence.", "examples": [ "not_required" ] }, "subscriber_mode": { "type": "string", "enum": [ "customer", "licensed_partner_nominee" ], "description": "Default customer for a resident company, as local owners usually subscribe.", "examples": [ "customer" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "Required when subscriber_mode is customer: {person_id, shares} (at least 1 share each, s.7).", "examples": [ "[{person_id: per_5Ty8Uw2Jo, shares: 6000}, {person_id: per_3Qs7Xr1Mk, shares: 4000}]" ] }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id, role}.", "examples": [ "[{person_id: per_5Ty8Uw2Jo, role: director}]" ] }, "officers": { "type": "array", "items": {}, "description": "Optional {person_id, title}." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Array of {person_id, share_class, number_of_shares}.", "examples": [ "[{person_id: per_5Ty8Uw2Jo, share_class: Ordinary, number_of_shares: 6000}, {person_id: per_3Qs7Xr1Mk, share_class: Ordinary, number_of_shares: 4000}]" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no shares." }, "articles_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Default entiva_standard.", "examples": [ "entiva_standard" ] }, "custom_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when articles_template is custom." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD.", "examples": [ "12-31" ] }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Personal savings of the two founders, origin_countries: [KY]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_5Ty8Uw2Jo" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500: same working day if received by 12 noon (s.200); the Registry FAQ describes it as within 24 hours.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "nature_of_business", "caymanian_beneficial_ownership_percent", "local_companies_control_status", "directors", "initial_shareholders", "source_of_funds", "instructing", "countries_of_operation", "shareholders", "share_classes", "beneficial_owners" ], "description": "Incorporates an ordinary resident company that carries on business in the Cayman Islands, by filing the memorandum and articles and the notice of registered office. A CIMA-licensed provider is not mandatory for this entity type." }, "Create_ky_ordinary_resident_company_incorporate": { "type": "object", "properties": { "type": { "const": "ky.ordinary_resident_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_ordinary_resident_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a Cayman ordinary resident company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "ordinary_resident_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_good_standing", "title": "Corporate shareholder: certificate of good standing", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "local_companies_control_licence", "title": "Local Companies Control licence", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "notice_of_registered_office", "title": "Notice of registered office", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": false }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true }, { "key": "cbp_incorporation_filing", "title": "Cbp incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "memorandum_of_association", "signer_role": "filing_agent", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "cbp_incorporation_filing", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Memorandum and articles with notice of registered office", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_suffix_required", "type": null, "when": "invalid_request_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409. s.30 refusal or expired reservation." }, { "code": "local_ownership_not_met", "type": null, "when": "jurisdiction_error, 422." }, { "code": "registered_office_route_invalid", "type": null, "when": "invalid_request_error, 422. registered_office is own_address but filing_route is licensed_partner_cap, or registered_office_address is missing or outside the Islands (s.50)." }, { "code": "cbp_principal_required", "type": null, "when": "" }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_private_fund_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_spc", "llc", "elp" ], "description": "Fund vehicle type." }, "fund_name": { "type": "string", "description": "CIMA may refuse a name identical or confusingly similar to another's, or suggesting Government patronage." }, "restricted_scope_election": { "type": "boolean", "description": "Elect registration as a registered restricted scope private fund, if eligible (s.6)." }, "first_capital_commitment_date": { "type": "string", "format": "date", "description": "Date capital commitments were first accepted; the application is due in 21 days (s.5)." }, "capital_contributions_accepted": { "type": "boolean", "description": "Must be false before registration (s.5)." }, "operators": { "type": "array", "items": {}, "description": "person_ref of each director, GP or manager." }, "administrator": { "type": "object", "description": "{name, jurisdiction, cima_licence_number}; must be independent of the manager." }, "auditor_name": { "type": "string", "description": "CIMA-approved auditor." }, "aiv_count": { "type": "integer", "description": "Alternative investment vehicles; CI$525 each in the annual fee." }, "segregated_portfolio_count": { "type": "integer", "description": "Segregated portfolios if an SPC; CI$525 each." }, "separate_account_count": { "type": "integer", "description": "Classes with separately presented accounts; CI$525 each." }, "exemption_letter_applicable": { "type": "boolean", "description": "True if a CIMA exemption letter is filed." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD; audited accounts go to CIMA within six months (s.13)." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "entity_type", "fund_name", "capital_contributions_accepted", "operators", "auditor_name", "financial_year_end", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a Cayman private fund with CIMA through REEFS. The application is due within 21 days after the fund accepts capital commitments, and it may not accept capital contributions until registered." }, "Create_ky_private_fund_register": { "type": "object", "properties": { "type": { "const": "ky.private_fund.register" }, "params": { "$ref": "#/components/schemas/Params_ky_private_fund_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a private fund with CIMA", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "reefs_application_form", "title": "REEFS form APP-101-77-05", "source": "generated", "required": true }, { "key": "certified_certificate_of_incorporation", "title": "Certified certificate of incorporation or registration", "source": "uploaded", "required": true }, { "key": "offering_memorandum_or_term_summary", "title": "Offering memorandum or summary of terms", "source": "uploaded", "required": true }, { "key": "auditor_letter_of_consent", "title": "Auditor's letter of consent", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Fund structure chart", "source": "uploaded", "required": true }, { "key": "exemption_letter", "title": "CIMA exemption letter, if applicable", "source": "uploaded", "required": false }, { "key": "drla_evidence", "title": "DRLA registration or licence evidence for each director", "source": "uploaded", "required": true }, { "key": "filing_authorisation_letter", "title": "Operator's written authorisation for the service provider to file", "source": "generated", "required": true }, { "key": "cima_registration_confirmation", "title": "CIMA registration confirmation", "source": "registry_issued", "required": true }, { "key": "electronic_records_affidavit", "title": "Affidavit for electronic records", "source": "generated", "required": false }, { "key": "reefs_submission", "title": "Authenticated REEFS submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation_letter", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "electronic_records_affidavit", "signer_role": "other", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "reefs_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "REEFS private fund application APP-101-77-05", "channel": "online", "government_fee": { "amount": 4125, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "contributions_already_accepted", "type": null, "when": "capital_contributions_accepted is true (s.5)." }, { "code": "registration_window_exceeded", "type": null, "when": "First commitments were accepted over 21 days ago." }, { "code": "directors_below_minimum", "type": null, "when": "A company applicant lists fewer than two directors." }, { "code": "director_not_drla_compliant", "type": null, "when": "A director is not DRLA registered or licensed." } ] } }, "Params_ky_private_trust_company_register": { "type": "object", "properties": { "registered_office_provider": { "type": "object", "description": "The company that provides the PTC's registered office and holds a trust licence under s.6 of the Banks and Trust Companies Act (reg 3).", "examples": [ "{\"name\":\"Island Fiduciary Services Ltd.\",\"cima_trust_licence_number\":\"TL-12345\",\"address\":\"Cricket Square, George Town\",\"is_entiva_partner\":true}" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for every director.", "examples": [ "[\"per_p1\",\"per_p2\"]" ] }, "shareholders": { "type": "array", "items": {}, "description": "Array of {holder, shares} for every shareholder or member (reg 4).", "examples": [ "[{\"holder\":\"ent_8Ls2Rm\",\"shares\":1}]" ] }, "no_shareholders_reason": { "type": "string", "description": "Required when shareholders is empty, for example a company limited by guarantee with no shares." }, "principals": { "type": "array", "items": {}, "description": "Array of person_ref for principals not already listed as directors or shareholders: anyone entitled to 10% or more of the voting power over the company or its.", "examples": [ "[\"per_p3\"]" ] }, "owning_trust_parties": { "type": "array", "items": {}, "description": "Array of person_ref for settlor, trustee, protector, enforcer and beneficiaries of any trust that holds the PTC's shares.", "examples": [ "[\"per_p3\",\"per_p4\"]" ] }, "connected_trust_business": { "type": "object", "description": "Attestation that the company conducts only connected trust business and takes no contributions from the public or from persons not connected to each other.", "examples": [ "{\"only_connected_trust_business\":true,\"no_public_solicitation\":true,\"connection_summary\":\"Trusts settled by members of the Ebanks family and their spouses and descendants\"}" ] }, "records_held_at_registered_office": { "type": "boolean", "description": "Confirms the registered office holds, and will keep current, the records reg 3 requires for each relevant trust: terms, trustee, settlor, protector, enforcer.", "examples": [ "true" ] }, "requested_registration_date": { "type": "string", "format": "date", "description": "Date from which the company wants to be registered.", "examples": [ "2026-12-01" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva.", "examples": [ "per_p1" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "registered_office_provider", "directors", "shareholders", "connected_trust_business", "records_held_at_registered_office", "authorised_representative", "name", "nature_of_business", "countries_of_operation", "share_classes", "beneficial_owners" ], "description": "Registers an existing Cayman company with the Cayman Islands Monetary Authority as a private trust company, so it can carry on connected trust business without a trust licence. The registered office must be at a company that holds a trust." }, "Create_ky_private_trust_company_register": { "type": "object", "properties": { "type": { "const": "ky.private_trust_company.register" }, "params": { "$ref": "#/components/schemas/Params_ky_private_trust_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a private trust company with CIMA", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "ordinary_nonresident_company", "ordinary_resident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "ptc_declaration", "title": "PTC registration declaration", "source": "generated", "required": true }, { "key": "identification_pack", "title": "Proof of identification of directors and shareholders", "source": "generated", "required": true }, { "key": "registered_office_confirmation", "title": "Trust licensee's confirmation that it provides the registered office", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "uploaded", "required": true }, { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution to register as a private trust company", "source": "generated", "required": true }, { "key": "filing_authorisation", "title": "Written authorisation to the registered office to file with CIMA", "source": "generated", "required": true }, { "key": "cima_registration_confirmation", "title": "CIMA confirmation of registration", "source": "registry_issued", "required": true }, { "key": "fee_receipt", "title": "Receipt for the registration fee", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "settlor", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ptc_declaration", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ptc_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "Cayman Islands Monetary Authority, Fiduciary Services Division", "form": "Annual declaration in the form CIMA approves, filed at registration with proof of identifi", "channel": "online", "government_fee": { "amount": 3500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "name_missing_ptc_designator", "type": "jurisdiction_error", "when": "The entity's registered name does not contain 'Private Trust Company' or 'PTC' (reg 6)." }, { "code": "no_natural_person_director", "type": "requirement_error", "when": "None of the directors is a natural person." }, { "code": "registered_office_not_trust_licensee", "type": "requirement_error", "when": "The registered office provider does not hold a trust licence (reg 3) or the licence number does not check out on CIMA's register." }, { "code": "non_connected_contributors", "type": "jurisdiction_error", "when": "connected_trust_business shows contributors who are not connected persons, or public solicitation." }, { "code": "entity_not_incorporated_in_cayman", "type": "jurisdiction_error", "when": "The entity is not a company incorporated in the Islands." }, { "code": "id_pack_incomplete", "type": "requirement_error", "when": "A director or shareholder has no verified identification for the pack (reg 4)." }, { "code": "principal_not_fit_and_proper", "type": "registry_error", "when": "CIMA has reasonable grounds to believe a principal is not or has ceased to be fit and proper (reg 4B)." }, { "code": "cima_query", "type": "registry_error", "when": "CIMA asks the registered office for clarification." }, { "code": "cima_refused", "type": "registry_error", "when": "CIMA refuses registration, for example for suspected breach of the AML Regulations (reg 4B)." } ] } }, "Params_ky_registered_office_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "ordinary_resident_company", "lp", "llp" ], "description": "The filing, signer and deadline depend on this." }, "reason": { "type": "string", "enum": [ "initial_notice", "replace_provider" ], "description": "initial_notice if none is on the register; replace_provider for a new provider or address." }, "provider": { "type": "string", "enum": [ "entiva_partner", "other_provider", "self" ], "description": "Who provides the office; defaults to entiva_partner." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Office in the Islands (Companies Act s.50; Partnership Act s.49; LLP Act s.9)." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; starts the filing clock." }, "signatories": { "type": "array", "items": {}, "description": "person_ref list." }, "resolution_date": { "type": "string", "format": "date", "description": "Company on replace_provider: directors' resolution date; certified copy due in 30 days." }, "express": { "type": "boolean", "description": "Pay the CI$150 express filing fee." } }, "required": [ "entity_type", "reason", "provider", "registered_office", "effective_date", "signatories" ], "description": "Records a new or replacement registered office for an ordinary resident company, a Partnership Act LP or an LLP. None of these needs a CIMA-licensee address, but Entiva's Entiva can supply one." }, "Create_ky_registered_office_notify": { "type": "object", "properties": { "type": { "const": "ky.registered_office.notify" }, "params": { "$ref": "#/components/schemas/Params_ky_registered_office_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the registered office", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "ordinary_resident_company", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "approval_resolution", "title": "Directors' resolution or partners' written approval", "source": "generated", "required": true }, { "key": "registered_office_notice", "title": "Company: s.51 notice with certified resolution.", "source": "generated", "required": true }, { "key": "provider_consent_and_engagement", "title": "Provider's consent and engagement terms", "source": "generated", "required": true }, { "key": "filing_confirmation", "title": "Registry confirmation", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "approval_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registered_office_notice", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registered_office_notice", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Company: s.51 notice. LP: declaration", "channel": "both", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "declaration_incomplete", "type": null, "when": "LP: a general partner has not sworn the declaration." }, { "code": "signatories_incomplete", "type": null, "when": "LP: signatories omit a general partner." }, { "code": "filing_window_exceeded", "type": null, "when": "effective_date is past 7 days or 30 days." }, { "code": "address_not_in_islands", "type": null, "when": "The address is outside the Cayman Islands." } ] } }, "Params_ky_registered_office_provide": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp" ], "description": "Exempted and non-resident companies, LLCs and ELPs must use a CIMA licensee's address (Companies Act s.50; LLC Act s.7; ELP Act s.6)." }, "reason": { "type": "string", "enum": [ "initial_notice", "replace_provider" ], "description": "initial_notice if no office notice is on file; replace_provider when changing provider." }, "provider": { "type": "string", "enum": [ "entiva_partner", "other_licensee" ], "description": "Who provides the office." }, "other_licensee": { "type": "object", "description": "Required if provider is other_licensee: {name, licence_type: banks_and_trust | companies_management | mutual_fund_administrator, licence_number}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical and mailing address in the Islands; include the service provider's name." }, "effective_date": { "type": "string", "format": "date", "description": "Date the office takes effect." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director, manager or general partner who approves, or whose mandate authorises signing." }, "resolution_date": { "type": "string", "format": "date", "description": "Companies on replace_provider: date of the directors' resolution; certified copy due within 30 days." }, "secretary": { "type": "string", "pattern": "^per_", "description": "Required for a foundation company: the qualified-person secretary whose address is the office." }, "outgoing_provider_notice_date": { "type": "string", "format": "date", "description": "LLC: date the outgoing provider files its notice of cessation (s.7); a CI$200 daily penalty runs from the next business day if no office is on file (s.7)." }, "express": { "type": "boolean", "description": "Pay the CI$150 express filing fee." } }, "required": [ "entity_type", "reason", "provider", "registered_office", "effective_date", "authorised_signatory" ], "description": "Appoints Entiva's Entiva as registered office of a company, foundation company, LLC or ELP that has none on file or is replacing its provider, and files the notice or amendment. Formation filings already include this notice." }, "Create_ky_registered_office_provide": { "type": "object", "properties": { "type": { "const": "ky.registered_office.provide" }, "params": { "$ref": "#/components/schemas/Params_ky_registered_office_provide" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Provide a licensed registered office and give notice of it", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "approval_resolution", "title": "Directors' resolution, manager or member consent or GP consent", "source": "generated", "required": true }, { "key": "registered_office_notice", "title": "Companies: s.51 notice with certified resolution on replacement.", "source": "generated", "required": true }, { "key": "provider_consent_and_engagement", "title": "Provider's consent and engagement terms (LLC: prior written consent, s.7)", "source": "generated", "required": true }, { "key": "outgoing_provider_release", "title": "Outgoing provider's release and registers handover", "source": "uploaded", "required": false }, { "key": "filing_confirmation", "title": "Registry confirmation", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "approval_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "approval_resolution", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_office_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "provider_consent_and_engagement", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Companies: s.51 notice, plus certified directors' resolution on replacement", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "provider_not_licensed", "type": null, "when": "The provider is not a CIMA licensee of the kind the statute requires." }, { "code": "foundation_office_not_secretary_address", "type": null, "when": "A foundation company's office is not its secretary's business address." }, { "code": "address_not_in_islands", "type": null, "when": "The address is outside the Cayman Islands." }, { "code": "filing_window_exceeded", "type": null, "when": "The change is past its filing deadline." } ] } }, "Params_ky_section_80_company_designate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "ordinary_resident_company", "section_80_company" ], "description": "Current type." }, "purposes": { "type": "array", "items": {}, "description": "One or more of: sporting_organisation, philanthropic, religious, community_group, educational, social, sporting_association, charity, fraternal, cultural." }, "objects_statement": { "type": "string", "description": "Objects and activities." }, "name": { "type": "string", "description": "New name without 'Limited' or 'Ltd.'; a name change filing follows (s.80)." }, "asset_lock_confirmed": { "type": "boolean", "description": "Amended constitution will apply assets and income only to the objects and distribute none to controllers or members except fair pay (s.80)." }, "place_of_business_address": { "$ref": "#/components/schemas/Address", "description": "If different from the registered office on record." }, "contact": { "type": "object", "description": "{name, email, phone} of the Registry contact." }, "controllers": { "type": "array", "items": {}, "description": "Everyone who owns, controls or directs the company (s.80A)." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date members pass the special resolution altering the memorandum; copy to the Registrar within 15 days." } }, "required": [ "entity_type", "purposes", "objects_statement", "asset_lock_confirmed", "contact", "controllers" ], "description": "Applies to the Registrar to designate an existing Cayman company as not-for-profit so it may omit 'Limited'. The constitution must first carry the s.80 asset-lock wording." }, "Create_ky_section_80_company_designate": { "type": "object", "properties": { "type": { "const": "ky.section_80_company.designate" }, "params": { "$ref": "#/components/schemas/Params_ky_section_80_company_designate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Designate an existing company under s.80", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "ordinary_resident_company", "section_80_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "section_80_application_form", "title": "Application form with registration number and controllers list", "source": "generated", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Proposed amended constitution with the s.80 wording", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the application", "source": "generated", "required": true }, { "key": "members_special_resolution", "title": "Members' special resolution altering the constitution", "source": "generated", "required": true }, { "key": "designation_confirmation", "title": "Registrar's designation and conditions", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "section_80_application_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application", "channel": "both", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "Entity is an exempted or non-resident company." }, { "code": "purposes_not_qualifying", "type": null, "when": "Registrar not satisfied the purposes qualify (s.80)." }, { "code": "asset_lock_missing", "type": null, "when": "Amended constitution lacks the s.80 wording." }, { "code": "special_resolution_not_passed", "type": null, "when": "Members have not passed the special resolution." } ] } }, "Params_ky_section_80_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "section_80_company" ], "description": "Must be section_80_company." }, "name": { "type": "string", "description": "'Limited' or 'Ltd.' not required once designated (s.80)." }, "name_reservation_action_id": { "type": "string", "description": "Completed name reservation." }, "purposes": { "type": "array", "items": {}, "description": "One or more of: sporting_organisation, philanthropic, religious, community_group, educational, social, sporting_association, charity, fraternal, cultural." }, "objects_statement": { "type": "string", "description": "Objects and activities; the annual return later confirms them (s.80B)." }, "liability_form": { "type": "string", "enum": [ "limited_by_guarantee", "limited_by_shares" ], "description": "How members' liability is limited." }, "asset_lock_confirmed": { "type": "boolean", "description": "Memorandum or articles will apply assets and income only to the objects and distribute none to controllers or members except fair pay for services (s.80)." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office in the Islands." }, "place_of_business_address": { "$ref": "#/components/schemas/Address", "description": "If different from the registered office." }, "contact": { "type": "object", "description": "{name, email, phone} of the Registry contact." }, "controllers": { "type": "array", "items": {}, "description": "Everyone who owns, controls or directs the company (s.80A)." }, "subscribers": { "type": "array", "items": {}, "description": "person_ref of each subscriber." }, "directors": { "type": "array", "items": {}, "description": "person_ref of each initial director." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "name", "purposes", "objects_statement", "liability_form", "asset_lock_confirmed", "registered_office", "contact", "controllers", "subscribers", "directors", "nature_of_business", "countries_of_operation" ], "description": "Registers a new association as a company that may omit 'Limited' from its name, by lodging the Registrar's s.80 application with the proposed memorandum and articles and the list of persons who own, control or direct it." }, "Create_ky_section_80_company_incorporate": { "type": "object", "properties": { "type": { "const": "ky.section_80_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_ky_section_80_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a not-for-profit company designated under s.80", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "section_80_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "section_80_application_form", "title": "Application form with certified controllers list", "source": "generated", "required": true }, { "key": "memorandum_and_articles", "title": "Memorandum and articles with the s.80 wording", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director's consent to act", "source": "generated", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds for the initial assets", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "registry_submission", "title": "Authenticated registry submission by Entiva", "source": "generated", "required": true } ], "people": [ { "role": "incorporator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_and_articles", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "section_80_application_form", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registry_submission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application", "channel": "both", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "purposes_not_qualifying", "type": null, "when": "Registrar not satisfied the purposes qualify (s.80)." }, { "code": "asset_lock_missing", "type": null, "when": "The constitution lacks the s.80 wording." }, { "code": "controllers_list_incomplete", "type": null, "when": "A controller is missing or lacks verified government ID." }, { "code": "subscriber_witness_missing", "type": null, "when": "A subscriber's signature is not attested." } ] } }, "Params_ky_sez_trade_certificate_amend": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "premises", "entity_name", "terms_and_conditions", "business_scope", "material_change_notification" ], "description": "premises: change or add addresses or premises (s.23). entity_name: change the enterprise's name (s.23). terms_and_conditions: vary a term or condition of the.", "examples": [ "premises" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change takes or took effect.", "examples": [ "2026-11-01" ] }, "premises": { "type": "object", "description": "Required for premises.", "examples": [ "{\"block_and_parcel\":\"21B 134\",\"building_name_and_number\":\"Signal House, Suite 9\",\"street_name_and_number\":\"Seven Mile Beach Road\",\"district\":\"George Town\",\"replaces_existing\":true}" ] }, "name": { "type": "string", "description": "Required for entity_name.", "examples": [ "Pixel Analytics Ltd." ] }, "name_change_action_id": { "type": "string", "description": "For entity_name: the act_ id of the completed name change at the General Registry.", "examples": [ "act_6Df2Lm" ] }, "terms_requested": { "type": "string", "description": "Required for terms_and_conditions: the term or condition to vary and why.", "examples": [ "Add hosted-analytics services to the permitted business description" ] }, "business": { "type": "object", "description": "Required for business_scope.", "examples": [ "{\"park\":\"cayman_internet_park\",\"business_description\":\"Software development and hosted analytics\",\"isic_codes\":[\"6201\",\"6311\"]}" ] }, "material_changes": { "type": "array", "items": {}, "description": "Required for material_change_notification.", "examples": [ "[\"directors\"]" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for any incoming director.", "examples": [ "[\"per_s4\"]" ] }, "controllers": { "type": "array", "items": {}, "description": "Array of person_ref for any incoming controller, beneficial owner or senior officer.", "examples": [ "[]" ] }, "change_description": { "type": "string", "description": "Plain-language description of the change, used in the application or notice.", "examples": [ "Relocating from Suite 4 to Suite 9 in Signal House and appointing a second resident director" ] }, "developer_approval_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the developer's letter.", "examples": [ "doc_8Mn4Qs" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and signs the application as company official.", "examples": [ "per_s1" ] } }, "required": [ "change_type", "effective_date", "change_description", "authorised_representative" ], "description": "Amends an existing trade certificate or notifies the Special Economic Zone Authority of a change in scope, business activities, controllers, directors or shareholders. Notifications of material changes are due within 21 days." }, "Create_ky_sez_trade_certificate_amend": { "type": "object", "properties": { "type": { "const": "ky.sez_trade_certificate.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_sez_trade_certificate_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a Special Economic Zone trade certificate or notify the Authority of a material change", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "amendment_application", "title": "Application to amend the trade certificate, or written notice of change", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "developer_approval_letter", "title": "Developer approval letter", "source": "uploaded", "required": false }, { "key": "personal_questionnaire", "title": "Personal questionnaire for each incoming director", "source": "generated", "required": false }, { "key": "kyc_form", "title": "Know-your-client form for each incoming director", "source": "generated", "required": false }, { "key": "notarised_passport_copy", "title": "Notarised passport copy for each incoming director", "source": "uploaded", "required": false }, { "key": "amended_trade_certificate", "title": "Amended trade certificate", "source": "registry_issued", "required": false }, { "key": "authority_acknowledgement", "title": "Authority's acknowledgement of the notice", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "amendment_application", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "kyc_form", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notarised_passport_copy", "signer_role": "notary", "method": "wet_ink_notarised", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Special Economic Zone Authority, with the Department of Commerce and Investment as its sec", "form": "Application to amend a trade certificate in the prescribed form with the prescribed amendm", "channel": "paper", "government_fee": { "amount": 250, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_active_trade_certificate", "type": "requirement_error", "when": "The entity has no valid trade certificate recorded." }, { "code": "change_params_missing", "type": "invalid_request_error", "when": "The parameter required for the chosen change_type is missing." }, { "code": "name_change_not_registered", "type": "requirement_error", "when": "change_type is entity_name and the new name is not yet registered with the Registrar of Companies." }, { "code": "notice_late", "type": "jurisdiction_error", "when": "The effective_date is more than 21 days ago for a s.24A notice." }, { "code": "cima_licensed_activity_excluded", "type": "jurisdiction_error", "when": "The new business is an activity CIMA licenses." }, { "code": "not_fit_and_proper", "type": "registry_error", "when": "The Authority finds an incoming director, controller or shareholder not fit and proper (s.16, s.26)." }, { "code": "authority_refused", "type": "registry_error", "when": "The Authority declines to amend." } ] } }, "Params_ky_sez_trade_certificate_apply": { "type": "object", "properties": { "park": { "type": "string", "enum": [ "cayman_internet_park", "cayman_science_and_technology_park", "cayman_media_park", "cayman_commodities_and_derivatives_park", "cayman_outsource_park", "cayman_international_academic_park", "cayman_maritime_and_aviation_services_park" ], "description": "The Cayman Enterprise City business park that fits the company's principal activity.", "examples": [ "cayman_internet_park" ] }, "business_description": { "type": "string", "description": "Nature and type of the special economic zone business (Form 1, Part 2).", "examples": [ "Software development and hosted analytics services for customers outside the Cayman Islands" ] }, "isic_codes": { "type": "array", "items": {}, "description": "Array of ISIC codes for the business (Form 1, Part 2).", "examples": [ "[\"6201\",\"6311\"]" ] }, "expected_employees": { "type": "object", "description": "Shape: {full_time: integer, part_time: integer} (Form 1, Part 2).", "examples": [ "{\"full_time\":6,\"part_time\":1}" ] }, "premises": { "type": "object", "description": "Exact location from which the business is carried on; the certificate specifies the address of the premises (s.17).", "examples": [ "{\"block_and_parcel\":\"21B 134\",\"building_name_and_number\":\"Signal House, Suite 4\",\"street_name_and_number\":\"Seven Mile Beach Road\",\"district\":\"George Town\"}" ] }, "postal_address": { "$ref": "#/components/schemas/Address", "description": "Postal address entered on the Authority's register (s.27).", "examples": [ "{\"line1\":\"PO Box 5678\",\"city\":\"George Town\",\"postal_code\":\"KY1-1107\",\"country\":\"KY\"}" ] }, "developer_approval_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the letter of approval signed by Cayman Enterprise City Limited, the developer (Form 1, Part 2; Order paragraph 3).", "examples": [ "doc_3Vq8Ex" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for every director.", "examples": [ "[\"per_s1\",\"per_s2\"]" ] }, "controllers": { "type": "array", "items": {}, "description": "Array of person_ref for every controller: a holder of 10% or more of shares or votes, a person who can appoint or remove directors, the most senior operating.", "examples": [ "[\"per_s1\",\"per_s3\"]" ] }, "senior_officers": { "type": "array", "items": {}, "description": "Array of person_ref for senior officers not already listed as directors or controllers.", "examples": [ "[]" ] }, "principal_purpose_outside_islands": { "type": "boolean", "description": "Confirms the enterprise has as its principal purpose business mainly outside the Islands and will not trade in the Islands except for purposes ancillary to its.", "examples": [ "true" ] }, "holds_cima_licence": { "type": "boolean", "description": "True if the company holds any CIMA licence.", "examples": [ "false" ] }, "declaration_no_disqualification": { "type": "boolean", "description": "Form 1 declaration: the applicant is not disqualified by the Law or any other law from holding the certificate, and the information is correct.", "examples": [ "true" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and signs the application as company official.", "examples": [ "per_s1" ] } }, "required": [ "park", "business_description", "isic_codes", "expected_employees", "premises", "postal_address", "developer_approval_document", "directors", "controllers", "principal_purpose_outside_islands", "holds_cima_licence", "declaration_no_disqualification", "authorised_representative" ], "description": "Applies to the Special Economic Zone Authority for the trade certificate a special economic zone company needs before it carries on business in Cayman Enterprise City. Entiva prepares the application and each director's personal." }, "Create_ky_sez_trade_certificate_apply": { "type": "object", "properties": { "type": { "const": "ky.sez_trade_certificate.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_sez_trade_certificate_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a Special Economic Zone trade certificate", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_1_application", "title": "Application for a Special Economic Zone trade certificate", "source": "generated", "required": true }, { "key": "developer_approval_letter", "title": "Letter of approval from the developer", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "uploaded", "required": true }, { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "uploaded", "required": true }, { "key": "register_of_directors", "title": "Register of directors", "source": "generated", "required": true }, { "key": "return_of_shareholders", "title": "Return of shareholders", "source": "generated", "required": true }, { "key": "good_standing_certificate", "title": "Evidence the company is a registered special economic zone company in good standing", "source": "registry_issued", "required": true }, { "key": "passport", "title": "Passport copy for each director", "source": "uploaded", "required": true }, { "key": "personal_questionnaire", "title": "Personal questionnaire for each director", "source": "generated", "required": true }, { "key": "kyc_form", "title": "Know-your-client form for each director", "source": "generated", "required": true }, { "key": "notarised_passport_copy", "title": "Notarised copy of passport, voter registration card or national ID for each director", "source": "uploaded", "required": true }, { "key": "authority_information_response", "title": "Response to the Authority's request for information", "source": "uploaded", "required": false }, { "key": "trade_certificate", "title": "Special economic zone trade certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_1_application", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "kyc_form", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notarised_passport_copy", "signer_role": "notary", "method": "wet_ink_notarised", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "developer_approval_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Special Economic Zone Authority, with the Department of Commerce and Investment as its sec", "form": "Application for a trade certificate in the prescribed form, submitted to the Authority wit", "channel": "paper", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_sez_company", "type": "requirement_error", "when": "The entity is not registered as a special economic zone company in good standing (s.14)." }, { "code": "developer_approval_missing", "type": "requirement_error", "when": "developer_approval_document is missing or unsigned." }, { "code": "cima_licensed_activity_excluded", "type": "jurisdiction_error", "when": "holds_cima_licence is true and the activity is the one CIMA licenses." }, { "code": "park_not_open", "type": "jurisdiction_error", "when": "The chosen park is closed to the applicant or needs prior Government agreement." }, { "code": "principal_purpose_not_outside_islands", "type": "jurisdiction_error", "when": "principal_purpose_outside_islands is false (s.18)." }, { "code": "director_pack_incomplete", "type": "requirement_error", "when": "A director lacks a questionnaire, KYC form, passport copy or notarised copy." }, { "code": "authority_information_requested", "type": "registry_error", "when": "The Authority asks for more information." }, { "code": "not_fit_and_proper", "type": "registry_error", "when": "The Authority finds the applicant, a controller, beneficial owner, director, senior officer or shareholder not fit and proper (s.16,)." }, { "code": "authority_refused", "type": "registry_error", "when": "The Authority refuses, for example on public interest or reputational risk (s.16)." }, { "code": "false_statement_bar", "type": "registry_error", "when": "The applicant was convicted of a false statement in an application within the last five years; the Authority may refuse (s.14)." } ] } }, "Params_ky_sezc_convert": { "type": "object", "properties": { "name": { "type": "string", "description": "New name including Special Economic Zone Company or SEZC (s.182B).", "examples": [ "Harbourline Technologies SEZC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action for the new name." }, "sez_business_description": { "type": "string", "description": "The SEZ business to add to the memorandum by special resolution (s.182B).", "examples": [ "Software development and technology services within the special economic zone" ] }, "sez_trade_certificate_status": { "type": "string", "enum": [ "held", "to_be_applied", "not_yet_assessed" ], "description": "Status of the SEZ trade certificate from the zone authority, which is separate from the Registry.", "examples": [ "to_be_applied" ] }, "resolution_method": { "type": "string", "enum": [ "general_meeting", "written_resolution" ], "description": "How the two special resolutions are passed (s.60).", "examples": [ "written_resolution" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500.", "examples": [ "standard" ] } }, "required": [ "name", "sez_business_description", "resolution_method" ], "description": "Re-registers an existing exempted company as a special economic zone company under Companies Act ss.182A-182B. The members pass special resolutions altering the memorandum to carry on SEZ business and changing the name to include Special." }, "Create_ky_sezc_convert": { "type": "object", "properties": { "type": { "const": "ky.sezc.convert" }, "params": { "$ref": "#/components/schemas/Params_ky_sezc_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an existing exempted company into an SEZC", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "special_resolution_memorandum", "title": "Special resolution altering the memorandum to carry on SEZ business", "source": "generated", "required": true }, { "key": "special_resolution_name", "title": "Special resolution changing the name to an SEZC name", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "sezc_application", "title": "Application to register as an SEZC", "source": "generated", "required": true }, { "key": "sez_trade_certificate", "title": "SEZ trade certificate", "source": "uploaded", "required": false }, { "key": "registry_sezc_certificate", "title": "Certificate stating SEZC registration and its date", "source": "registry_issued", "required": true }, { "key": "meeting_minutes", "title": "Meeting minutes", "source": "generated", "required": true }, { "key": "cap_sezc_filing", "title": "Cap sezc filing", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_memorandum", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_name", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_sezc_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.182A with certified special resolutions", "channel": "online", "government_fee": { "amount": 925, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "sezc_name_designation_required", "type": null, "when": "invalid_request_error, 422. new_name lacks Special Economic Zone Company or SEZC." }, { "code": "sezc_licensed_company", "type": null, "when": "jurisdiction_error, 422." }, { "code": "written_resolution_not_permitted", "type": null, "when": "requirement_error, 422." }, { "code": "entity_not_exempted", "type": null, "when": "jurisdiction_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_sezc_register": { "type": "object", "properties": { "name": { "type": "string", "description": "Must include the words Special Economic Zone Company or the letters SEZC (s.182B) and pass s.30.", "examples": [ "Harbourline Technologies SEZC" ] }, "name_reservation_action_id": { "type": "string", "description": "Completed ky.name.reserve action." }, "liability": { "type": "string", "enum": [ "limited_by_shares", "limited_by_guarantee", "unlimited" ], "description": "Default limited_by_shares.", "examples": [ "limited_by_shares" ] }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Under Sch.5 Pt 1 the memorandum fee is the lowest exempted band whatever the capital; capital still has to be stated.", "examples": [ "{amount: 50000, currency: USD}" ] }, "share_structure": { "type": "object", "description": "{class_name, par_value, number_of_shares}.", "examples": [ "{class_name: Ordinary, par_value: {amount: 1, currency: USD}, number_of_shares: 50000}" ] }, "sez_business_description": { "type": "string", "description": "The special economic zone business to be written into the memorandum (s.182B).", "examples": [ "Software development and technology services within the special economic zone" ] }, "sez_trade_certificate_status": { "type": "string", "enum": [ "held", "to_be_applied", "not_yet_assessed" ], "description": "Status of the SEZ trade certificate from the zone authority.", "examples": [ "to_be_applied" ] }, "nature_of_business": { "type": "string", "description": "Business description for the declaration and business profile.", "examples": [ "Software development for clients outside the Cayman Islands, operating from a zone office" ] }, "operations_outside_islands": { "type": "boolean", "examples": [ "true" ] }, "subscriber_mode": { "type": "string", "enum": [ "licensed_partner_nominee", "customer" ], "description": "Default licensed_partner_nominee.", "examples": [ "licensed_partner_nominee" ] }, "customer_subscribers": { "type": "array", "items": {}, "description": "When subscriber_mode is customer: {person_id, shares}." }, "directors": { "type": "array", "items": {}, "description": "Array of {person_id, role}.", "examples": [ "[{person_id: per_1Ab6Dc9Ef, role: director}]" ] }, "officers": { "type": "array", "items": {}, "description": "Optional {person_id, title}." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Array of {person_id, share_class, number_of_shares}.", "examples": [ "[{person_id: per_1Ab6Dc9Ef, share_class: Ordinary, number_of_shares: 50000}]" ] }, "additional_controllers": { "type": "array", "items": {}, "description": "{person_id, control_basis} for people with control but no shares." }, "articles_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Default entiva_standard.", "examples": [ "entiva_standard" ] }, "custom_articles_document_id": { "type": "string", "pattern": "^doc_", "description": "Required when articles_template is custom." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD.", "examples": [ "12-31" ] }, "economic_substance_activities": { "type": "array", "items": {}, "description": "Expected relevant activities, or empty." }, "source_of_funds": { "type": "object", "description": "{summary, origin_countries, expected_annual_turnover}.", "examples": [ "{summary: Founder's savings, origin_countries: [CA]}" ] }, "introducer_account_id": { "type": "string", "description": "Introducing platform account, if any." }, "instructing": { "type": "string", "pattern": "^per_", "description": "The person giving instructions.", "examples": [ "per_1Ab6Dc9Ef" ] }, "service_level": { "type": "string", "enum": [ "standard", "express" ], "description": "express adds CI$500.", "examples": [ "standard" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "name", "authorised_capital", "sez_business_description", "nature_of_business", "operations_outside_islands", "directors", "initial_shareholders", "source_of_funds", "instructing", "countries_of_operation", "shareholders", "share_classes", "beneficial_owners" ], "description": "Incorporates a new exempted company that is registered at the same time as a special economic zone company under Companies Act ss.182A-182B. The memorandum must specify that the business includes special economic zone business and the name." }, "Create_ky_sezc_register": { "type": "object", "properties": { "type": { "const": "ky.sezc.register" }, "params": { "$ref": "#/components/schemas/Params_ky_sezc_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a new Cayman special economic zone company", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "sezc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "passport", "title": "Passport or government photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": true }, { "key": "source_of_funds_declaration", "title": "Source of funds declaration", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "Corporate party documents", "source": "uploaded", "required": false }, { "key": "sez_trade_certificate", "title": "SEZ trade certificate", "source": "uploaded", "required": false }, { "key": "memorandum_of_association", "title": "Memorandum of association", "source": "generated", "required": true }, { "key": "articles_of_association", "title": "Articles of association", "source": "generated", "required": true }, { "key": "section_165_declaration", "title": "Exempted company declaration", "source": "generated", "required": true }, { "key": "sezc_application", "title": "Application to register as an SEZC", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "registered_office_acceptance", "title": "Registered office acceptance by Entiva", "source": "generated", "required": true }, { "key": "first_board_resolution", "title": "First board written resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_issued", "title": "Certificate of incorporation certifying SEZC status", "source": "registry_issued", "required": true }, { "key": "endorsed_memorandum_and_articles", "title": "Registered memorandum and articles", "source": "registry_issued", "required": true }, { "key": "operations_declaration_confirmation", "title": "Operations declaration confirmation", "source": "generated", "required": true }, { "key": "cdd_attestation", "title": "Cdd attestation", "source": "generated", "required": true }, { "key": "cap_incorporation_filing", "title": "Cap incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "incorporator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "politically_exposed_person", "verification_level": "enhanced" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_of_association", "signer_role": "nominee", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "articles_of_association", "signer_role": "incorporator", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "section_165_declaration", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "operations_declaration_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "sezc_application", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "cdd_attestation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cap_incorporation_filing", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "first_board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Memorandum and articles, s.165 declaration, notice of registered office and application to", "channel": "online", "government_fee": { "amount": 1625, "currency": "KYD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "sezc_name_designation_required", "type": null, "when": "invalid_request_error, 422." }, { "code": "sezc_business_not_specified", "type": null, "when": "invalid_request_error, 422. sez_business_description is missing, so the memorandum cannot state SEZ business (s.182B)." }, { "code": "sezc_licensed_company", "type": null, "when": "jurisdiction_error, 422." }, { "code": "operations_declaration_required", "type": null, "when": "jurisdiction_error, 422." }, { "code": "name_unavailable", "type": null, "when": "registry_error, 409. s.30 refusal or expired reservation." }, { "code": "verification_incomplete", "type": null, "when": "requirement_error, 422." }, { "code": "sanctions_alert_open", "type": null, "when": "requirement_error, 409." }, { "code": "partner_declined", "type": null, "when": "requirement_error, 409." }, { "code": "witness_not_confirmed", "type": null, "when": "requirement_error, 409." }, { "code": "fee_changed", "type": null, "when": "registry_error, 409." }, { "code": "registry_rejected", "type": null, "when": "registry_error, 422." } ] } }, "Params_ky_siba_registered_person_register": { "type": "object", "properties": { "schedule_4_basis": { "type": "string", "enum": [ "group_company", "sophisticated_or_hnw_clients", "overseas_regulated" ], "description": "The Schedule 4 paragraph the applicant relies on. group_company: a company in a group carrying on securities investment business exclusively for companies in.", "examples": [ "sophisticated_or_hnw_clients" ] }, "services": { "type": "array", "items": {}, "description": "Services the applicant provides or offers: securities_advisor, securities_manager, securities_arranger, broker_dealer, market_maker.", "examples": [ "[\"securities_advisor\",\"securities_manager\"]" ] }, "client_counts": { "type": "object", "description": "Number of clients served in the last 12 months for each service.", "examples": [ "{\"securities_advisor\":4,\"securities_manager\":2,\"securities_arranger\":0,\"broker_dealer\":0}" ] }, "client_list_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the client list, current or proposed if known, in Excel format.", "examples": [ "doc_2Fx9Pk" ] }, "conducting_sib_overseas": { "type": "boolean", "description": "Whether the applicant already conducts securities investment business overseas.", "examples": [ "false" ] }, "overseas_start_date": { "type": "string", "format": "date", "description": "Required when conducting_sib_overseas is true: date it began.", "examples": [ "2024-05-01" ] }, "overseas_countries": { "type": "array", "items": {}, "description": "Required when conducting_sib_overseas is true: array of ISO 3166 country codes.", "examples": [ "[\"SG\"]" ] }, "overseas_regulators": { "type": "array", "items": {}, "description": "Required when schedule_4_basis is overseas_regulated.", "examples": [ "[{\"country\":\"SG\",\"authority\":\"Monetary Authority of Singapore\",\"contact_name\":\"J. Tan\",\"contact_title\":\"Senior Analyst\"}]" ] }, "group_companies": { "type": "array", "items": {}, "description": "Required when schedule_4_basis is group_company: every company in the group receiving services.", "examples": [ "[]" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for directors or, for an LLC or ELP, the managers, managing members or principals of the general partner.", "examples": [ "[\"per_c1\",\"per_c2\"]" ] }, "senior_officers": { "type": "array", "items": {}, "description": "Array of person_ref for senior officers other than the directors and the AML officers.", "examples": [ "[]" ] }, "shareholders": { "type": "array", "items": {}, "description": "Every shareholder or beneficial interest holder who is a natural person.", "examples": [ "[{\"holder\":\"per_c1\",\"percent\":60},{\"holder\":\"per_c3\",\"percent\":40}]" ] }, "corporate_shareholders": { "type": "array", "items": {}, "description": "Every corporate shareholder with its ultimate beneficial owner.", "examples": [ "[]" ] }, "aml_officers": { "type": "object", "description": "Designated AML officers.", "examples": [ "{\"aml_compliance_officer\":\"per_c4\",\"deputy_aml_compliance_officer\":null,\"mlro\":\"per_c4\",\"deputy_mlro\":\"per_c5\"}" ] }, "principal_contact": { "type": "object", "description": "The applicant's principal contact.", "examples": [ "{\"person\":\"per_c1\",\"title\":\"Managing Director\"}" ] }, "other_service_providers": { "type": "array", "items": {}, "description": "Service providers to the applicant other than the registered office, which Entiva adds itself: administrator, auditor, custodian, prime broker and similar.", "examples": [ "[{\"name\":\"Harbour Audit Ltd.\",\"role\":\"auditor\",\"address\":\"Grand Pavilion, George Town\",\"phone\":\"+13459490001\",\"email\":\"audit@harbour.example\",\"principal_contact\":{\"name\":\"A. Miller\",\"position\":\"Partner\",\"address\":\"Grand Pavilion, George Town\",\"phone\":\"+13459490001\",\"email\":\"a.miller@harbour.example\"}}]" ] }, "previous_or_trading_names": { "type": "array", "items": {}, "description": "Array of strings: any previous names and trading names, current and past, under which the applicant has conducted business.", "examples": [ "[]" ] }, "legal_entity_identifier": { "type": "string", "description": "LEI, if the applicant has one.", "examples": [ "5493001KJTIIGC8Y1R12" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The person who instructs Entiva and Entiva.", "examples": [ "per_c1" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "schedule_4_basis", "services", "client_list_document", "conducting_sib_overseas", "directors", "shareholders", "aml_officers", "principal_contact", "authorised_representative", "name", "nature_of_business", "countries_of_operation", "general_partners", "members", "share_classes", "beneficial_owners" ], "description": "Registers an existing Cayman entity with the Cayman Islands Monetary Authority as a registered person under the Securities Investment Business Act, the route for entities that fall in Schedule 4 instead of holding a full licence. Entiva." }, "Create_ky_siba_registered_person_register": { "type": "object", "properties": { "type": { "const": "ky.siba_registered_person.register" }, "params": { "$ref": "#/components/schemas/Params_ky_siba_registered_person_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register with CIMA as a securities investment business registered person", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "exempted_ldc", "llc", "elp", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application", "title": "CIMA application for registration as a registered person", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation or registration, with any change-of-name certificates", "source": "uploaded", "required": true }, { "key": "client_list", "title": "Client list", "source": "uploaded", "required": true }, { "key": "organisation_chart", "title": "Organisation chart", "source": "uploaded", "required": false }, { "key": "evidence_of_listing", "title": "Evidence of listing on a recognised exchange", "source": "uploaded", "required": false }, { "key": "personal_questionnaire", "title": "CIMA personal questionnaire", "source": "generated", "required": true }, { "key": "aml_officer_cv", "title": "CV for each AML compliance officer, deputy, MLRO and deputy MLRO", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Resolution to apply for registration and to designate AML officers", "source": "generated", "required": true }, { "key": "filing_authorisation", "title": "Written authorisation to the registered office to file on REEFS", "source": "generated", "required": true }, { "key": "registration_confirmation", "title": "CIMA confirmation of registration", "source": "registry_issued", "required": true }, { "key": "fee_receipt", "title": "Receipt for the registration fee", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "aml_officer", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "personal_questionnaire", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "filing_authorisation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application", "signer_role": "partner", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "REEFS form APP-101-75 'Application for SIBL Registered Person' for new registrants, with t", "channel": "online", "government_fee": { "amount": 6000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_form_not_permitted", "type": "jurisdiction_error", "when": "The entity is not one of the forms permitted to carry on securities investment business: Cayman company, general partnership, limited partnership, ELP, foreign company, LLC or LLP." }, { "code": "schedule_4_basis_not_met", "type": "jurisdiction_error", "when": "The facts given do not fit the chosen Schedule 4 paragraph, for example clients who are not sophisticated or high net worth persons under para 2, or an overseas regulator that is." }, { "code": "client_list_missing", "type": "requirement_error", "when": "No client list, or a client is not classed as private, professional or market counterparty." }, { "code": "aml_officers_missing", "type": "requirement_error", "when": "No AML compliance officer or MLRO is designated, or no CV is attached." }, { "code": "director_requirements_not_met", "type": "requirement_error", "when": "The directors do not meet CIMA's director rules." }, { "code": "shareholder_not_fit_and_proper", "type": "registry_error", "when": "CIMA is not satisfied that a shareholder, director or senior officer is fit and proper (s.5)." }, { "code": "overseas_regulator_not_recognised", "type": "registry_error", "when": "The overseas authority is not on CIMA's list for Schedule 4 para 3." }, { "code": "cima_query", "type": "registry_error", "when": "CIMA asks the registered office for clarification (reg 2)." }, { "code": "cima_refused", "type": "registry_error", "when": "CIMA refuses the application." } ] } }, "Params_ky_tax_undertaking_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "llc", "elp" ], "description": "Decides who grants the undertaking." }, "term_years": { "type": "integer", "description": "LLC (s.58) and ELP (s.38): at most 50 years from approval." }, "include_estate_duty_and_inheritance_tax": { "type": "boolean", "description": "Also exclude estate duty and inheritance tax, and tax on the entity's obligations and owners' interests (LLC s.58; ELP s.38)." }, "applicant": { "type": "string", "pattern": "^per_", "description": "ELP: a general partner must apply (s.38)." } }, "required": [ "entity_type", "term_years", "applicant" ], "description": "Applies for an undertaking that no future Cayman tax on profits, income, gains or appreciation will apply to an exempted company, LLC or ELP. LLCs and ELPs apply to the Financial Secretary for up to 50 years; exempted companies apply to." }, "Create_ky_tax_undertaking_apply": { "type": "object", "properties": { "type": { "const": "ky.tax_undertaking.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_tax_undertaking_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a tax exemption undertaking", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "exempted_company", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "undertaking_application", "title": "Application for a tax undertaking", "source": "generated", "required": true }, { "key": "authorising_resolution", "title": "Board resolution, manager or member consent, or GP consent", "source": "generated", "required": true }, { "key": "submission_cover_letter", "title": "Registered office's cover letter", "source": "generated", "required": true }, { "key": "tax_undertaking", "title": "Tax undertaking", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "authorising_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "authorising_resolution", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "undertaking_application", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "submission_cover_letter", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Financial Secretary", "form": "Application for an undertaking as to tax: LLC Act s.58", "channel": "both", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "term_exceeds_limit", "type": null, "when": "term_years is over 50 for an LLC or ELP." }, { "code": "applicant_not_general_partner", "type": null, "when": "ELP applicant is not a general partner." }, { "code": "undertaking_already_in_force", "type": null, "when": "The entity already has one." }, { "code": "entity_type_not_supported", "type": null, "when": "Not an exempted company, LLC or ELP; exempted trusts use Trusts Act s.81." } ] } }, "Params_ky_trade_and_business_licence_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "ordinary_resident_company", "foreign_company" ], "description": "Entity type." }, "business_activities": { "type": "array", "items": {}, "description": "Strings: each trade or business to license." }, "licence_category": { "type": "string", "description": "DCI category if known; DCI's category list was not published." }, "place_of_business_address": { "$ref": "#/components/schemas/Address", "description": "Where the business is carried on in the Islands." }, "commencement_date": { "type": "string", "format": "date", "description": "Date trading starts; the licence must be in place before it." }, "caymanian_controlled": { "type": "boolean", "description": "True if Caymanian controlled with at least 60% Caymanian shares and 60% Caymanian directors (s.5)." }, "lccl_or_exemption_reference": { "type": "string", "description": "Required when caymanian_controlled is false: LCCL number or Cabinet exemption reference." }, "contact": { "type": "object", "description": "{name, email, phone} of the DCI contact." } }, "required": [ "entity_type", "business_activities", "place_of_business_address", "commencement_date", "caymanian_controlled", "contact" ], "description": "Applies to the Department of Commerce and Investment for a Trade and Business Licence so an ordinary resident or registered foreign company can trade in the Islands. A company that is not Caymanian controlled also needs a Local Companies." }, "Create_ky_trade_and_business_licence_apply": { "type": "object", "properties": { "type": { "const": "ky.trade_and_business_licence.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_trade_and_business_licence_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a Trade and Business Licence", "x-entiva": { "jurisdiction": "ky", "stage": "formation", "applies_to": [ "ordinary_resident_company", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "tbl_application", "title": "Trade and Business Licence application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation or registration", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Memorandum and articles", "source": "uploaded", "required": true }, { "key": "lccl_licence_or_exemption", "title": "LCCL or Cabinet exemption", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "trade_and_business_licence", "title": "Trade and Business Licence", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tbl_application", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Department of Commerce and Investment", "form": "Trade and Business Licence application", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lccl_required", "type": null, "when": "caymanian_controlled is false and no LCCL or exemption reference is given." }, { "code": "business_not_empowered", "type": null, "when": "The memorandum does not empower the listed business." }, { "code": "entity_type_not_supported", "type": null, "when": "An exempted company applies; one holding a local licence continues as ordinary resident (Companies Act s.174)." } ] } }, "Params_ky_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "foundation_company" ], "description": "Must match the entity record." }, "nature_of_business": { "type": "string", "description": "Nature of business (s.168); Registry drop-down value, pre-filled." }, "memorandum_unaltered": { "type": "boolean", "description": "Declaration: memorandum unaltered since the last return, bar a s.31 name change or a change reported under s.10." }, "operations_mainly_outside_islands": { "type": "boolean", "description": "Declaration: operations mainly outside the Islands." }, "section_174_compliant": { "type": "boolean", "description": "Declaration: s.174 complied with." }, "registered_capital": { "$ref": "#/components/schemas/Money", "description": "Authorised capital, which sets the fee band." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director who confirms the facts; defaults to a verified director." } }, "required": [ "entity_type", "nature_of_business", "memorandum_unaltered", "operations_mainly_outside_islands", "section_174_compliant" ], "description": "Files the s.168 annual return and pays the s.169 annual fee, set by authorised capital. Entiva's Entiva on CAP once the ESN is on file." }, "Create_ky_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return and annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_return_declaration", "title": "Annual Return and Declaration, ss.168-169", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_declaration", "signer_role": "declarant", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "annual_return_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "General Registry", "form": "Annual Return and Declaration, ss.168-169", "channel": "online", "government_fee": { "amount": 1025, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "filing_year_invalid", "type": "invalid_request_error", "when": "filing_year out of range or already filed." }, { "code": "earlier_years_unpaid", "type": "requirement_error", "when": "An earlier year is unfiled or unpaid; file the oldest first." }, { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "memorandum_alteration_unreported", "type": "requirement_error", "when": "Memorandum altered without a s.10 filing; file it first." }, { "code": "declaration_cannot_be_given", "type": "requirement_error", "when": "A declaration is answered false; not filed, routed to the partner and counsel." }, { "code": "licensed_company_requires_review", "type": "jurisdiction_error", "when": "Holds a s.174 licence, so s.168 does not apply; routed to the partner." }, { "code": "foundation_company_not_exempted", "type": "jurisdiction_error", "when": "A foundation company not registered as exempted is outside s.168; the partner confirms the obligation." }, { "code": "entity_struck_off_or_defunct", "type": "jurisdiction_error", "when": "Entity struck off, defunct or dissolved; restore it first." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing." }, { "code": "registered_office_not_entiva_partner", "type": "jurisdiction_error", "when": "Another provider is the registered office and only it can use CAP; transfer in first." } ] } }, "Params_ky_beneficial_ownership_change": { "type": "object", "properties": { "change": { "type": "string", "enum": [ "added", "ceased", "particulars_changed" ], "description": "added, ceased or particulars_changed.", "examples": [ "added" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change occurred.", "examples": [ "2026-10-05" ] }, "date_learned": { "type": "string", "format": "date", "description": "Date the entity learned of it; the s.14 notice and the CSP update are due within 30 days.", "examples": [ "2026-10-12" ] }, "holder_type": { "type": "string", "enum": [ "individual", "reportable_legal_entity", "senior_managing_official", "trustee", "deemed_individual" ], "description": "deemed_individual covers governments, corporations sole and public authorities." }, "person": { "type": "string", "pattern": "^per_", "description": "All holder types except reportable_legal_entity." }, "reportable_legal_entity_id": { "type": "string", "pattern": "^ent_", "description": "A Cayman RLE only." }, "nature_of_interest": { "type": "string", "enum": [ "shares", "voting_rights", "partnership_interest", "power_to_appoint_directors", "ultimate_effective_control", "control_other_means" ], "description": "Nature of ownership or control (s.12)." }, "percentage_held": { "type": "number", "description": "Direct plus indirect; 25% or more, or control, is registrable." }, "cessation": { "type": "object", "description": "For ceased: {reason: disposal | control_ended | death | other, date_of_death}." }, "changed_particulars": { "type": "object", "description": "For particulars_changed: new name, addresses, date of birth, nationality, or ID number, country, issue and expiry dates." }, "notice_route": { "type": "string", "enum": [ "s14_confirmation_request", "s8_notice", "information_received" ], "description": "s14_confirmation_request; s8_notice; information_received." }, "supporting_documents": { "type": "array", "items": {}, "description": "document_refs: transfer instrument, updated register of members, ID, proof of address." } }, "required": [ "change", "effective_date", "date_learned", "holder_type" ], "description": "Handles a relevant change to the BO register: a person becoming or ceasing to be a registrable beneficial owner, or changed particulars such as a new address or expired passport." }, "Create_ky_beneficial_ownership_change": { "type": "object", "properties": { "type": { "const": "ky.beneficial_ownership.change" }, "params": { "$ref": "#/components/schemas/Params_ky_beneficial_ownership_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a change of beneficial owner", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "bo_change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "bo_notice", "title": "Statutory notice (s.14 or s.8)", "source": "generated", "required": true }, { "key": "bo_response", "title": "Owner's confirmation or correction", "source": "generated", "required": true }, { "key": "cap_deposit_receipt", "title": "CAP deposit confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "bo_response", "signer_role": "shareholder", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bo_notice", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "cap_deposit_receipt", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Competent Authority for Beneficial Ownership", "form": "Updated BO register upload", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "bo_notice_unanswered", "type": null, "when": "[requirement_error] No reply in 30 days; the CSP must issue a s.18 notice, then a s.19 restrictions notice." }, { "code": "bo_id_expired", "type": null, "when": "[requirement_error] The ID supplied is expired." }, { "code": "foreign_entity_not_rle", "type": null, "when": "[invalid_request_error] Foreign companies, entities and LPs cannot be RLEs; give their individual owners." }, { "code": "screening_alert_open", "type": null, "when": "[requirement_error] A sanctions alert on the person pauses the update." } ] } }, "Params_ky_beneficial_ownership_file": { "type": "object", "properties": { "trigger": { "type": "string", "enum": [ "scheduled_monthly", "scheduled_annual", "scheduled_liquidation_90_day", "post_change", "ad_hoc" ], "description": "Default taken from the entity's status." }, "category": { "type": "string", "enum": [ "standard_register", "listed", "licensed_under_regulatory_law", "registered_fund", "cabinet_exempt" ], "description": "BOTA s.12 category, from the entity record." }, "as_of_date": { "type": "string", "format": "date", "description": "Date the register is stated as at; default today." }, "no_change_indicator": { "type": "boolean", "description": "Send the no-change indicator (reg 8)." }, "deposit_channel": { "type": "string", "enum": [ "cap", "cbp" ], "description": "cap for all; cbp only for ordinary resident companies." }, "acknowledge_pending_entries": { "type": "boolean", "description": "Accepts deposit of entries marked 'pending'; three uninterrupted months pending is presumed a breach (reg 4)." }, "liquidation": { "type": "object", "description": "{liquidator_person_id, appointment_date}; the liquidator's details and RBOs at appointment go to the Authority (s.12)." } }, "description": "Deposits the entity's beneficial ownership register with the Competent Authority through the licensed CSP, or the no-change indicator if nothing changed since the last deposit. Follows the statutory cycle: monthly, 90 days in liquidation." }, "Create_ky_beneficial_ownership_file": { "type": "object", "properties": { "type": { "const": "ky.beneficial_ownership.file" }, "params": { "$ref": "#/components/schemas/Params_ky_beneficial_ownership_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deposit the beneficial ownership register", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "bo_register_csv", "title": "BO register upload file", "source": "generated", "required": true }, { "key": "bo_verification_summary", "title": "Verification evidence per entry", "source": "generated", "required": true }, { "key": "cap_deposit_receipt", "title": "CAP deposit confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "bo_register_csv", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Competent Authority for Beneficial Ownership", "form": "BO register CSV upload, or no-change indicator", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "bo_register_blank", "type": null, "when": "[requirement_error] No owner, RLE, trustee or senior managing official; a deposit cannot be blank." }, { "code": "bo_id_expired", "type": null, "when": "[requirement_error] An entry rests on an expired ID; the person must re-verify." }, { "code": "bo_entry_pending_too_long", "type": null, "when": "[requirement_error] An entry has been pending over two months; three months is a presumed breach." }, { "code": "not_the_entitys_csp", "type": null, "when": "[jurisdiction_error] Another CSP provides the registered office, so only it can deposit." } ] } }, "Params_ky_beneficial_ownership_alternative_route_confirm": { "type": "object", "properties": { "confirmation_type": { "type": "string", "enum": [ "initial", "amended", "withdrawn_returning_to_standard_route" ], "description": "initial; amended; withdrawn_returning_to_standard_route (entity no longer qualifies and files full particulars under s.12).", "examples": [ "initial" ] }, "category": { "type": "string", "enum": [ "listed", "licensed_under_regulatory_law", "registered_fund", "cabinet_exempt" ], "description": "listed; licensed_under_regulatory_law; registered_fund; cabinet_exempt.", "examples": [ "registered_fund" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the status began, changed or ended.", "examples": [ "2026-10-01" ] }, "listing": { "type": "object", "description": "For listed: {exchange, jurisdiction, listed_entity, basis: itself_listed | holds_75_percent | ultimate_effective_control | control_other_means}." }, "regulatory_law": { "type": "string", "description": "For licensed or registered: the law, for example 'Mutual Funds Act'." }, "cima_number": { "type": "string", "description": "CIMA licence or registration number." }, "contact_person": { "type": "object", "description": "Required for registered_fund: {type: licensed_fund_administrator | other_licensed_person, name, address, phone, email, named_individual}." }, "reason_for_change": { "type": "string", "description": "For amended or withdrawn: delisting, licence surrender, new administrator." } }, "required": [ "confirmation_type", "category", "effective_date" ], "description": "Gives the Competent Authority the CSP's written confirmation that the entity is listed, licensed under a regulatory law, a registered fund, or Cabinet-exempt (BOTA s.12-), so it reports limited particulars." }, "Create_ky_beneficial_ownership_alternative_route_confirm": { "type": "object", "properties": { "type": { "const": "ky.beneficial_ownership_alternative_route.confirm" }, "params": { "$ref": "#/components/schemas/Params_ky_beneficial_ownership_alternative_route_confirm" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Confirm a BO alternative-route category", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "status_evidence", "title": "Evidence of the category", "source": "uploaded", "required": true }, { "key": "contact_person_acceptance", "title": "Contact person's acceptance", "source": "uploaded", "required": false }, { "key": "category_confirmation", "title": "Written confirmation of category", "source": "generated", "required": true }, { "key": "cap_receipt", "title": "CAP confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "category_confirmation", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "contact_person_acceptance", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "category_confirmation", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Competent Authority for Beneficial Ownership", "form": "Written confirmation of category with s.12", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "subsidiary_not_eligible", "type": null, "when": "[requirement_error] Subsidiaries of regulated entities or funds do not qualify through the parent; only listed subsidiaries within s.12 do." }, { "code": "contact_person_required", "type": null, "when": "[requirement_error] A registered fund has no contact person; appoint one or file under s.12." }, { "code": "cabinet_exemption_unavailable", "type": null, "when": "[requirement_error] No s.12 exemption had been granted at the Guidance revision of 25 February 2026." }, { "code": "entity_in_exempt_class", "type": null, "when": "[invalid_request_error] A s.80 company or registered NPO is exempt from BOTA altogether (s.10)." } ] } }, "Params_ky_books_location_file": { "type": "object", "properties": { "reporting_year": { "type": "integer", "description": "Calendar year the information relates to.", "examples": [ "2026" ] }, "books_kept_outside_islands": { "type": "boolean", "description": "True if any books are kept outside the Islands.", "examples": [ "true" ] }, "files_accounts_information_with_cima": { "type": "boolean", "description": "True if a regulatory law already requires this; no report is then due (s.59)." }, "location": { "$ref": "#/components/schemas/Address", "description": "Where the books are kept." }, "custodian": { "type": "object", "description": "{name, relationship: director | accountant | administrator | parent_company | other, email, phone}." }, "format": { "type": "string", "enum": [ "paper", "electronic", "both" ], "description": "Form of the books." }, "books_cover_from": { "type": "string", "format": "date", "description": "Earliest date covered at that location." }, "books_cover_to": { "type": "string", "format": "date", "description": "Latest date covered." }, "retention_confirmed": { "type": "boolean", "description": "Books and underlying documents kept at least five years from preparation (s.59)." } }, "required": [ "reporting_year", "books_kept_outside_islands" ], "description": "Gives the registered office the information the Companies Act requires when a company keeps its books of account outside the Cayman Islands: where they are, who holds them, their form and period." }, "Create_ky_books_location_file": { "type": "object", "properties": { "type": { "const": "ky.books_location.file" }, "params": { "$ref": "#/components/schemas/Params_ky_books_location_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report where books of account are kept outside the Islands", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "books_location_statement", "title": "Statement of where books are kept", "source": "generated", "required": true }, { "key": "custodian_confirmation", "title": "Custodian's confirmation", "source": "uploaded", "required": false }, { "key": "registered_office_receipt", "title": "Registered office acknowledgement", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "custodian", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "books_location_statement", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. The information goes to the company's registered office", "form": "Information regarding books of account in the form and manner prescribed", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "books_kept_in_islands", "type": null, "when": "[invalid_request_error] Books are in the Islands; no s.59 report is due." }, { "code": "exempt_under_s59_2c", "type": null, "when": "[invalid_request_error] The company files accounts information with CIMA; s.59 does not apply." }, { "code": "entity_type_not_applicable", "type": null, "when": "[jurisdiction_error] LLCs and ELPs have no s.59 equivalent." }, { "code": "custodian_details_missing", "type": null, "when": "[requirement_error] A custodian name and contact are required." } ] } }, "Params_ky_building_society_annual_fee_pay": { "type": "object", "properties": { "incorporation_date": { "type": "string", "format": "date", "description": "Date of incorporation shown on the certificate of incorporation.", "examples": [ "1998-11-20" ] }, "anniversary_date": { "type": "string", "format": "date", "description": "The anniversary of incorporation on which this fee falls due (s.8).", "examples": [ "2026-11-20" ] }, "fee_year": { "type": "integer", "description": "Calendar year of the anniversary.", "examples": [ "2026" ] }, "payment_method": { "type": "string", "enum": [ "card_ciregistry_ky", "cheque", "local_eft", "international_wire" ], "description": "How the fee reaches the Registry.", "examples": [ "card_ciregistry_ky" ] }, "authorising_officer": { "type": "string", "pattern": "^per_", "description": "Secretary, manager or director who authorises the payment.", "examples": [ "per_1Ck6SxVa3Lt8" ] }, "amount": { "$ref": "#/components/schemas/Money", "description": "Defaults to CI$100.00.", "examples": [ "10000 KYD" ] } }, "required": [ "incorporation_date", "anniversary_date", "fee_year", "payment_method", "authorising_officer" ], "description": "Pays the CI$100 annual fee a building society owes the Registrar on each anniversary of its incorporation (Building Societies Law s.8) and records the receipt. The separate CI$7,000 regulatory fee is ky.building_society_regulatory_fee.pay." }, "Create_ky_building_society_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.building_society_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_building_society_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Building society: pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "building_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_instruction", "title": "Payment instruction and cover note", "source": "generated", "required": true }, { "key": "payment_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "payment_instruction", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar", "form": "No form. Annual fee under Building Societies Law", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "amount_mismatch", "type": null, "when": "amount is not CI$100.00 (s.8)." }, { "code": "anniversary_mismatch", "type": null, "when": "anniversary_date does not fall on the month and day of incorporation_date." }, { "code": "fee_already_paid", "type": null, "when": "The annual fee for this anniversary has already been paid." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a building society." } ] } }, "Params_ky_building_society_annual_statement_file": { "type": "object", "properties": { "official_year_end": { "type": "string", "format": "date", "description": "End of the society's official year to which the account and statement are made up (s.22).", "examples": [ "2026-06-30" ] }, "general_meeting_date": { "type": "string", "format": "date", "description": "Date of the annual or other general meeting at which the statement is presented.", "examples": [ "2026-10-08" ] }, "auditors": { "type": "array", "items": {}, "description": "person_refs of the Cabinet-approved auditors to whom the mortgage deeds and securities are produced (s.21, s.1 definition)." }, "secretary_or_manager": { "type": "string", "pattern": "^per_", "description": "Secretary or manager who prepares and countersigns the statement.", "examples": [ "per_1Ck6SxVa3Lt8" ] }, "mortgage_securities_inspected": { "type": "boolean", "description": "Confirms the auditors actually inspected the mortgage deeds and other securities (s.22).", "examples": [ "true" ] }, "authority_form_reference": { "type": "string", "description": "Form or particulars CIMA has directed under s.22, if any.", "examples": [ "CIMA direction of 2021-03-01" ] }, "gazette_notice_date": { "type": "string", "format": "date", "description": "Planned date of the Gazette notice (s.21).", "examples": [ "2026-10-30" ] }, "acknowledge_late_filing": { "type": "boolean", "description": "Set true to proceed when the 14 day window has already passed.", "examples": [ "false" ] } }, "required": [ "official_year_end", "general_meeting_date", "auditors", "secretary_or_manager", "mortgage_securities_inspected" ], "description": "Prepares the yearly account of receipts and expenditure and general statement of funds, liabilities and assets, has the auditors attest it and the secretary or manager countersign it, sends a copy to CIMA within 14 days after the general." }, "Create_ky_building_society_annual_statement_file": { "type": "object", "properties": { "type": { "const": "ky.building_society_annual_statement.file" }, "params": { "$ref": "#/components/schemas/Params_ky_building_society_annual_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Building society: send the annual account and statement to CIMA and gazette it", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "building_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_account_and_statement", "title": "Annual account and general statement", "source": "uploaded", "required": true }, { "key": "auditor_certificate_securities_inspected", "title": "Auditor's attestation and certificate that securities were inspected", "source": "uploaded", "required": true }, { "key": "cover_letter_to_authority", "title": "Letter sending the copy to CIMA", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of the statement", "source": "generated", "required": true }, { "key": "office_display_notice", "title": "Copy to display in each office", "source": "generated", "required": false }, { "key": "authority_acknowledgement", "title": "CIMA acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_account_and_statement", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_account_and_statement", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cover_letter_to_authority", "signer_role": "company_secretary", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Annual account and statement under s.21, in the form CIMA directs with Cabinet approval", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_not_cabinet_approved", "type": null, "when": "An auditor is not shown as approved by the Cabinet." }, { "code": "securities_inspection_not_confirmed", "type": null, "when": "mortgage_securities_inspected is false (s.22)." }, { "code": "send_window_expired", "type": null, "when": "More than 14 days since general_meeting_date and acknowledge_late_filing is not true." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a building society." } ] } }, "Params_ky_building_society_regulatory_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year whose 15 January deadline the fee meets.", "examples": [ "2027" ] }, "due_date": { "type": "string", "format": "date", "description": "15 January of fee_year (s.8).", "examples": [ "2027-01-15" ] }, "payment_method": { "type": "string", "enum": [ "card_ciregistry_ky", "cheque", "local_eft", "international_wire" ], "description": "How the fee reaches the Registry.", "examples": [ "card_ciregistry_ky" ] }, "authorising_officer": { "type": "string", "pattern": "^per_", "description": "Secretary, manager or director who authorises the payment.", "examples": [ "per_1Ck6SxVa3Lt8" ] }, "amount": { "$ref": "#/components/schemas/Money", "description": "Defaults to CI$7,000.00.", "examples": [ "700000 KYD" ] } }, "required": [ "fee_year", "due_date", "payment_method", "authorising_officer" ], "description": "Pays the CI$7,000 regulatory fee a building society owes the Registrar on or before 15 January each year (Building Societies Law s.8) and records the receipt." }, "Create_ky_building_society_regulatory_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.building_society_regulatory_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_building_society_regulatory_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Building society: pay the regulatory fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "building_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_instruction", "title": "Payment instruction and cover note", "source": "generated", "required": true }, { "key": "payment_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "payment_instruction", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar", "form": "No form. Regulatory fee under Building Societies Law", "channel": "online", "government_fee": { "amount": 7000, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "amount_mismatch", "type": null, "when": "amount is not CI$7,000.00 (s.8)." }, { "code": "due_date_mismatch", "type": null, "when": "due_date is not 15 January of fee_year." }, { "code": "fee_already_paid", "type": null, "when": "The regulatory fee for fee_year has already been paid." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a building society." } ] } }, "Params_ky_cbc_notification_file": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "initial_notification", "update_upe_or_spe", "update_constituent_entities", "update_primary_contact" ], "description": "initial_notification: the one-off notification.", "examples": [ "initial_notification" ] }, "mne_group_name": { "type": "string", "description": "Name of the MNE group.", "examples": [ "Meridian Group" ] }, "reporting_entity_role": { "type": "string", "enum": [ "ultimate_parent_entity", "surrogate_parent_entity" ], "description": "Whether this Cayman-resident entity reports as UPE or as SPE.", "examples": [ "ultimate_parent_entity" ] }, "reporting_entity_tax_reference": { "type": "string", "description": "The Reporting Entity's tax identifier.", "examples": [ "CAY-TIN-0057213" ] }, "fiscal_year_start": { "type": "string", "format": "date", "description": "Start of the relevant fiscal year.", "examples": [ "2027-01-01" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "End of the relevant fiscal year.", "examples": [ "2027-12-31" ] }, "prior_year_consolidated_revenue": { "$ref": "#/components/schemas/Money", "description": "Consolidated group revenue in the preceding fiscal year, in USD.", "examples": [ "112000000000 USD" ] }, "ultimate_parent_entity": { "type": "object", "description": "Required when the Reporting Entity is an SPE: {name, tax_jurisdiction, tax_reference, address}." }, "primary_contact": { "type": "string", "pattern": "^per_", "description": "The Primary Contact on the DITC Portal.", "examples": [ "per_5Yh3RcKd8Ns2" ] }, "additional_users": { "type": "array", "items": {}, "description": "person_refs of further portal users, described in the DITC Additional User File." }, "authorising_signatory": { "type": "string", "pattern": "^per_", "description": "The director, general partner or manager who signs the Letter of Authorisation.", "examples": [ "per_8Bz6MqWt1Lf4" ] } }, "required": [ "change_type", "mne_group_name", "reporting_entity_role", "reporting_entity_tax_reference", "fiscal_year_start", "fiscal_year_end", "prior_year_consolidated_revenue", "primary_contact", "authorising_signatory" ], "description": "For a Cayman-resident ultimate or surrogate parent of an MNE group with consolidated revenue of US$850 million or more in the preceding fiscal year, files the one-off CbC Notification on the DITC Portal before the end of the relevant." }, "Create_ky_cbc_notification_file": { "type": "object", "properties": { "type": { "const": "ky.cbc_notification.file" }, "params": { "$ref": "#/components/schemas/Params_ky_cbc_notification_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Country-by-Country reporting: file or update the CbC Notification", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc", "foundation_company", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "constituent_entities_file", "title": "Constituent Entities File", "source": "uploaded", "required": true }, { "key": "revenue_evidence", "title": "Consolidated financial statements showing preceding-year revenue", "source": "uploaded", "required": true }, { "key": "letter_of_authorisation", "title": "Letter of Authorisation", "source": "generated", "required": true }, { "key": "additional_user_file", "title": "Additional User File", "source": "generated", "required": false }, { "key": "group_structure_chart", "title": "Group structure chart", "source": "uploaded", "required": false }, { "key": "portal_notification_confirmation", "title": "DITC Portal confirmation of the notification", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "letter_of_authorisation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "constituent_entities_file", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "CbC Notification on the DITC Portal, with Constituent Entities File", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "below_revenue_threshold", "type": null, "when": "prior_year_consolidated_revenue is below US$850 million." }, { "code": "reporting_entity_not_cayman_resident", "type": null, "when": "The entity is not tax resident in the Cayman Islands." }, { "code": "notification_window_closed", "type": null, "when": "fiscal_year_end has passed for an initial_notification." }, { "code": "constituent_entities_file_invalid", "type": null, "when": "The CSV does not match the DITC template." }, { "code": "portal_user_not_authorised", "type": null, "when": "The Letter of Authorisation or Additional User File has not been accepted by DITC." }, { "code": "entity_type_not_supported", "type": null, "when": "entity type is not in applies_to." } ] } }, "Params_ky_cbc_report_file": { "type": "object", "properties": { "reporting_fiscal_year": { "type": "integer", "description": "The fiscal year the report covers, identified by the year in which it ends.", "examples": [ "2025" ] }, "fiscal_year_start": { "type": "string", "format": "date", "description": "First day of the reported fiscal year.", "examples": [ "2025-01-01" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Last day of the reported fiscal year.", "examples": [ "2025-12-31" ] }, "mne_group_name": { "type": "string", "description": "Name of the MNE group.", "examples": [ "Meridian Group" ] }, "reporting_entity_role": { "type": "string", "enum": [ "ultimate_parent_entity", "surrogate_parent_entity" ], "description": "Whether the Cayman entity reports as UPE or SPE.", "examples": [ "ultimate_parent_entity" ] }, "submission_type": { "type": "string", "enum": [ "new", "correction", "deletion" ], "description": "Maps to the OECD CbC XML DocTypeIndic.", "examples": [ "new" ] }, "prior_submission_reference": { "type": "string", "description": "DocRefId or portal reference of the earlier submission.", "examples": [ "CAY2025MERIDIAN-0001" ] }, "xml_file": { "type": "string", "pattern": "^doc_", "description": "The CbC Report XML, produced to the OECD CbC XML Schema and the Cayman CbC XML Schema User Guide." }, "consolidated_group_revenue": { "$ref": "#/components/schemas/Money", "description": "Consolidated group revenue for the reported fiscal year, in USD.", "examples": [ "118000000000 USD" ] }, "primary_contact": { "type": "string", "pattern": "^per_", "description": "The Primary Contact on the DITC Portal.", "examples": [ "per_5Yh3RcKd8Ns2" ] }, "authorising_signatory": { "type": "string", "pattern": "^per_", "description": "Director, general partner or manager who confirms the data is accurate to the best of the group's knowledge.", "examples": [ "per_8Bz6MqWt1Lf4" ] } }, "required": [ "reporting_fiscal_year", "fiscal_year_start", "fiscal_year_end", "mne_group_name", "reporting_entity_role", "submission_type", "xml_file", "consolidated_group_revenue", "primary_contact", "authorising_signatory" ], "description": "Validates the group's CbC XML file against the OECD CbC XML Schema and the Cayman CbC XML Schema User Guide, then uploads the CbC Report on the DITC Portal within 12 months after the fiscal year-end. The portal does not allow test uploads." }, "Create_ky_cbc_report_file": { "type": "object", "properties": { "type": { "const": "ky.cbc_report.file" }, "params": { "$ref": "#/components/schemas/Params_ky_cbc_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Country-by-Country reporting: file the CbC Report", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc", "foundation_company", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cbc_report_xml", "title": "CbC Report XML", "source": "uploaded", "required": true }, { "key": "xml_validation_report", "title": "Entiva offline schema validation report", "source": "generated", "required": true }, { "key": "data_accuracy_confirmation", "title": "Authorised signatory's data accuracy confirmation", "source": "generated", "required": true }, { "key": "group_data_support", "title": "Group working papers for the tables", "source": "uploaded", "required": false }, { "key": "portal_submission_receipt", "title": "DITC Portal submission receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "data_accuracy_confirmation", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cbc_report_xml", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "CbC Report, OECD CbC XML Schema", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notification_missing", "type": null, "when": "No CbC Notification exists for this Reporting Entity and fiscal year." }, { "code": "xml_schema_validation_failed", "type": null, "when": "The XML fails the OECD CbC XML Schema or the Cayman user guide checks." }, { "code": "portal_user_not_authorised", "type": null, "when": "Entiva's Entiva is not yet a DITC Portal user for this entity." }, { "code": "below_revenue_threshold", "type": null, "when": "consolidated_group_revenue for the preceding fiscal year is below US$850 million." }, { "code": "report_already_submitted", "type": null, "when": "A new report for this fiscal year was already filed; use submission_type correction." }, { "code": "entity_type_not_supported", "type": null, "when": "entity type is not in applies_to." } ] } }, "Params_ky_cima_society_accounts_file": { "type": "object", "properties": { "society_type": { "type": "string", "enum": [ "credit_union", "building_society" ], "description": "credit_union or building_society." }, "financial_year_end": { "type": "string", "format": "date", "description": "Credit union: year end." }, "auditor": { "type": "string", "pattern": "^per_", "description": "Auditor approved by CIMA (credit union, s.39) or Cabinet." }, "auditor_approval_ref": { "type": "string", "description": "Reference of the CIMA or Cabinet approval of the auditor." }, "authorised_officer": { "type": "string", "pattern": "^per_", "description": "Credit union officer, or the building society's secretary or manager (who countersigns, s.21)." }, "committee_approval_date": { "type": "string", "format": "date", "description": "Credit union: date the committee approved the accounts." }, "general_meeting_date": { "type": "string", "format": "date", "description": "Building society: meeting presenting the statement; CIMA's copy is due 14 days later." }, "auditor_conclusion": { "type": "string", "enum": [ "certified_correct", "special_report" ], "description": "Building society: certified correct, or special report (s.22)." }, "properties_inspected": { "type": "integer", "description": "Building society: properties whose deeds the auditor inspected (s.22)." }, "dividend_or_bonus_planned": { "type": "boolean", "description": "Credit union: if true, an approved auditor must certify the balance sheet first (s.34)." }, "extension_approval_ref": { "type": "string", "description": "CIMA's prior written approval of an extension, if any." } }, "required": [ "society_type", "financial_year_end", "auditor", "auditor_approval_ref", "authorised_officer" ], "description": "Sends a credit union's audited accounts or a building society's attested account and statement to CIMA. Credit unions are outside the Registrar's s.45 audit." }, "Create_ky_cima_society_accounts_file": { "type": "object", "properties": { "type": { "const": "ky.cima_society_accounts.file" }, "params": { "$ref": "#/components/schemas/Params_ky_cima_society_accounts_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a credit union's or building society's audited accounts with CIMA", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society", "building_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "audited_financial_statements", "title": "Audited accounts, or annual account and general statement", "source": "uploaded", "required": true }, { "key": "auditor_report", "title": "Auditor's report, certificate or special report", "source": "uploaded", "required": true }, { "key": "auditor_approval_evidence", "title": "CIMA or Cabinet approval of the auditor", "source": "uploaded", "required": true }, { "key": "approval_record", "title": "Committee resolution or general meeting minutes", "source": "uploaded", "required": true }, { "key": "submission_cover_letter", "title": "Cover letter to CIMA", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice", "source": "generated", "required": false }, { "key": "extension_approval", "title": "CIMA extension approval", "source": "uploaded", "required": false }, { "key": "cima_acknowledgement", "title": "CIMA acknowledgement", "source": "registry_issued", "required": false }, { "key": "cima_submission", "title": "Cima submission", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "audited_financial_statements", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "approval_record", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "cima_submission", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority, Banking Supervision Division", "form": "Audited accounts of a credit union", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_not_approved", "type": null, "when": "No CIMA or Cabinet approval of the auditor on file." }, { "code": "required_param_missing_for_type", "type": null, "when": "A parameter required for the chosen society_type is missing." }, { "code": "deadline_passed_no_extension", "type": null, "when": "Past the deadline with no CIMA extension; filed but flagged late." }, { "code": "balance_sheet_not_certified", "type": null, "when": "Credit union dividend planned and balance sheet not certified." }, { "code": "gazette_notice_pending", "type": null, "when": "Building society cannot complete until the Gazette notice is published." } ] } }, "Params_ky_cooperative_society_annual_return_file": { "type": "object", "properties": { "return_year": { "type": "integer", "description": "Calendar year in which the return is made.", "examples": [ "2026" ] }, "period_start": { "type": "string", "format": "date", "description": "Start of the period the balance sheet covers: the date of registration, or the day after the last return's period ended (reg 4).", "examples": [ "2025-01-01" ] }, "period_end": { "type": "string", "format": "date", "description": "End of the period the balance sheet covers.", "examples": [ "2025-12-31" ] }, "registered_address_changed": { "type": "boolean", "description": "True if the registered address changed since registration or the last return (reg 4).", "examples": [ "false" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered address." }, "officers": { "type": "array", "items": {}, "description": "Officers with their designations (reg 4)." }, "members_count": { "type": "integer", "description": "Number of members.", "examples": [ "112" ] }, "outstanding_charges": { "type": "array", "items": {}, "description": "Charges entered into by the society and still outstanding (reg 4)." }, "auditor": { "type": "string", "pattern": "^per_", "description": "The independent auditor who certifies the balance sheet.", "examples": [ "per_9Ls2VxRe5Tn1" ] }, "auditor_approval_reference": { "type": "string", "description": "Reference or date of the Registrar's approval of this auditor.", "examples": [ "Approved 2024-03-18" ] }, "is_credit_union": { "type": "boolean", "description": "True for a credit union.", "examples": [ "false" ] }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "The officer who signs the return.", "examples": [ "per_4Ew7YcPo2Ju9" ] } }, "required": [ "return_year", "period_start", "period_end", "registered_address_changed", "officers", "members_count", "outstanding_charges", "auditor", "auditor_approval_reference", "is_credit_union", "signing_officer" ], "description": "Prepares and delivers the yearly return that a registered co-operative society makes to the Registrar: registered address if changed, officers, members and shares, outstanding charges, and a balance sheet with accounts certified by an." }, "Create_ky_cooperative_society_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.cooperative_society_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_cooperative_society_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Co-operative society: file the annual return with the Registrar", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "balance_sheet_and_accounts", "title": "Balance sheet and supporting accounts", "source": "uploaded", "required": true }, { "key": "auditor_certificate", "title": "Independent auditor's certificate on the balance sheet", "source": "uploaded", "required": true }, { "key": "auditor_approval_evidence", "title": "Registrar's approval of the auditor", "source": "uploaded", "required": true }, { "key": "annual_return_form", "title": "Annual return", "source": "generated", "required": true }, { "key": "members_and_shareholdings_list", "title": "Members and shares held by each", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry acknowledgement or receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_form", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_certificate", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Cooperative Societies", "form": "Annual return with the reg 4 particulars. No prescribed form", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "auditor_not_approved", "type": null, "when": "No evidence that the Registrar approved the auditor (reg 4)." }, { "code": "period_gap", "type": null, "when": "period_start is not the day after the previous return's period_end." }, { "code": "return_already_filed", "type": null, "when": "A return for return_year has already been filed for this society." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a co-operative society." }, { "code": "credit_union_confirmation_pending", "type": null, "when": "is_credit_union is true and the Registrar has not confirmed that reg 4 applies alongside s.39." } ] } }, "Params_ky_cooperative_society_audit_file": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date", "description": "Start of the period audited." }, "period_end": { "type": "string", "format": "date", "description": "End of the period audited." }, "credit_union_business": { "type": "boolean", "description": "True for a credit union, which is rejected; use ky.cima_society_accounts.file." }, "books_location": { "$ref": "#/components/schemas/Address", "description": "Where books, cash and securities are kept for inspection." }, "authorised_officer": { "type": "string", "pattern": "^per_", "description": "Officer who instructs Entiva and attends the audit." }, "overdue_debts_present": { "type": "boolean", "description": "True if any debt owed to the society is overdue (s.45)." }, "dividend_or_bonus_planned": { "type": "boolean", "description": "If true, an approved auditor must first certify the balance sheet (s.34)." }, "dividend_rate_percent": { "type": "number", "description": "Proposed dividend rate per annum, at most 6 (s.34)." } }, "required": [ "period_start", "period_end", "credit_union_business", "books_location", "authorised_officer", "overdue_debts_present", "dividend_or_bonus_planned" ], "description": "Builds the audit pack and produces the society's books, cash and securities to the Registrar's auditor. The Registrar must audit every society other than a credit union at least once a year." }, "Create_ky_cooperative_society_audit_file": { "type": "object", "properties": { "type": { "const": "ky.cooperative_society_audit.file" }, "params": { "$ref": "#/components/schemas/Params_ky_cooperative_society_audit_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit books and records for the Registrar's annual audit of a co-operative society", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "books_of_account", "title": "Books of account", "source": "uploaded", "required": true }, { "key": "balance_sheet_and_income_statement", "title": "Balance sheet and income statement", "source": "uploaded", "required": true }, { "key": "bank_statements_and_securities", "title": "Bank statements, cash count and securities list", "source": "uploaded", "required": true }, { "key": "overdue_debts_schedule", "title": "Overdue debts schedule", "source": "generated", "required": true }, { "key": "assets_and_liabilities_valuation", "title": "Assets and liabilities valuation", "source": "generated", "required": true }, { "key": "audit_pack_index", "title": "Audit pack index", "source": "generated", "required": true }, { "key": "auditor_certified_balance_sheet", "title": "Certified balance sheet", "source": "uploaded", "required": false }, { "key": "registrar_audit_findings", "title": "Registrar's audit findings", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "audit_pack_index", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_certified_balance_sheet", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Co-operative Societies, General Registry", "form": "No form. Books, accounts, cash and securities are produced to the Registrar's auditor on r", "channel": "none", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "credit_union_not_supported", "type": null, "when": "credit_union_business is true; credit unions fall under s.39." }, { "code": "dividend_exceeds_limit", "type": null, "when": "dividend_rate_percent is above 6 (s.34)." }, { "code": "balance_sheet_not_certified", "type": null, "when": "A dividend is planned and no certified balance sheet is attached." }, { "code": "registration_cancelled", "type": null, "when": "The society's registration is cancelled." } ] } }, "Params_ky_cooperative_society_audit_prepare": { "type": "object", "properties": { "audit_period_start": { "type": "string", "format": "date", "description": "First day of the accounting period to be audited.", "examples": [ "2025-01-01" ] }, "audit_period_end": { "type": "string", "format": "date", "description": "Last day of the accounting period to be audited.", "examples": [ "2025-12-31" ] }, "carries_on_credit_union_business": { "type": "boolean", "description": "Must be false.", "examples": [ "false" ] }, "books_location": { "$ref": "#/components/schemas/Address", "description": "Where the books, accounts, papers and securities are kept." }, "instructing_officer": { "type": "string", "pattern": "^per_", "description": "The secretary, treasurer or other officer who produces the books and answers the Registrar's questions.", "examples": [ "per_4Ew7YcPo2Ju9" ] }, "other_officers_available": { "type": "array", "items": {}, "description": "person_refs of officers, agents or members the Registrar may summon under s.45." }, "registrar_audit_notice_reference": { "type": "string", "description": "Reference of the Registrar's written general or special order authorising the audit or the auditor, if received.", "examples": [ "RCS/AUD/2026/014" ] }, "authorised_auditor_name": { "type": "string", "description": "Name of the person the Registrar has authorised to audit, if not the Registrar.", "examples": [ "Registrar's authorised examiner" ] }, "cash_in_hand": { "$ref": "#/components/schemas/Money", "description": "Cash held at the audit date, to be produced for inspection." }, "dividend_or_bonus_planned": { "type": "boolean", "description": "If true, Entiva blocks any dividend or bonus until the balance sheet is certified by an auditor approved by the Registrar (s.34).", "examples": [ "false" ] }, "target_audit_date": { "type": "string", "format": "date", "description": "Date agreed with the Registrar's office for the audit, if any.", "examples": [ "2026-11-12" ] } }, "required": [ "audit_period_start", "audit_period_end", "carries_on_credit_union_business", "books_location", "instructing_officer" ], "description": "Assembles the books, accounts, overdue-debt schedule and asset and liability valuation that a co-operative society must produce for the Registrar's yearly audit under Cooperative Societies Law s.45, and tracks the audit to close-out.." }, "Create_ky_cooperative_society_audit_prepare": { "type": "object", "properties": { "type": { "const": "ky.cooperative_society_audit.prepare" }, "params": { "$ref": "#/components/schemas/Params_ky_cooperative_society_audit_prepare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Co-operative society: prepare for the Registrar's annual audit", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "books_of_account", "title": "Books of account for the period", "source": "uploaded", "required": true }, { "key": "balance_sheet_and_income_statement", "title": "Balance sheet and income statement", "source": "uploaded", "required": true }, { "key": "overdue_debts_schedule", "title": "Schedule of overdue debts", "source": "uploaded", "required": true }, { "key": "assets_and_liabilities_valuation", "title": "Valuation of assets and liabilities", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members and shares", "source": "uploaded", "required": true }, { "key": "bank_and_securities_evidence", "title": "Bank statements and evidence of securities held", "source": "uploaded", "required": true }, { "key": "rules_and_minutes", "title": "Registered rules and committee minutes for the period", "source": "uploaded", "required": false }, { "key": "audit_pack_index", "title": "Audit pack index", "source": "generated", "required": true }, { "key": "officer_records_confirmation", "title": "Officer's confirmation that the records are complete", "source": "generated", "required": true }, { "key": "registrar_audit_report", "title": "Registrar's audit report or findings letter", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "officer_records_confirmation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Cooperative Societies", "form": "None prescribed. Audit under s.45 of the Cooperative Societies Law", "channel": "none", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "credit_union_out_of_scope", "type": null, "when": "carries_on_credit_union_business is true." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a co-operative society." }, { "code": "audit_period_invalid", "type": null, "when": "audit_period_end is before audit_period_start or in the future." }, { "code": "overdue_debts_schedule_missing", "type": null, "when": "No overdue debts schedule was uploaded; s.45 requires the audit to examine overdue debts." }, { "code": "instructing_officer_not_verified", "type": null, "when": "The instructing officer has not reached identity_address." } ] } }, "Params_ky_crs_compliance_form_file": { "type": "object", "properties": { "reporting_year": { "type": "integer", "description": "Reporting year covered.", "examples": [ "2026" ] }, "fi_number": { "type": "string", "description": "The TIA FI number." }, "submission_method": { "type": "string", "enum": [ "smart_form", "bulk_csv" ], "description": "smart_form or bulk_csv." }, "form_data": { "type": "object", "description": "Answers per Section 5.F of the CRS Guidelines, including Section 2 on non-reportable accounts; 'unknown' invites follow-up." }, "written_policies_current": { "type": "boolean", "description": "Written CRS policies are in place and current." }, "declaration_adequate_accurate_current": { "type": "boolean", "description": "Declaration of adequate, accurate and current information." } }, "required": [ "reporting_year", "fi_number", "form_data", "written_policies_current", "declaration_adequate_accurate_current" ], "description": "Files the CRS Compliance Form on the DITC Portal, completed yearly by every FI with CRS reporting obligations, including Trustee Documented Trusts. Only the PPoC or an assigned Secondary User can submit it." }, "Create_ky_crs_compliance_form_file": { "type": "object", "properties": { "type": { "const": "ky.crs_compliance_form.file" }, "params": { "$ref": "#/components/schemas/Params_ky_crs_compliance_form_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual CRS Compliance Form", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "compliance_form_data", "title": "Form answers", "source": "generated", "required": true }, { "key": "portal_receipt", "title": "DITC receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "compliance_form_data", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "portal_receipt", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "CRS Compliance Form", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_a_submitter", "type": null, "when": "[registry_error] User is neither the PPoC nor an assigned Secondary User." }, { "code": "section_2_unknown", "type": null, "when": "[requirement_error] Section 2 answers are 'unknown'; supply data or expect follow-up." }, { "code": "policies_not_current", "type": null, "when": "[requirement_error] Written CRS policies are missing or stale." } ] } }, "Params_ky_crs_return_file": { "type": "object", "properties": { "reporting_year": { "type": "integer", "description": "Calendar year reported; 2026 is due 30 June 2027.", "examples": [ "2026" ] }, "submission_type": { "type": "string", "enum": [ "original", "correction", "deletion", "nil_return_declaration" ], "description": "nil_return_declaration is the CRS Filing Declaration.", "examples": [ "original" ] }, "fi_number": { "type": "string", "description": "The TIA FI number." }, "account_data": { "type": "string", "pattern": "^doc_", "description": "CSV or XML of Reportable Accounts with self-certification data; required unless nil." }, "corrects_message_ref_id": { "type": "string", "description": "MessageRefId being corrected or deleted." }, "tin_dob_gaps": { "type": "array", "items": {}, "description": "Accounts missing a TIN or date of birth; held data must be reported, otherwise reasonable efforts and report by the end of the second year after identification." }, "declaration_adequate_accurate_current": { "type": "boolean", "description": "FI declares the information adequate, accurate and current." } }, "required": [ "reporting_year", "submission_type", "fi_number", "declaration_adequate_accurate_current" ], "description": "Files a Reporting FI's annual CRS return on the DITC Portal as CRS XML v3.0, or the CRS Filing Declaration when there are no reportable accounts. Entiva builds the XML, since the DITC no longer provides a generator." }, "Create_ky_crs_return_file": { "type": "object", "properties": { "type": { "const": "ky.crs_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_crs_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual CRS return or nil-return declaration", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "account_data", "title": "Reportable account data", "source": "uploaded", "required": false }, { "key": "crs_xml", "title": "CRS XML v3.0 file", "source": "generated", "required": false }, { "key": "crs_filing_declaration", "title": "CRS Filing Declaration", "source": "generated", "required": true }, { "key": "portal_receipt", "title": "DITC receipt and validation result", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "crs_filing_declaration", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "portal_receipt", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "CRS XML", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "portal_closed_for_crs_xml", "type": null, "when": "[registry_error] The portal is not accepting CRS XML; the action waits in in_preparation and submits on reopening." }, { "code": "xml_validation_failed", "type": null, "when": "[registry_error] Schema or business-rule validation failed." }, { "code": "fi_not_registered", "type": null, "when": "[requirement_error] No FI number; run ky.fatca_crs.register." }, { "code": "late_filing_penalty", "type": null, "when": "[registry_error] Deadline passed; a penalty notice can issue at once, with 30 days for representations." } ] } }, "Params_ky_economic_substance_notify": { "type": "object", "properties": { "esn_year": { "type": "integer", "description": "Calendar year in which the financial year being reported began.", "examples": [ "2026" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "First day of the financial year.", "examples": [ "2026-01-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year.", "examples": [ "2026-12-31" ] }, "submission_type": { "type": "string", "enum": [ "annual", "correction", "outstanding_prior_year", "pre_closure", "new_registered_office" ], "description": "annual; correction while the ESN Year is open in CAP; outstanding_prior_year; pre_closure; new_registered_office." }, "carried_on_relevant_activity": { "type": "boolean", "description": "Whether any relevant activity was carried on in the financial year.", "examples": [ "false" ] }, "relevant_activities": { "type": "array", "items": {}, "description": "Required if an activity was carried on." }, "exemption_type": { "type": "string", "enum": [ "none", "tax_resident_outside", "investment_fund", "domestic_company" ], "description": "Required if an activity was carried on. none = relevant entity; tax_resident_outside; investment_fund; domestic_company." }, "tax_residence_claim": { "type": "object", "description": "For tax_resident_outside: jurisdiction plus name and address of immediate parent, ultimate parent and ultimate beneficial owner (ES Act s.7)." }, "identifiers": { "type": "object", "description": "Optional {cima_registration: {type, number}, fi_number, giin, investment_fund: {classification}}." }, "responsible_person": { "type": "object", "description": "Required for a relevant entity or TRO claim: {type: registered_office | director, person_id, email}." }, "general_partners": { "type": "array", "items": {}, "description": "Partnerships: at least one general partner." } }, "required": [ "esn_year", "financial_year_start", "financial_year_end", "carried_on_relevant_activity" ], "description": "Files the entity's yearly ESN on CAP through its registered office: whether it carried on a relevant activity, financial year dates, any exemption, and the Responsible Person for later ES reporting. It gates the annual return and has no." }, "Create_ky_economic_substance_notify": { "type": "object", "properties": { "type": { "const": "ky.economic_substance.notify" }, "params": { "$ref": "#/components/schemas/Params_ky_economic_substance_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual Economic Substance Notification", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "esn_filing", "title": "ESN data as filed on CAP", "source": "generated", "required": true }, { "key": "esn_status_record", "title": "CAP Economic Substance Status record", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "esn_filing", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "esn_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Economic Substance Notification: CAP smart form or bulk CSV", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "esn_year_closed", "type": null, "when": "[registry_error] CAP no longer accepts that ESN Year; email DITC.EScompliance@gov.ky." }, { "code": "responsible_person_required", "type": null, "when": "[requirement_error] A relevant activity is stated but no valid Responsible Person is set." }, { "code": "entity_deactivated_in_cap", "type": null, "when": "[registry_error] Entity already struck off, deregistered or in liquidation; escalated to DITC." }, { "code": "entity_type_not_in_scope", "type": null, "when": "[jurisdiction_error] Ordinary resident companies confirm relevant activity on CBP with the annual return." } ] } }, "Params_ky_economic_substance_return_file": { "type": "object", "properties": { "esn_year": { "type": "integer", "description": "ESN Year of the period; its ESN must already be filed.", "examples": [ "2025" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "Period start.", "examples": [ "2025-01-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Period end; the return is due 12 months later.", "examples": [ "2025-12-31" ] }, "relevant_activity": { "type": "string", "enum": [ "banking", "distribution_and_service_centre", "financing_and_leasing", "fund_management", "headquarters", "holding_company", "insurance", "intellectual_property", "shipping", "none" ], "description": "The one activity covered; file separately per activity. 'none' only corrects a misclassified ESN.", "examples": [ "holding_company" ] }, "segregated_portfolio_name": { "type": "string", "description": "SPC only: one return per portfolio and activity." }, "foreign_branch": { "type": "object", "description": "{name, relevant_activity} of a branch tax resident elsewhere; excluded here and covered by a linked TRO Form." }, "reporting_currency": { "type": "string", "description": "ISO 4217; one currency for all amounts.", "examples": [ "USD" ] }, "total_income": { "$ref": "#/components/schemas/Money", "description": "Total gross income for the period." }, "relevant_income": { "$ref": "#/components/schemas/Money", "description": "Gross receipts from the activity, not profit." }, "passive_relevant_income": { "$ref": "#/components/schemas/Money", "description": "Dividends, interest, rent, royalties; amount or UNKNOWN." }, "parents": { "type": "object", "description": "{immediate_parents[], ultimate_parent | none | unknown}: name, TIN or NOTIN, tax residence, address." }, "ultimate_beneficial_owners": { "type": "array", "items": {}, "description": "Mandatory if satisfies_es_test is false." }, "ciga_and_outsourcing": { "type": "object", "description": "{ciga_in_islands[], activities_outside_islands, providers[{osp_id, ciga, expenditure, hours, monitored_in_islands}]}." }, "premises_staff_expenditure": { "type": "object", "description": "{premises_in_islands, address, tangible_assets, ip_assets, fte_in_islands, fte_on_ciga, qualified, total_operating, direct_operating, salaries, rent." }, "directed_and_managed": { "type": "object", "description": "Board knowledge, meeting frequency, quorum, minutes and records in the Islands, meeting counts." }, "high_risk_ip": { "type": "object", "description": "IP business only: {is_high_risk, will_rebut_presumption, business_plan_doc_id} (s.7,)." }, "satisfies_es_test": { "type": "boolean", "description": "The ES Test declaration.", "examples": [ "true" ] }, "financial_statements": { "type": "string", "pattern": "^doc_", "description": "Balance sheet and income statement with notes, or books of account; contracts and invoices not needed." } }, "required": [ "esn_year", "financial_year_start", "financial_year_end", "relevant_activity", "reporting_currency", "total_income", "relevant_income", "parents", "satisfies_es_test", "financial_statements" ], "description": "Files the ES Return on the DITC Portal for a relevant entity that carried on a relevant activity: relevant income, parents, core income-generating activities, premises, staff, spend, direction and management in the Islands, financial." }, "Create_ky_economic_substance_return_file": { "type": "object", "properties": { "type": { "const": "ky.economic_substance_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_economic_substance_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Economic Substance Return", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Financial statements or books of account", "source": "uploaded", "required": true }, { "key": "es_return_data", "title": "ES Return data as entered on the portal", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution approving the return", "source": "generated", "required": false }, { "key": "portal_submission_record", "title": "DITC Portal submission record", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "es_return_data", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "es_return_data", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "Economic Substance Return: smart form, one per relevant activity", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "esn_not_filed", "type": null, "when": "[requirement_error] No ESN for this year states a relevant activity, so the entity is not in the Responsible Person's portal account." }, { "code": "es_test_not_satisfied", "type": null, "when": "[requirement_error] Declaration is 'No'; compliance review first because s.8 penalties follow." }, { "code": "filing_deadline_passed", "type": null, "when": "[registry_error] 12 months passed: a s.7 Penalty Notice follows, and 30 days later without a return the entity is deemed to fail the ES Test." }, { "code": "portal_access_missing", "type": null, "when": "[registry_error] Partner is neither Responsible Person nor Secondary User, or its 2FA is inactive." } ] } }, "Params_ky_economic_substance_tro_file": { "type": "object", "properties": { "esn_year": { "type": "integer", "description": "ESN Year.", "examples": [ "2025" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "Period start.", "examples": [ "2025-01-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Period end; due 12 months later.", "examples": [ "2025-12-31" ] }, "claim_scope": { "type": "string", "enum": [ "entity", "foreign_branch", "partnership" ], "description": "entity; foreign_branch; partnership." }, "relevant_activity": { "type": "string", "enum": [ "banking", "distribution_and_service_centre", "financing_and_leasing", "fund_management", "headquarters", "holding_company", "insurance", "intellectual_property", "shipping", "none" ], "description": "Activity concerned; 'none' only to correct a misclassified ESN." }, "tax_residence_jurisdiction": { "type": "string", "description": "ISO 3166 code.", "examples": [ "SG" ] }, "immediate_parent": { "type": "object", "description": "Name, address, TIN, tax residence; or 'none'." }, "ultimate_parent": { "type": "object", "description": "Same details; or 'none'." }, "ultimate_beneficial_owners": { "type": "array", "items": {}, "description": "Name, address, tax residence, TIN where held." }, "evidence_of_tax_residence": { "type": "array", "items": {}, "description": "document_refs: tax authority certificate or letter, assessment, payment proof, tax return or ruling." }, "evidence_of_corporate_income_tax": { "type": "array", "items": {}, "description": "document_refs: assessment or payment proof, tax return, or confirmation a return is required." }, "special_cases": { "type": "object", "description": "{us_disregarded_entity: {us_parent, statement_doc_id}, partnership: {general_partner_id, effective_management_jurisdiction}, foreign_branch: {name}}." } }, "required": [ "esn_year", "financial_year_start", "financial_year_end", "claim_scope", "relevant_activity", "tax_residence_jurisdiction", "immediate_parent", "ultimate_parent", "ultimate_beneficial_owners", "evidence_of_tax_residence", "evidence_of_corporate_income_tax" ], "description": "Files the TRO Form on the DITC Portal for an entity that carried on a relevant activity but is tax resident outside the Islands, so need not meet the ES Test: jurisdiction, parents, ultimate beneficial owners and evidence of residence and." }, "Create_ky_economic_substance_tro_file": { "type": "object", "properties": { "type": { "const": "ky.economic_substance_tro.file" }, "params": { "$ref": "#/components/schemas/Params_ky_economic_substance_tro_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Tax Resident Outside the Islands Form", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "tax_residence_proof", "title": "Proof of tax residence", "source": "uploaded", "required": true }, { "key": "corporate_income_tax_proof", "title": "Proof of subjection to corporate income tax", "source": "uploaded", "required": true }, { "key": "us_disregarded_statement", "title": "Statement under penalty of perjury", "source": "uploaded", "required": false }, { "key": "tro_form_data", "title": "TRO Form data", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "tro_form_data", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "us_disregarded_statement", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "tro_form_data", "signer_role": "officer", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "Tax Resident Outside the Islands", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "jurisdiction_not_accepted", "type": null, "when": "[requirement_error] Jurisdiction has no corporate income tax system in the Guidance." }, { "code": "evidence_insufficient", "type": null, "when": "[requirement_error] Both proof of residence and proof of subjection to corporate tax are needed." }, { "code": "tro_sequence_error", "type": null, "when": "[registry_error] A later period was filed before an earlier one; delete and refile in order." }, { "code": "esn_does_not_claim_tro", "type": null, "when": "[requirement_error] The ESN for this year does not state tax residence outside; correct it first." } ] } }, "Params_ky_elp_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "regulated": { "type": "boolean", "description": "Whether the ELP is regulated, which sets the fee." }, "cima_registration_number": { "type": "string", "description": "CIMA registration number, if regulated; checks the fee tier." }, "s10_compliance_certified": { "type": "boolean", "description": "Certifies compliance with s.10 in the prior calendar year: change statements filed within sixty days (general-partner changes fifteen, s.10)." }, "s9_declaration_unbroken": { "type": "boolean", "description": "Certifies no breach of the s.9 declaration." }, "signatory": { "type": "string", "pattern": "^per_", "description": "General partner, or the individual authorised for a corporate general partner; defaults to a verified one." } }, "required": [ "regulated", "s10_compliance_certified", "s9_declaration_unbroken" ], "description": "Files the s.39 return of an exempted limited partnership, signed by or for a general partner, and pays the regulated or unregulated fee. Entiva on CAP." }, "Create_ky_elp_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.elp_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_elp_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the ELP annual return and pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "elp_annual_return", "title": "ELP annual return under s.39", "source": "generated", "required": true }, { "key": "gp_authority", "title": "General partner's authority for the partner or Entiva to sign and file", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "elp_annual_return", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "elp_annual_return", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual return, ELP Act s.39, with the annual fee", "channel": "online", "government_fee": { "amount": 1400, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "unfiled_s10_changes", "type": "requirement_error", "when": "A change in particulars was never filed under s.10; file it first." }, { "code": "regulated_status_unconfirmed", "type": "requirement_error", "when": "Regulated status, hence the fee tier, is unknown; the partner must confirm." }, { "code": "no_authorised_signatory", "type": "permission_error", "when": "No general partner, mandate or power of attorney authorises Entiva or the agent to sign." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_fatca_crs_register": { "type": "object", "properties": { "submission_type": { "type": "string", "enum": [ "initial", "change_form" ], "description": "initial or change_form." }, "became_fi_on": { "type": "string", "format": "date", "description": "Date the entity became an FI; its calendar year fixes the deadline." }, "frameworks": { "type": "array", "items": {}, "description": "Any of crs, fatca." }, "crs_status": { "type": "string", "enum": [ "reporting_fi", "non_reporting_fi", "trustee_documented_trust" ], "description": "Non-Reporting FIs still notify their status." }, "crs_fi_category": { "type": "string", "enum": [ "investment_entity", "depository_institution", "custodial_institution", "specified_insurance_company" ], "description": "Required for a Reporting FI." }, "giin": { "type": "string", "description": "IRS GIIN if issued; obtained from the IRS, not Entiva." }, "authorising_person": { "type": "string", "pattern": "^per_", "description": "Administers the entity's portal access." }, "principal_point_of_contact": { "type": "object", "description": "Required for initial: {type: individual | cayman_entity, person_id or entity_id, physical_address, email, phone}." }, "secondary_users": { "type": "array", "items": {}, "description": "person_refs or entity_refs allowed to submit reports." }, "change_form": { "type": "object", "description": "For change_form: {fi_number, changed_fields[], effective_date}; due within 30 days." } }, "required": [ "frameworks" ], "description": "Notifies the Tax Information Authority on the DITC Portal that the entity is a Financial Institution for CRS and/or FATCA, sets its status, names its Authorising Person, Cayman-based Principal Point of Contact and Secondary Users, and." }, "Create_ky_fatca_crs_register": { "type": "object", "properties": { "type": { "const": "ky.fatca_crs.register" }, "params": { "$ref": "#/components/schemas/Params_ky_fatca_crs_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a financial institution with the DITC", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "fi_classification_memo", "title": "FI classification memo", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution approving status and appointing the Authorising Person and PPoC", "source": "generated", "required": true }, { "key": "ppoc_acceptance", "title": "PPoC's acceptance", "source": "uploaded", "required": true }, { "key": "fi_notification_record", "title": "DITC notification record with FI number", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fi_classification_memo", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ppoc_acceptance", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "fi_notification_record", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "FI Notification", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fi_status_undetermined", "type": null, "when": "[requirement_error] The classification memo is unsigned or status cannot be determined." }, { "code": "ppoc_not_in_cayman", "type": null, "when": "[requirement_error] The PPoC is not an individual with a Cayman address or a Cayman entity with a physical presence." }, { "code": "portal_account_not_activated", "type": null, "when": "[registry_error] A named user has not activated their account or set up 2FA." }, { "code": "already_registered", "type": null, "when": "[invalid_request_error] The entity has an FI number; use change_form." } ] } }, "Params_ky_fatca_return_file": { "type": "object", "properties": { "reporting_year": { "type": "integer", "description": "Calendar year reported.", "examples": [ "2026" ] }, "submission_type": { "type": "string", "enum": [ "original", "correction", "nil_report" ], "description": "original, correction or nil_report." }, "fi_number": { "type": "string", "description": "The TIA FI number." }, "giin": { "type": "string", "description": "The FI's IRS GIIN." }, "account_data": { "type": "string", "pattern": "^doc_", "description": "CSV or XML of US reportable accounts; required unless nil_report." }, "us_tin_relief": { "type": "object", "description": "{claimed, notice: '2023-11' | '2024-78', dob_provided, tin_codes_provided}; relief needs dates of birth and TIN codes." } }, "required": [ "reporting_year", "submission_type", "fi_number", "giin" ], "description": "Files a Cayman FI's annual FATCA report on the DITC Portal as FATCA XML, or a nil report. The DITC's FATCA XML generator remains available." }, "Create_ky_fatca_return_file": { "type": "object", "properties": { "type": { "const": "ky.fatca_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_fatca_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual FATCA return", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "account_data", "title": "US reportable account data", "source": "uploaded", "required": false }, { "key": "fatca_xml", "title": "FATCA XML file", "source": "generated", "required": false }, { "key": "fatca_declaration", "title": "Director's confirmation", "source": "generated", "required": true }, { "key": "portal_receipt", "title": "DITC receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fatca_declaration", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "portal_receipt", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "FATCA XML upload", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "giin_missing", "type": null, "when": "[requirement_error] No GIIN on record; the FI obtains it from the IRS." }, { "code": "xml_validation_failed", "type": null, "when": "[registry_error] Validation failed." }, { "code": "fi_not_registered", "type": null, "when": "[requirement_error] No FI number." }, { "code": "tin_relief_conditions_unmet", "type": null, "when": "[requirement_error] Relief claimed without dates of birth or TIN codes." } ] } }, "Params_ky_foreign_company_annual_fee_pay": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Director, officer or Cayman-resident agent authorised to act; defaults to a verified one." } }, "description": "Pays the January annual fee of a foreign company registered under Companies Act Part 9 (s.184). No annual return; late payment attracts a percentage penalty." }, "Create_ky_foreign_company_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.foreign_company_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_company_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the foreign company annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "filing_authorisation", "title": "Standing authorisation to pay or file", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual fee, Companies Act s.184", "channel": "online", "government_fee": { "amount": 1750, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "foreign_company_registration_ceased", "type": "jurisdiction_error", "when": "No longer a foreign company or removed from the register; no fee due." }, { "code": "no_payment_channel", "type": "registry_error", "when": "Registry payment route unavailable; Entiva falls back to the manual route." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_foreign_lp_annual_fee_pay": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Person authorised to act for the foreign limited partnership; defaults to a verified authorised person." } }, "description": "Pays the January annual fee of a foreign limited partnership registered under ELP Act s.42. No annual return; late payment attracts a percentage penalty." }, "Create_ky_foreign_lp_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.foreign_lp_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_lp_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "filing_authorisation", "title": "Standing authorisation to pay or file", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "limited_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual fee, ELP Act s.42", "channel": "online", "government_fee": { "amount": 1650, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "foreign_lp_registration_ceased", "type": "jurisdiction_error", "when": "Ceased to be a general partner of an ELP and file closed (ELP Act s.42-); no fee due." }, { "code": "no_payment_channel", "type": "registry_error", "when": "Registry payment route unavailable; Entiva falls back to the manual route." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_friendly_society_mortality_return_file": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date", "description": "Start of the five-year period." }, "period_end": { "type": "string", "format": "date", "description": "End of the five-year period." }, "society_established_on": { "type": "string", "format": "date", "description": "Date the society was established." }, "meeting_place": { "$ref": "#/components/schemas/Address", "description": "Where the society meets." }, "experience": { "type": "object", "description": "Sickness and mortality in the period; Entiva structure by_age_band[] {age_band, member_years, deaths, sickness_claims, sickness_days}." }, "principal_officer": { "type": "string", "pattern": "^per_", "description": "President or other principal officer who sends the return." }, "secretary_or_clerk": { "type": "string", "pattern": "^per_", "description": "Secretary or clerk who certifies the member list." } }, "required": [ "period_start", "period_end", "society_established_on", "meeting_place", "experience", "principal_officer", "secretary_or_clerk" ], "description": "Prepares the Second Schedule return of sickness and mortality experienced over five years, with the list of members, and sends it to the Registrar, who passes it to the Governor." }, "Create_ky_friendly_society_mortality_return_file": { "type": "object", "properties": { "type": { "const": "ky.friendly_society_mortality_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_friendly_society_mortality_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a friendly society's five-yearly sickness and mortality return", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "friendly_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "second_schedule_return", "title": "Return of rates of sickness and mortality", "source": "generated", "required": true }, { "key": "member_list", "title": "List of members", "source": "uploaded", "required": true }, { "key": "sickness_and_mortality_tables", "title": "Society's own tables", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registrar's receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "second_schedule_return", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "member_list", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Companies as Registrar of friendly societies", "form": "Return of the rate of sickness and mortality, Second Schedule form", "channel": "both", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "period_not_five_years", "type": null, "when": "The period does not span five years." }, { "code": "period_not_ended", "type": null, "when": "period_end is in the future." }, { "code": "return_already_filed", "type": null, "when": "A return for the period is already submitted." }, { "code": "society_not_enrolled", "type": null, "when": "The society is not on the Registrar's register." } ] } }, "Params_ky_friendly_society_sickness_mortality_return_file": { "type": "object", "properties": { "return_trigger": { "type": "string", "enum": [ "five_year_period", "june_return" ], "description": "Which s.40 trigger the return answers: the end of a five-year period, or the end of June.", "examples": [ "five_year_period" ] }, "period_start": { "type": "string", "format": "date", "description": "First day of the five-year period of experience covered.", "examples": [ "2021-10-01" ] }, "period_end": { "type": "string", "format": "date", "description": "Last day of the five-year period of experience covered.", "examples": [ "2026-09-30" ] }, "society_established_on": { "type": "string", "format": "date", "description": "Date the society was established.", "examples": [ "1987-04-02" ] }, "members_list_location": { "type": "string", "description": "Where the list of members is held.", "examples": [ "Society hall, West Bay Road, Grand Cayman" ] }, "members_at_period_end": { "type": "integer", "description": "Number of members on the list at period_end.", "examples": [ "236" ] }, "second_schedule_form_on_file": { "type": "boolean", "description": "Confirms the society holds the Second Schedule form, a copy of which is annexed to each society's rules.", "examples": [ "true" ] }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "President or other principal officer who signs and sends the return.", "examples": [ "per_2Jt4NbCr7Mv1" ] }, "secretary_or_clerk": { "type": "string", "pattern": "^per_", "description": "Secretary or clerk who prepares the data.", "examples": [ "per_5Qd8LgHw3Ba6" ] } }, "required": [ "return_trigger", "period_start", "period_end", "society_established_on", "members_list_location", "members_at_period_end", "second_schedule_form_on_file", "signing_officer", "secretary_or_clerk" ], "description": "Prepares and sends the Registrar the return of the rate of sickness and mortality a friendly society experienced over a five-year period, on the Second Schedule form annexed to its rules. The Registrar passes it to the Governor." }, "Create_ky_friendly_society_sickness_mortality_return_file": { "type": "object", "properties": { "type": { "const": "ky.friendly_society_sickness_mortality_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_friendly_society_sickness_mortality_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Friendly society: file the return of sickness and mortality rates", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "friendly_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "second_schedule_return", "title": "Return of rates of sickness and mortality", "source": "generated", "required": true }, { "key": "members_list", "title": "List of members for the period", "source": "uploaded", "required": true }, { "key": "sickness_mortality_experience_data", "title": "Sickness and mortality experience for the five years", "source": "uploaded", "required": true }, { "key": "rules_with_second_schedule", "title": "Society rules with the annexed Second Schedule form", "source": "uploaded", "required": false }, { "key": "registry_acknowledgement", "title": "Registrar's acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "second_schedule_return", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Friendly Societies", "form": "Return of Rates of Sickness and Mortality", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "period_not_five_years", "type": null, "when": "period_end is not five years after period_start." }, { "code": "second_schedule_form_missing", "type": null, "when": "second_schedule_form_on_file is false or the society's rules with the annexed form were not uploaded." }, { "code": "return_already_filed", "type": null, "when": "A return for this period has already been filed." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a friendly society." } ] } }, "Params_ky_friendly_society_statement_file": { "type": "object", "properties": { "statement_period_start": { "type": "string", "format": "date", "description": "Day after the date of the previous statement, or the date of formation for a first statement.", "examples": [ "2025-10-01" ] }, "statement_period_end": { "type": "string", "format": "date", "description": "Date to which the statement is made up.", "examples": [ "2026-09-30" ] }, "statement_made_on": { "type": "string", "format": "date", "description": "Date the statement is made.", "examples": [ "2026-10-12" ] }, "previous_statement_date": { "type": "string", "format": "date", "description": "Date of the previous statement.", "examples": [ "2025-10-10" ] }, "funds_and_effects": { "type": "array", "items": {}, "description": "Each fund or effect with the person in whose custody or possession it is held (s.36)." }, "total_receipts": { "$ref": "#/components/schemas/Money", "description": "All sums received since the previous statement." }, "total_expenditure": { "$ref": "#/components/schemas/Money", "description": "All sums expended since the previous statement." }, "member_auditors": { "type": "array", "items": {}, "description": "person_refs of two or more members appointed as auditors to attest the statement (s.36)." }, "secretary_or_clerk": { "type": "string", "pattern": "^per_", "description": "Secretary or clerk who countersigns the statement.", "examples": [ "per_5Qd8LgHw3Ba6" ] }, "sending_officer": { "type": "string", "pattern": "^per_", "description": "The president or other principal officer who sends the statement to the Registrar (s.36).", "examples": [ "per_2Jt4NbCr7Mv1" ] }, "acknowledge_late_filing": { "type": "boolean", "description": "Set true to proceed when statement_made_on is more than 14 days ago and the default is already running.", "examples": [ "false" ] } }, "required": [ "statement_period_start", "statement_period_end", "statement_made_on", "funds_and_effects", "total_receipts", "total_expenditure", "member_auditors", "secretary_or_clerk", "sending_officer" ], "description": "Prepares the general statement of a friendly society's funds and effects with its receipts and expenditure for the year, collects the attestation of two or more member-auditors and the countersignature of the secretary or clerk, and sends." }, "Create_ky_friendly_society_statement_file": { "type": "object", "properties": { "type": { "const": "ky.friendly_society_statement.file" }, "params": { "$ref": "#/components/schemas/Params_ky_friendly_society_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Friendly society: file the yearly statement of funds and effects", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "friendly_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_statement_of_funds_and_effects", "title": "General statement of funds and effects", "source": "generated", "required": true }, { "key": "receipts_and_expenditure_account", "title": "Account of sums received and expended since the previous statement", "source": "generated", "required": true }, { "key": "supporting_ledgers_and_bank_statements", "title": "Supporting ledgers and bank statements", "source": "uploaded", "required": true }, { "key": "transmittal_letter", "title": "Letter sending the statement to the Registrar", "source": "generated", "required": true }, { "key": "registry_acknowledgement", "title": "Registrar's acknowledgement or Gazette reference", "source": "registry_issued", "required": false } ], "people": [ { "role": "auditor", "verification_level": "identity" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_statement_of_funds_and_effects", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "general_statement_of_funds_and_effects", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "transmittal_letter", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Friendly Societies", "form": "General statement of funds and effects with account of receipts and expenditure", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insufficient_member_auditors", "type": null, "when": "Fewer than two member-auditors were named (s.36)." }, { "code": "statement_period_invalid", "type": null, "when": "statement_period_end is before statement_period_start, or the period exceeds 12 months since previous_statement_date (s.36)." }, { "code": "send_window_expired", "type": null, "when": "More than 14 days have passed since statement_made_on and acknowledge_late_filing is not true." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a friendly society." } ] } }, "Params_ky_fund_annual_return_file": { "type": "object", "properties": { "cima_registration_number": { "type": "string", "description": "The fund's CIMA registration number.", "examples": [ "0000112345" ] }, "fund_type": { "type": "string", "enum": [ "mutual_fund", "private_fund" ], "description": "Act the fund is registered under.", "examples": [ "mutual_fund" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "Year start.", "examples": [ "2025-07-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Year end; filing due six months later.", "examples": [ "2026-06-30" ] }, "filing_basis": { "type": "string", "enum": [ "audited_accounts", "cima_audit_exemption", "cima_filing_extension" ], "description": "audited_accounts, cima_audit_exemption or cima_filing_extension; then give relief_reference." }, "relief_reference": { "type": "string", "description": "CIMA reference for an audit exemption or filing extension, when filing_basis is not audited_accounts." }, "submitter": { "type": "string", "enum": [ "local_auditor", "designated_submitter" ], "description": "Mutual fund: the local auditor submits." }, "auditor": { "type": "object", "description": "{firm, cima_approval_reference, engagement_partner, email}; must be CIMA-approved." }, "far_data": { "type": "object", "description": "{operating_information, financial_information} per the REEFS FAR form for the year end; private funds include each AIV and sub-fund." }, "sub_funds": { "type": "array", "items": {}, "description": "[{name, type: segregated_portfolio | sub_trust | share_class | aiv, cima_reference}]; a FAR fee applies to each." }, "audited_financial_statements": { "type": "string", "pattern": "^doc_", "description": "Signed audited accounts; not needed if CIMA exempted the audit." } }, "required": [ "cima_registration_number", "fund_type", "financial_year_start", "financial_year_end", "submitter", "auditor", "far_data", "audited_financial_statements" ], "description": "Files a CIMA-registered mutual or private fund's audited accounts and FAR on REEFS within six months of year end. A CIMA-approved local auditor audits and, for mutual funds, submits; a private fund may use its auditor or another." }, "Create_ky_fund_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.fund_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_fund_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File audited accounts and the Fund Annual Return with CIMA", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "audited_financial_statements", "title": "Audited financial statements with auditor's report", "source": "uploaded", "required": true }, { "key": "far_form", "title": "FAR data as entered on REEFS", "source": "generated", "required": true }, { "key": "operator_confirmation", "title": "Operator's FAR confirmation and authority to submit", "source": "generated", "required": true }, { "key": "reefs_receipt", "title": "REEFS receipt and fee receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "audited_financial_statements", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "far_form", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "far_form", "signer_role": "auditor", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Fund Annual Return plus audited accounts", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "auditor_not_cima_approved", "type": null, "when": "[requirement_error] The auditor is not CIMA-approved." }, { "code": "audited_accounts_missing", "type": null, "when": "[requirement_error] No signed accounts and no CIMA exemption on record." }, { "code": "filing_deadline_passed", "type": null, "when": "[registry_error] Six months passed without an extension; offence (PFA s.13: CI$20,000 on conviction) and CIMA fines." }, { "code": "reefs_role_missing", "type": null, "when": "[registry_error] Partner lacks a Preparer or Submitter role on the fund's REEFS account." } ] } }, "Params_ky_llc_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "nature_of_business": { "type": "string", "description": "Nature of the LLC's business (s.57); pre-filled for the manager to confirm." }, "compliance_certified": { "type": "boolean", "description": "Certifies the LLC complied with the LLC Act during the calendar year (s.57)." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Manager or authorised person who confirms; defaults to a verified manager." } }, "required": [ "nature_of_business", "compliance_certified" ], "description": "Files the LLC Act s.57 annual return and pays the annual fee. Entiva on CAP after a manager confirms." }, "Create_ky_llc_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.llc_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the LLC annual return and pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "llc_annual_return", "title": "LLC annual return under s.57", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "llc_annual_return", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "llc_annual_return", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "LLC annual return, LLC Act s.57", "channel": "online", "government_fee": { "amount": 1200, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "compliance_cannot_be_certified", "type": "requirement_error", "when": "compliance_certified is false; not filed." }, { "code": "llc_defunct_notice_issued", "type": "registry_error", "when": "Six-month defunct notice under s.57 issued; pay everything outstanding before it expires." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_llp_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "nature_of_business": { "type": "string", "description": "Nature of the LLP's business (s.20)." }, "partners_as_at_1_january": { "type": "array", "items": {}, "description": "Everyone who was a partner on 1 January of the filing year: {person, name, address, managing_partner}." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Managing partner or other partner who signs, or for whom the return is signed; defaults to a verified managing partner." } }, "required": [ "nature_of_business", "partners_as_at_1_january" ], "description": "Files the LLP Act s.20 annual return of a fully registered LLP and pays the annual fee. Provisionally registered LLPs use ky.llp_provisional_declaration.file." }, "Create_ky_llp_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.llp_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_llp_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the LLP annual return and pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "llp_annual_return", "title": "LLP annual return under s.20", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "llp_annual_return", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "llp_annual_return", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual return, LLP Act s.20", "channel": "online", "government_fee": { "amount": 2100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "partner_register_mismatch", "type": "requirement_error", "when": "Partners supplied differ from the register of partners at 1 January." }, { "code": "llp_provisionally_registered", "type": "jurisdiction_error", "when": "Only provisionally registered; use ky.llp_provisional_declaration.file." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_llp_provisional_declaration_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Authorised signatory who makes the declaration or affidavit; defaults to a verified managing partner." }, "declaration_form": { "type": "string", "enum": [ "voluntary_declaration", "affidavit" ], "description": "Voluntary declaration or affidavit; both satisfy s.39." }, "requirements_confirmed": { "type": "object", "description": "Opinion, after due enquiry, that s.39,,, and still hold: no_winding_up_proceedings, no_receiver_or_administrator, no_creditor_arrangement, able_to_pay_debts." } }, "required": [ "declaration_form", "requirements_confirmed" ], "description": "Keeps a provisional LLP registration alive: each January an authorised signatory files a declaration or affidavit that the s.39 conditions hold, and the annual fee is paid. Missing both by 30 June ends the registration." }, "Create_ky_llp_provisional_declaration_file": { "type": "object", "properties": { "type": { "const": "ky.llp_provisional_declaration.file" }, "params": { "$ref": "#/components/schemas/Params_ky_llp_provisional_declaration_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual declaration and pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "provisional_annual_declaration", "title": "Declaration or affidavit under LLP Act s.39 and", "source": "generated", "required": true }, { "key": "executed_declaration", "title": "Signed and notarised declaration or sworn affidavit", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "notary", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "executed_declaration", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "executed_declaration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "General Registry", "form": "Declaration or affidavit in the form of LLP Act s.39", "channel": "both", "government_fee": { "amount": 1100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "requirement_not_met", "type": "requirement_error", "when": "A s.39 condition is answered false; not filed." }, { "code": "notarised_original_missing", "type": "requirement_error", "when": "The notarised declaration or sworn affidavit has not been uploaded." }, { "code": "provisional_registration_lapsed", "type": "jurisdiction_error", "when": "Neither filing made by 30 June; provisional registration ceased (s.39); apply anew." }, { "code": "llp_fully_registered", "type": "jurisdiction_error", "when": "The LLP is fully registered; use ky.llp_annual_return.file." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_lp_annual_fee_pay": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "authorising_general_partner": { "type": "string", "pattern": "^per_", "description": "General partner who authorises the payment; defaults to a verified general partner." } }, "description": "Pays the Partnership Act LP annual fee (s.50), due on or before 16 January. No annual return; missing the date is an offence by each partner." }, "Create_ky_lp_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.lp_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_lp_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "filing_authorisation", "title": "Standing authorisation to pay or file", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual fee, Partnership Act s.50", "channel": "online", "government_fee": { "amount": 475, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "payment_after_due_date", "type": null, "when": "Paid after 16 January; each partner is already exposed to the s.50 fine." }, { "code": "no_payment_channel", "type": "registry_error", "when": "Registry payment route unavailable; Entiva falls back to the manual route." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_mail_handling_change": { "type": "object", "properties": { "handling_mode": { "type": "string", "enum": [ "scan_and_email", "scan_and_hold", "forward_physical", "hold_for_collection" ], "description": "Default scan_and_email." }, "recipients": { "type": "array", "items": {}, "description": "[{person_id or email, role: director | manager | general_partner | authorised_contact, urgent_only}]; at least one officer." }, "urgent_categories": { "type": "array", "items": {}, "description": "Any of service_of_process, court_document, government_notice, tax_notice, regulator_notice, demand_letter; default all." }, "urgent_contact": { "type": "object", "description": "{phone, backup_phone} called when an urgent item arrives." }, "counsel_contact": { "type": "object", "description": "{name, firm, email, phone} alerted on service of process." }, "physical_forwarding_address": { "$ref": "#/components/schemas/Address", "description": "Required for forward_physical." }, "unsolicited_mail": { "type": "string", "enum": [ "log_and_discard", "forward" ], "description": "Legal, government, tax and regulator items are never discarded." } }, "required": [ "recipients" ], "description": "Sets standing instructions for mail, notices and service of process arriving at the entity's registered office: scan and email, hold or forward originals; who receives each kind of item; which items are urgent and who is called at once." }, "Create_ky_mail_handling_change": { "type": "object", "properties": { "type": { "const": "ky.mail_handling.change" }, "params": { "$ref": "#/components/schemas/Params_ky_mail_handling_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set how the registered office handles mail and legal notices", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "mail_instructions", "title": "Mail handling instructions", "source": "generated", "required": true }, { "key": "authority_letter", "title": "Authority to open and forward mail", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "recipient", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "mail_instructions", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. A service instruction to the licensed registered office provider", "form": "Mail handling instruction", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "recipient_unverified", "type": null, "when": "[requirement_error] A named recipient has not completed verification." }, { "code": "forwarding_address_missing", "type": null, "when": "[requirement_error] forward_physical needs an address." }, { "code": "not_the_entitys_registered_office", "type": null, "when": "[jurisdiction_error] Another provider is the entity's registered office." }, { "code": "screening_alert_open", "type": null, "when": "[requirement_error] A recipient has an open sanctions alert." } ] } }, "Params_ky_mail_item_forward": { "type": "object", "properties": { "mail_item_id": { "type": "string", "description": "Id of the scanned item." }, "item_type": { "type": "string", "enum": [ "general_correspondence", "government_notice", "tax_notice", "regulator_notice", "court_document", "service_of_process", "demand_letter", "unsolicited" ], "description": "Classification recorded on receipt.", "examples": [ "service_of_process" ] }, "received_on": { "type": "string", "format": "date", "description": "Date it reached the registered office.", "examples": [ "2026-10-15" ] }, "disposition": { "type": "string", "enum": [ "scan_and_email", "forward_courier", "hold_for_collection", "destroy_after_scan", "return_to_sender" ], "description": "Default from the standing rules." }, "recipients": { "type": "array", "items": {}, "description": "Override the standing recipients." }, "forwarding_address": { "$ref": "#/components/schemas/Address", "description": "For forward_courier, unless set in the rules." }, "acknowledged_by": { "type": "string", "pattern": "^per_", "description": "For urgent items: the officer who has seen the alert." }, "counsel_contact": { "type": "object", "description": "{name, firm, email} to alert about service of process." } }, "required": [ "mail_item_id", "item_type", "received_on" ], "description": "Deals with one item that reached the registered office: scan and email it, courier the original, hold it, or destroy it after scanning. Entiva opens this action itself on arrival and applies the entity's standing rules, flagging writs." }, "Create_ky_mail_item_forward": { "type": "object", "properties": { "type": { "const": "ky.mail_item.forward" }, "params": { "$ref": "#/components/schemas/Params_ky_mail_item_forward" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Forward or dispose of an item received at the registered office", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company", "foundation_company", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "mail_item_scan", "title": "Scan with receipt stamp", "source": "generated", "required": true }, { "key": "receipt_log_entry", "title": "Receipt log: date, time, method, deliverer", "source": "generated", "required": true }, { "key": "forwarding_record", "title": "Forwarding record and courier tracking", "source": "generated", "required": false } ], "people": [ { "role": "recipient", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "forwarding_record", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. A registered office service", "form": "Handling of an item received at the registered office", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "item_not_found", "type": null, "when": "[invalid_request_error] No such scanned item for this entity." }, { "code": "urgent_item_unacknowledged", "type": null, "when": "[requirement_error] An urgent item is unacknowledged; the action stays open and alerts repeat." }, { "code": "destruction_not_permitted", "type": null, "when": "[requirement_error] Legal, government, tax and regulator items cannot be destroyed." }, { "code": "address_not_covered", "type": null, "when": "[requirement_error] The courier does not serve the address." } ] } }, "Params_ky_npo_annual_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "description": "The legal form of the registered NPO.", "examples": [ "foundation_company" ] }, "npo_registration_number": { "type": "string", "description": "The NPO's number on the Registrar's register.", "examples": [ "NPO-1042" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "First day of the financial year reported on.", "examples": [ "2025-07-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year.", "examples": [ "2026-06-30" ] }, "filing_route": { "type": "string", "enum": [ "cbp_controller", "email_grcompliance", "cap_licensed_partner" ], "description": "cbp_controller: a controller uploads on the Cayman Business Portal. email_grcompliance: scanned form emailed to GRCompliance@gov.ky. cap_licensed_partner.", "examples": [ "cbp_controller" ] }, "signing_controller": { "type": "string", "pattern": "^per_", "description": "The controller who signs the declaration.", "examples": [ "per_2Xn5HdVa8Pq3" ] }, "person_completing_return": { "type": "string", "pattern": "^per_", "description": "Person named on the form as completing it.", "examples": [ "per_2Xn5HdVa8Pq3" ] }, "person_completing_position": { "type": "string", "description": "Position of that person, as the form asks.", "examples": [ "Director and treasurer" ] }, "gross_income": { "$ref": "#/components/schemas/Money", "description": "Gross annual income: goods and services, rent, investment income, donations and money, grants and other income (s.13).", "examples": [ "41250000 KYD" ] }, "total_expenses": { "$ref": "#/components/schemas/Money", "description": "Total expenses for the year." }, "balance_sheet": { "type": "object", "description": "Pro-forma balance sheet. assets: cash_in_hand, cash_at_bank, investments_short_term, other_current_assets, property, investments_long_term, other_fixed_assets.." }, "income_statement": { "type": "object", "description": "Pro-forma income statement. income: goods_and_services, rental, investment_interest, donations_and_money, grants, other. expenses: operating." }, "funds_sent_overseas": { "$ref": "#/components/schemas/Money", "description": "Total sent outside the Islands.", "examples": [ "17000000 KYD" ] }, "percentage_sent_overseas": { "type": "number", "description": "funds_sent_overseas divided by gross_income, times 100.", "examples": [ "41.2" ] }, "review_report_required": { "type": "boolean", "description": "True when gross income exceeds CI$250,000 and 30% or more is remitted outside the Islands (s.13), or the Registrar has required a review (s.13).", "examples": [ "true" ] }, "reviewing_accountant": { "type": "string", "pattern": "^per_", "description": "Independent qualified or licensed accountant engaged for the review.", "examples": [ "per_9Gf4LmBz1Xe6" ] }, "largest_contribution_sources": { "type": "array", "items": {}, "description": "The ten largest sources of contributions received." }, "largest_applications_of_contributions": { "type": "array", "items": {}, "description": "The ten largest applications of contributions." }, "largest_property_sales_and_purchases": { "type": "object", "description": "{sales: [{description, amount}], purchases: [{description, amount}]}, up to ten each." }, "top_countries_funds_sent": { "type": "array", "items": {}, "description": "Up to ten countries money was sent to." }, "unnotified_material_changes": { "type": "boolean", "description": "True if any change in purposes, constitution, controllers or registered particulars has not been notified to the Registrar.", "examples": [ "false" ] }, "major_occurrences_to_report": { "type": "boolean", "description": "True if a major occurrence that could harm the NPO's or the sector's reputation has happened and is not yet reported to the Registrar.", "examples": [ "false" ] }, "extension_reference": { "type": "string", "description": "Reference of the Registrar's approval of a two month extension under s.15, if any.", "examples": [ "NPO-EXT-2026-088" ] } }, "required": [ "entity_type", "npo_registration_number", "financial_year_start", "financial_year_end", "filing_route", "signing_controller", "person_completing_return", "person_completing_position", "gross_income", "total_expenses", "balance_sheet", "income_statement", "review_report_required", "largest_contribution_sources", "largest_applications_of_contributions", "largest_property_sales_and_purchases", "top_countries_funds_sent", "unnotified_material_changes", "major_occurrences_to_report" ], "description": "Prepares the NPO Annual Return Form for the Registrar of Non-Profit Organisations from the NPO's financial statements, collects the controller's declaration, and files it within six months of the financial year-end. If the NPO also needs a." }, "Create_ky_npo_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.npo_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Non-profit organisation: file the annual return", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_return_form", "title": "NPO Annual Return Form with controller declaration", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Financial statements for the year", "source": "uploaded", "required": true }, { "key": "supporting_documents", "title": "Supporting documents for large donations, grants and income changes", "source": "uploaded", "required": false }, { "key": "extension_approval", "title": "Registrar's extension approval", "source": "uploaded", "required": false }, { "key": "stamped_annual_return", "title": "General Registry stamped copy of the annual return", "source": "registry_issued", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_form", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_return_form", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Non-Profit Organisations", "form": "NPO Annual Return Form", "channel": "both", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "npo_not_registered", "type": null, "when": "No active NPO registration number for this entity." }, { "code": "unnotified_changes_pending", "type": null, "when": "unnotified_material_changes is true." }, { "code": "review_requirement_mismatch", "type": null, "when": "review_report_required does not match the s.13 test computed from gross_income and funds_sent_overseas." }, { "code": "reviewing_accountant_required", "type": null, "when": "review_report_required is true and reviewing_accountant is missing." }, { "code": "balance_sheet_does_not_balance", "type": null, "when": "Total assets differ from liabilities plus equity." }, { "code": "financial_year_not_ended", "type": null, "when": "financial_year_end is in the future." }, { "code": "return_already_filed", "type": null, "when": "A return for this financial year is already filed." }, { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not in applies_to." } ] } }, "Params_ky_npo_filing_extension_request": { "type": "object", "properties": { "extension_type": { "type": "string", "enum": [ "annual_return", "review_report" ], "description": "annual_return: two month extension of the six month period (s.15, CI$25). review_report: three month extension of the nine month period (s.13, CI$50).", "examples": [ "review_report" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Year-end of the financial year concerned.", "examples": [ "2025-12-31" ] }, "original_due_date": { "type": "string", "format": "date", "description": "Six or nine months after financial_year_end.", "examples": [ "2026-09-30" ] }, "requested_due_date": { "type": "string", "format": "date", "description": "Two or three months after original_due_date.", "examples": [ "2026-12-31" ] }, "reason": { "type": "string", "description": "Why more time is needed, in the controller's words.", "examples": [ "Reviewer's fieldwork on overseas grants was delayed by late bank confirmations." ] }, "requesting_controller": { "type": "string", "pattern": "^per_", "description": "The controller who makes the written request.", "examples": [ "per_2Xn5HdVa8Pq3" ] } }, "required": [ "extension_type", "financial_year_end", "original_due_date", "requested_due_date", "reason", "requesting_controller" ], "description": "Lodges a controller's written request for the Registrar of Non-Profit Organisations to extend the annual return deadline by two months (s.15) or the review report deadline by three months (s.13), and pays the extension fee. The Registrar." }, "Create_ky_npo_filing_extension_request": { "type": "object", "properties": { "type": { "const": "ky.npo_filing_extension.request" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_filing_extension_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Non-profit organisation: request more time for the annual return or review report", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_request_letter", "title": "Written extension request to the Registrar", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence for the reason given", "source": "uploaded", "required": false }, { "key": "fee_payment_receipt", "title": "Registry receipt for the extension fee", "source": "registry_issued", "required": true }, { "key": "registrar_decision", "title": "Registrar's approval or refusal", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "extension_request_letter", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Non-Profit Organisations", "form": "Written request. No prescribed form. The fee is paid on www.ciregistry.ky as 'NPO - Extens", "channel": "online", "government_fee": { "amount": 25, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "extension_exceeds_statutory_maximum", "type": null, "when": "requested_due_date is more than two months or three months after original_due_date." }, { "code": "original_due_date_mismatch", "type": null, "when": "original_due_date is not six or nine months after financial_year_end." }, { "code": "extension_already_requested", "type": null, "when": "An extension for this financial year and extension_type was already requested." }, { "code": "npo_not_registered", "type": null, "when": "No active NPO registration for this entity." } ] } }, "Params_ky_npo_financial_statements_review_report_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year reviewed.", "examples": [ "2025-12-31" ] }, "review_basis": { "type": "string", "enum": [ "income_and_overseas_threshold", "registrar_requirement" ], "description": "income_and_overseas_threshold: s.13. registrar_requirement: the Registrar required a review under s.13.", "examples": [ "income_and_overseas_threshold" ] }, "gross_annual_income": { "$ref": "#/components/schemas/Money", "description": "Gross annual income as defined in s.13.", "examples": [ "180000000 KYD" ] }, "income_remitted_outside_islands": { "$ref": "#/components/schemas/Money", "description": "Amount of that income remitted outside the Islands.", "examples": [ "75600000 KYD" ] }, "percentage_remitted": { "type": "number", "description": "Remitted amount divided by gross income, times 100.", "examples": [ "42" ] }, "registrar_review_request_reference": { "type": "string", "description": "Reference of the Registrar's s.13 requirement.", "examples": [ "NPO-REV-2026-012" ] }, "reviewer": { "type": "string", "pattern": "^per_", "description": "The independent accountant who performs the review.", "examples": [ "per_9Gf4LmBz1Xe6" ] }, "reviewer_status": { "type": "string", "enum": [ "duly_qualified_accountant_without_reward", "licensed_accountant" ], "description": "s.13: an independent duly qualified accountant who acts neither for profit nor reward, or an independent licensed accountant.", "examples": [ "licensed_accountant" ] }, "reviewer_independence_confirmed": { "type": "boolean", "description": "Reviewer confirms independence from the NPO and its controllers.", "examples": [ "true" ] }, "review_standard": { "type": "string", "description": "The internationally accepted review engagement standard applied, or a prescribed standard (s.13).", "examples": [ "ISRE 2400 (Revised)" ] }, "review_report_date": { "type": "string", "format": "date", "description": "Date of the reviewer's report.", "examples": [ "2026-09-18" ] }, "signing_controller": { "type": "string", "pattern": "^per_", "description": "The controller who ensures the report is submitted (s.13).", "examples": [ "per_2Xn5HdVa8Pq3" ] }, "extension_reference": { "type": "string", "description": "Reference of the Registrar's approval of a three month extension (s.13), if any.", "examples": [ "NPO-EXT-2026-071" ] } }, "required": [ "financial_year_end", "review_basis", "gross_annual_income", "income_remitted_outside_islands", "percentage_remitted", "reviewer", "reviewer_status", "reviewer_independence_confirmed", "review_standard", "review_report_date", "signing_controller" ], "description": "For an NPO with gross annual income above CI$250,000 that remits 30% or more outside the Islands, or one the Registrar has told to be reviewed, arranges the independent accountant's review of the financial statements and files the review." }, "Create_ky_npo_financial_statements_review_report_file": { "type": "object", "properties": { "type": { "const": "ky.npo_financial_statements_review_report.file" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_financial_statements_review_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Non-profit organisation: file the financial statements review report", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "reviewed_financial_statements", "title": "Financial statements that were reviewed", "source": "uploaded", "required": true }, { "key": "review_report", "title": "Reviewer's report on the financial statements", "source": "uploaded", "required": true }, { "key": "reviewer_qualification_evidence", "title": "Reviewer's licence or qualification evidence and independence statement", "source": "uploaded", "required": true }, { "key": "engagement_letter", "title": "Review engagement letter", "source": "uploaded", "required": false }, { "key": "submission_cover_letter", "title": "Cover letter to the Registrar", "source": "generated", "required": true }, { "key": "extension_approval", "title": "Registrar's extension approval", "source": "uploaded", "required": false }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "review_report", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "submission_cover_letter", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Non-Profit Organisations", "form": "Review report on the financial statements. No prescribed form", "channel": "both", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "review_not_required", "type": null, "when": "Income does not exceed CI$250,000, or less than 30% was remitted abroad, and no Registrar requirement is recorded." }, { "code": "reviewer_not_eligible", "type": null, "when": "The reviewer's licence or qualification, or the independence statement, is missing or does not match reviewer_status." }, { "code": "registrar_request_reference_required", "type": null, "when": "review_basis is registrar_requirement and no reference was given." }, { "code": "deadline_passed_without_extension", "type": null, "when": "Nine months have passed and no extension_reference exists." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered NPO of a supported form." } ] } }, "Params_ky_npo_review_report_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "description": "Entity type of the registered NPO." }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the year reviewed; the report is due nine months later (s.13)." }, "gross_annual_income": { "$ref": "#/components/schemas/Money", "description": "Gross annual income (s.13)." }, "percent_remitted_outside_islands": { "type": "number", "description": "Share sent outside the Islands, 0 to 100." }, "trigger": { "type": "string", "enum": [ "statutory_threshold", "registrar_request" ], "description": "Why a review is needed (s.13 or Registrar request s.13)." }, "reviewer": { "type": "string", "pattern": "^per_", "description": "The independent reviewer." }, "reviewer_status": { "type": "string", "enum": [ "qualified_accountant_no_reward", "licensed_accountant" ], "description": "Qualified accountant acting without reward, or licensed accountant (s.13)." }, "reviewer_credential_ref": { "type": "string", "description": "Reviewer's licence or membership number." }, "report_date": { "type": "string", "format": "date", "description": "Date of the review report." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Controller who authorises submission." }, "registrar_request_ref": { "type": "string", "description": "Reference of the Registrar's request; needed for registrar_request." }, "extension_reference": { "type": "string", "description": "Registrar's three-month extension approval (s.13)." } }, "required": [ "entity_type", "financial_year_end", "gross_annual_income", "percent_remitted_outside_islands", "trigger", "reviewer", "reviewer_status", "reviewer_credential_ref", "report_date", "declarant" ], "description": "Submits an independent accountant's review report to the NPO Registrar within nine months of the year end. Required when income exceeds CI$250,000 and 30% or more goes abroad, or when the Registrar asks." }, "Create_ky_npo_review_report_file": { "type": "object", "properties": { "type": { "const": "ky.npo_review_report.file" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_review_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File an NPO's independent review report on its financial statements", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "review_report", "title": "Review report", "source": "uploaded", "required": true }, { "key": "reviewed_financial_statements", "title": "Reviewed financial statements", "source": "uploaded", "required": true }, { "key": "reviewer_credentials", "title": "Reviewer's licence or qualification evidence", "source": "uploaded", "required": true }, { "key": "extension_approval", "title": "Registrar's extension approval", "source": "uploaded", "required": false }, { "key": "registrar_acknowledgement", "title": "Registrar's acknowledgement", "source": "registry_issued", "required": false }, { "key": "submission_authorisation", "title": "Submission authorisation", "source": "generated", "required": true } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "review_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "submission_authorisation", "signer_role": "declarant", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Non-Profit Organisations", "form": "Report on the review of financial statements", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "review_not_required", "type": null, "when": "Thresholds not met and trigger is statutory_threshold." }, { "code": "reviewer_not_independent", "type": null, "when": "The reviewer is a controller, officer or employee of the NPO." }, { "code": "reviewer_credentials_missing", "type": null, "when": "No licence or qualification evidence." }, { "code": "deadline_passed_no_extension", "type": null, "when": "Over nine months with no extension; filed but flagged late." } ] } }, "Params_ky_ordinary_company_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "entity_type": { "type": "string", "enum": [ "ordinary_resident_company", "ordinary_nonresident_company" ], "description": "Must match the entity record." }, "filing_channel": { "type": "string", "enum": [ "cap_via_licensed_partner", "cbp_principal_account" ], "description": "cap_via_licensed_partner (default; non-resident companies must use a CIMA-licensed registered office, s.50) or cbp_principal_account." }, "reference_general_meeting": { "type": "object", "description": "Ordinary general meeting that fixes the list date: {district, date}." }, "members": { "type": "array", "items": {}, "description": "Members on the list date: {name, address, shares_held, issue_date}." }, "share_capital_summary": { "type": "object", "description": "s.41 summary: authorised_capital, authorised_shares, par_value, shares_taken, calls_made_per_share, calls_received, calls_unpaid, shares_forfeited." }, "former_members": { "type": "array", "items": {}, "description": "Persons who ceased to be members since the last list: {name, address, shares_held}." }, "directors_and_officers": { "type": "array", "items": {}, "description": "With address, office and appointment date." }, "nature_of_business": { "type": "string", "description": "Nature of business (s.41); Registry drop-down value." }, "contact_email": { "type": "string", "description": "Company email shown on the Registry form." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director, secretary or other officer who certifies; defaults to a verified director." }, "declarant_position": { "type": "string", "description": "Position as printed on the form." } }, "required": [ "entity_type", "reference_general_meeting", "members", "share_capital_summary", "nature_of_business" ], "description": "Files the s.41 annual return and list of members of an ordinary company, certified by an officer, and pays the s.41 fee. Filed on CAP by the partner, or on the Cayman Business Portal by a principal of a resident company." }, "Create_ky_ordinary_company_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.ordinary_company_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_ordinary_company_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return and list of members and pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_return_and_list", "title": "Annual Return and List under s.41", "source": "generated", "required": true }, { "key": "register_of_members_extract", "title": "Register of members at the list date", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_and_list", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_return_and_list", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "annual_return_and_list", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual Return and List, s.41", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "beneficial_ownership_not_approved", "type": "requirement_error", "when": "CBP route: beneficial ownership must be filed and approved first." }, { "code": "member_list_mismatch", "type": "requirement_error", "when": "Members or share totals do not reconcile with the register or capital summary." }, { "code": "general_meeting_not_recorded", "type": "requirement_error", "when": "No general meeting recorded for the year, so the list date cannot be fixed." }, { "code": "exempted_company_wrong_action", "type": "jurisdiction_error", "when": "Exempted company with no s.174 licence is outside s.41; use ky.annual_return.file." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_principal_point_of_contact_appoint": { "type": "object", "properties": { "appointment_type": { "type": "string", "enum": [ "transition_existing_fi", "replace", "initial" ], "description": "transition_existing_fi, replace or initial.", "examples": [ "transition_existing_fi" ] }, "fi_number": { "type": "string", "description": "The TIA FI number." }, "principal_point_of_contact": { "type": "object", "description": "{type: individual | cayman_entity, person_id or entity_id, physical_address, email, phone}; an individual needs a Cayman physical address, an entity a physical." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-11-02" ] }, "outgoing_principal_point_of_contact": { "type": "object", "description": "{name, email, resigning}." } }, "required": [ "appointment_type", "fi_number", "principal_point_of_contact", "effective_date" ], "description": "Appoints or replaces the FI's Principal Point of Contact, who must now be located in the Cayman Islands. Existing FIs with an overseas or no PPoC must change by 31 January 2027." }, "Create_ky_principal_point_of_contact_appoint": { "type": "object", "properties": { "type": { "const": "ky.principal_point_of_contact.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_principal_point_of_contact_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint or replace the Cayman Principal Point of Contact", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution appointing the PPoC", "source": "generated", "required": true }, { "key": "ppoc_acceptance", "title": "PPoC's acceptance", "source": "uploaded", "required": true }, { "key": "change_form_record", "title": "DITC change form record", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "ppoc_acceptance", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "change_form_record", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Department for International Tax Cooperation", "form": "Principal Point of Contact Change Form", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ppoc_not_in_cayman", "type": null, "when": "[requirement_error] The proposed PPoC is not located in the Islands." }, { "code": "ppoc_acceptance_missing", "type": null, "when": "[requirement_error] The incoming PPoC has not accepted." }, { "code": "fi_not_registered", "type": null, "when": "[requirement_error] No FI number; register first." }, { "code": "portal_account_not_activated", "type": null, "when": "[registry_error] The incoming PPoC has not activated their account or set up 2FA." } ] } }, "Params_ky_ptc_annual_declaration_file": { "type": "object", "properties": { "ptc_registration_number": { "type": "string", "description": "The PTC's CIMA registration number.", "examples": [ "PTC-0231" ] }, "declaration_year": { "type": "integer", "description": "Year of the 31 January deadline.", "examples": [ "2027" ] }, "directors": { "type": "array", "items": {}, "description": "person_refs of all directors with names and addresses to be declared (reg 4)." }, "shareholders_or_members": { "type": "array", "items": {}, "description": "person_refs or entity_refs of shareholders or members, if any (reg 4)." }, "has_no_shareholders_or_members": { "type": "boolean", "description": "True if the PTC has none.", "examples": [ "false" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "{name, cima_trust_licence_number}: the holder of the Trust licence providing the registered office (reg 3, reg 4).", "examples": [ "{\"name\":\"Harbour Trust Ltd\",\"cima_trust_licence_number\":\"TL-1189\"}" ] }, "connected_trust_business_only": { "type": "boolean", "description": "Declares that the company is a PTC conducting no trust business other than connected trust business (reg 4).", "examples": [ "true" ] }, "regulations_compliance_confirmed": { "type": "boolean", "description": "Declares compliance with the PTC Regulations (reg 4), including no solicitation of contributions from the public or non-connected persons.", "examples": [ "true" ] }, "has_natural_person_director": { "type": "boolean", "description": "A natural person must be a director.", "examples": [ "true" ] }, "changes_since_last_declaration": { "type": "boolean", "description": "True if directors, shareholders or the registered office changed since the last declaration.", "examples": [ "false" ] }, "annual_fee": { "$ref": "#/components/schemas/Money", "description": "Defaults to CI$4,000.00 (reg 4).", "examples": [ "400000 KYD" ] }, "signing_director": { "type": "string", "pattern": "^per_", "description": "The director who signs the declaration and the registered-office filing authority.", "examples": [ "per_7Dk3TnYa2Bu6" ] } }, "required": [ "ptc_registration_number", "declaration_year", "directors", "has_no_shareholders_or_members", "registered_office", "connected_trust_business_only", "regulations_compliance_confirmed", "has_natural_person_director", "changes_since_last_declaration", "signing_director" ], "description": "Files a registered private trust company's annual declaration with CIMA, with proof of identification of its directors and shareholders, and pays the CI$4,000 annual registration fee, on or before 31 January each year (Private Trust." }, "Create_ky_ptc_annual_declaration_file": { "type": "object", "properties": { "type": { "const": "ky.ptc_annual_declaration.file" }, "params": { "$ref": "#/components/schemas/Params_ky_ptc_annual_declaration_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Private trust company: file the annual declaration and pay the registration fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "ordinary_nonresident_company", "ordinary_resident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_declaration", "title": "PTC annual declaration", "source": "generated", "required": true }, { "key": "directors_shareholders_id_proof", "title": "Proof of identification of directors and shareholders", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution approving the declaration and fee", "source": "generated", "required": true }, { "key": "registered_office_filing_authority", "title": "Written authority for the registered office to file for the PTC", "source": "generated", "required": true }, { "key": "fee_payment_receipt", "title": "CIMA fee receipt", "source": "registry_issued", "required": false }, { "key": "cima_acknowledgement", "title": "CIMA acknowledgement or REEFS confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting" } ], "signatures": [ { "document_key": "annual_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registered_office_filing_authority", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Annual declaration in the form CIMA approves, with proof of identification of directors an", "channel": "online", "government_fee": { "amount": 4000, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_natural_person_director", "type": null, "when": "has_natural_person_director is false." }, { "code": "registered_office_not_trust_licensee", "type": null, "when": "The registered office does not hold a CIMA Trust licence (reg 3)." }, { "code": "changes_not_notified", "type": null, "when": "changes_since_last_declaration is true and no change notice to CIMA is recorded (reg 4)." }, { "code": "identification_proof_incomplete", "type": null, "when": "A director or shareholder has no verified identification on file (reg 4)." }, { "code": "declaration_already_filed", "type": null, "when": "A declaration for declaration_year was already filed." }, { "code": "ptc_registration_not_active", "type": null, "when": "The PTC registration is cancelled or surrendered." } ] } }, "Params_ky_section_80_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "Year of the return." }, "contact_person": { "type": "object", "description": "Contact person: {name, email, phone}, as the Registry form asks." }, "place_of_business": { "$ref": "#/components/schemas/Address", "description": "Place of business, if different from the registered office." }, "controllers": { "type": "array", "items": {}, "description": "Persons who own, control or direct the company: {person, name, government_id_number, address, occupation, office_held}; the form asks for an ID number and copy." }, "objects_unchanged": { "type": "boolean", "description": "Confirms objects and activities are unchanged from the memorandum and articles, apart from what s.80B notified." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Director or secretary who certifies; defaults to a verified director." } }, "required": [ "contact_person", "controllers", "objects_unchanged" ], "description": "Files the s.80B annual return of a company designated under s.80: objects unchanged and who owns, controls or directs it. No fee." }, "Create_ky_section_80_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.section_80_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_section_80_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "section_80_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "section_80_annual_return", "title": "Annual Return Form pursuant to section 80", "source": "generated", "required": true }, { "key": "controller_id_copies", "title": "Copy of valid government ID for each person listed", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "section_80_annual_return", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "section_80_annual_return", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual Return Form pursuant to Section 80", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "earlier_returns_unfiled", "type": "requirement_error", "when": "An earlier year's return is unfiled; file the oldest first." }, { "code": "registered_as_npo", "type": "jurisdiction_error", "when": "Registered under the Non-Profit Organisations Act; files the NPO return instead." }, { "code": "objects_changed_unnotified", "type": "requirement_error", "when": "Objects or activities changed without a s.80B notice within 30 days; notify first." }, { "code": "controller_list_incomplete", "type": "requirement_error", "when": "" }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_sez_trade_certificate_annual_fee_pay": { "type": "object", "properties": { "trade_certificate_number": { "type": "string", "description": "Number of the SEZ trade certificate.", "examples": [ "SEZ-TC-2041" ] }, "fee_year": { "type": "integer", "description": "The year or licence year the annual fee covers.", "examples": [ "2027" ] }, "due_date": { "type": "string", "format": "date", "description": "Due date as stated on the SEZ Authority's notice or invoice.", "examples": [ "2026-12-31" ] }, "fee_notice_reference": { "type": "string", "description": "Reference on the notice or invoice.", "examples": [ "SEZA-INV-2026-3318" ] }, "payment_instructions": { "type": "string", "description": "Payee, account or portal instructions printed on the notice.", "examples": [ "Per SEZA notice SEZA-INV-2026-3318: bank transfer to the account on the invoice" ] }, "amount": { "$ref": "#/components/schemas/Money", "description": "Defaults to CI$750.00.", "examples": [ "75000 KYD" ] }, "authorising_officer": { "type": "string", "pattern": "^per_", "description": "Director or authorised officer who authorises the payment.", "examples": [ "per_4Vs2PlGe7Xa9" ] } }, "required": [ "trade_certificate_number", "fee_year", "due_date", "payment_instructions", "authorising_officer" ], "description": "Pays the CI$750 annual fee on an SEZC's special economic zone trade certificate (Special Economic Zones Act s.22, Schedule 2 item 2 of the SEZ Regulations as substituted by SL 5 of 2026). This is separate from the Registrar's annual fee." }, "Create_ky_sez_trade_certificate_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.sez_trade_certificate_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_sez_trade_certificate_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Special economic zone company: pay the trade certificate annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sez_fee_notice", "title": "SEZ Authority notice or invoice for the annual fee", "source": "uploaded", "required": true }, { "key": "trade_certificate_copy", "title": "SEZ trade certificate", "source": "uploaded", "required": true }, { "key": "payment_instruction", "title": "Payment instruction", "source": "generated", "required": true }, { "key": "payment_receipt", "title": "Authority receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "payment_instruction", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Special Economic Zones Authority", "form": "No form. Annual fee under Special Economic Zones Act", "channel": "none", "government_fee": { "amount": 750, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "fee_amount_mismatch", "type": null, "when": "The amount on sez_fee_notice differs from CI$750.00." }, { "code": "due_date_unconfirmed", "type": null, "when": "No fee notice was uploaded to support due_date." }, { "code": "trade_certificate_not_found", "type": null, "when": "trade_certificate_number does not match a certificate held by this SEZC." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an SEZC." } ] } }, "Params_ky_sez_trade_certificate_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year of the 31 January deadline." }, "trade_certificate_number": { "type": "string", "description": "Number of the SEZ trade certificate." }, "authorised_officer": { "type": "string", "pattern": "^per_", "description": "Director or officer who approves the payment." }, "trade_certificate_first_issued": { "type": "string", "format": "date", "description": "First issue date; the first fee falls due the next 31 January (s.22)." } }, "required": [ "fee_year", "trade_certificate_number", "authorised_officer" ], "description": "Pays the CI$750 annual fee on a special economic zone enterprise's trade certificate on or before 31 January each year (SEZ Act s.22; SL 5 of 2026). Separate from the Registrar's SEZC annual fee." }, "Create_ky_sez_trade_certificate_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.sez_trade_certificate_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_sez_trade_certificate_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee on a Special Economic Zone trade certificate", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trade_certificate", "title": "SEZ trade certificate", "source": "uploaded", "required": true }, { "key": "fee_payment_advice", "title": "Fee payment advice", "source": "generated", "required": true }, { "key": "payment_receipt", "title": "Payment receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fee_payment_advice", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Special Economic Zone Authority", "form": "Annual fee on the trade certificate, SEZ Act s.22", "channel": "both", "government_fee": { "amount": 750, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trade_certificate_not_valid", "type": null, "when": "Certificate is suspended, revoked or surrendered." }, { "code": "fee_not_yet_due", "type": null, "when": "The certificate was first issued in fee_year or later." }, { "code": "fee_already_paid", "type": null, "when": "The fee for this year is already paid." }, { "code": "late_payment_surcharge_due", "type": null, "when": "Deadline passed; the quote adds a surcharge of up to CI$62.50 a month." } ] } }, "Params_ky_sezc_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "entity_type": { "type": "string", "enum": [ "sezc" ], "description": "Must match the entity record." }, "nature_of_business": { "type": "string", "description": "Nature of business (s.168); Registry drop-down value, pre-filled." }, "memorandum_unaltered": { "type": "boolean", "description": "Declaration: memorandum unaltered since the last return, bar a s.31 name change or a change reported under s.10." }, "operations_mainly_outside_islands": { "type": "boolean", "description": "Declaration: operations mainly outside the Islands." }, "section_174_compliant": { "type": "boolean", "description": "Declaration: s.174 complied with." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director who confirms the facts; defaults to a verified director." }, "sez_trade_certificate_number": { "type": "string", "description": "SEZ trade certificate number; checked as current." } }, "required": [ "entity_type", "nature_of_business", "memorandum_unaltered", "operations_mainly_outside_islands", "section_174_compliant" ], "description": "Files the s.168 annual return and pays the flat SEZC fee (s.169) for an exempted company registered under Companies Act Part 8A." }, "Create_ky_sezc_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.sezc_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_sezc_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return and annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_return_declaration", "title": "Annual Return and Declaration, ss.168-169", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_declaration", "signer_role": "declarant", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "annual_return_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "General Registry", "form": "Annual Return and Declaration, s.168", "channel": "online", "government_fee": { "amount": 925, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "declaration_cannot_be_given", "type": "requirement_error", "when": "A declaration is answered false; not filed, routed to the partner and counsel." }, { "code": "sezc_registration_ceased", "type": "jurisdiction_error", "when": "No longer an SEZC; use ky.annual_return.file." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_siba_annual_declaration_file": { "type": "object", "properties": { "registered_person_number": { "type": "string", "description": "The CIMA registered person number.", "examples": [ "SIBR-3342" ] }, "declaration_year": { "type": "integer", "description": "Year of the 15 January deadline.", "examples": [ "2027" ] }, "schedule_4_category": { "type": "string", "enum": [ "paragraph_1", "paragraph_4", "paragraph_5" ], "description": "The Schedule 4 paragraph under which the person is registered.", "examples": [ "paragraph_1" ] }, "recognised_overseas_regulator": { "type": "string", "description": "For a person regulated overseas: the recognised overseas regulatory authority.", "examples": [ "UK Financial Conduct Authority" ] }, "business_exclusively_with_schedule_4_persons": { "type": "boolean", "description": "Confirms the person still conducts business exclusively with persons or institutions listed in Schedule 4.", "examples": [ "true" ] }, "business_unchanged_since_last_declaration": { "type": "boolean", "description": "False triggers a review of what changed before filing.", "examples": [ "true" ] }, "senior_officers": { "type": "array", "items": {}, "description": "person_refs of the senior officers." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "{name, cima_licence_number} of the registered office that files on REEFS.", "examples": [ "{\"name\":\"Island Corporate Services Ltd\",\"cima_licence_number\":\"CSP-2210\"}" ] }, "annual_fee": { "$ref": "#/components/schemas/Money", "description": "Defaults to CI$6,000.00 (reg 9).", "examples": [ "600000 KYD" ] }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "The senior officer who signs the declaration.", "examples": [ "per_6Ft1YkLc3Wn5" ] } }, "required": [ "registered_person_number", "declaration_year", "schedule_4_category", "business_exclusively_with_schedule_4_persons", "business_unchanged_since_last_declaration", "senior_officers", "registered_office", "signing_officer" ], "description": "Files a SIBA registered person's annual declaration with CIMA through its registered office on REEFS and pays the CI$6,000 annual fee, by 15 January each year (Securities Investment Business Act s.5; Registration and Deregistration." }, "Create_ky_siba_annual_declaration_file": { "type": "object", "properties": { "type": { "const": "ky.siba_annual_declaration.file" }, "params": { "$ref": "#/components/schemas/Params_ky_siba_annual_declaration_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "SIBA registered person: file the annual declaration and pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "llc", "elp", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_declaration_form", "title": "Annual Declaration Form for Registered Persons", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution of the governing body approving the declaration and fee", "source": "generated", "required": true }, { "key": "registered_office_filing_authority", "title": "Written authority for the registered office to file", "source": "generated", "required": true }, { "key": "fee_payment_receipt", "title": "CIMA fee receipt", "source": "registry_issued", "required": false }, { "key": "reefs_acknowledgement", "title": "REEFS submission confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_declaration_form", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registered_office_filing_authority", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_declaration_form", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Annual Declaration Form for Registered Persons, filed on REEFS, with the annual fee", "channel": "online", "government_fee": { "amount": 6000, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registered_person_not_found", "type": null, "when": "registered_person_number does not match a current CIMA registration." }, { "code": "declaration_already_filed", "type": null, "when": "A declaration for declaration_year was already filed." }, { "code": "schedule_4_status_unconfirmed", "type": null, "when": "business_exclusively_with_schedule_4_persons is false." }, { "code": "registration_under_termination", "type": null, "when": "A deregistration is in progress." }, { "code": "fee_amount_mismatch", "type": null, "when": "annual_fee is not CI$6,000.00." }, { "code": "entity_type_not_supported", "type": null, "when": "entity type is not in applies_to." } ] } }, "Params_ky_siba_registration_deregister": { "type": "object", "properties": { "registered_person_number": { "type": "string", "description": "The CIMA registered person number.", "examples": [ "SIBR-3342" ] }, "deregistration_reason": { "type": "string", "enum": [ "cessation_of_business", "voluntary_liquidation", "court_liquidation", "merger", "transfer_to_another_jurisdiction", "never_carried_on_business" ], "description": "Selects the reason-specific documents.", "examples": [ "cessation_of_business" ] }, "ceased_business_on": { "type": "string", "format": "date", "description": "Date the person ceased the Schedule 2 regulated activities, as stated in the senior officers' resolution (reg 3).", "examples": [ "2026-09-30" ] }, "reason": { "type": "string", "description": "Reason for ceasing business, as attested in the affidavit (reg 3).", "examples": [ "The group consolidated its advisory activity into another affiliate." ] }, "clients_properly_terminated_or_transferred": { "type": "boolean", "description": "All money due to clients is paid and no residual assets are owed, or relationships are fully transferred to another provider (reg 3).", "examples": [ "true" ] }, "post_deregistration_intention": { "type": "string", "enum": [ "continue_as_legal_entity", "apply_to_strike_off", "merge_with_another_registered_person" ], "description": "What the entity will do next (reg 3).", "examples": [ "apply_to_strike_off" ] }, "fees_paid_up_to_date": { "type": "boolean", "description": "All relevant fees are paid (reg 3).", "examples": [ "true" ] }, "annual_declarations_up_to_date": { "type": "boolean", "description": "All required annual declarations have been submitted (reg 3).", "examples": [ "true" ] }, "no_outstanding_cima_queries": { "type": "boolean", "description": "No outstanding queries from, or regulatory filings with, CIMA (reg 3).", "examples": [ "true" ] }, "senior_officers": { "type": "array", "items": {}, "description": "person_refs of the senior officers who pass the resolution." }, "deponent": { "type": "string", "pattern": "^per_", "description": "The senior officer who swears the affidavit.", "examples": [ "per_6Ft1YkLc3Wn5" ] }, "linked_action_id": { "type": "string", "description": "The liquidation, merger or transfer action that this deregistration follows.", "examples": [ "act_7Hn2QsDe5Lw9" ] }, "destination_jurisdiction": { "type": "string", "description": "ISO 3166 code or name of the destination.", "examples": [ "BM" ] }, "surviving_registered_person": { "type": "string", "description": "Name and CIMA number of the surviving registered person." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "{name, cima_licence_number} of the registered office that files on REEFS.", "examples": [ "{\"name\":\"Island Corporate Services Ltd\",\"cima_licence_number\":\"CSP-2210\"}" ] } }, "required": [ "registered_person_number", "deregistration_reason", "clients_properly_terminated_or_transferred", "fees_paid_up_to_date", "annual_declarations_up_to_date", "no_outstanding_cima_queries", "senior_officers", "registered_office" ], "description": "Applies to CIMA to deregister a SIBA registered person that has ceased securities investment business, using the procedure for its reason: plain cessation, voluntary or court liquidation, merger, transfer to another jurisdiction, or never." }, "Create_ky_siba_registration_deregister": { "type": "object", "properties": { "type": { "const": "ky.siba_registration.deregister" }, "params": { "$ref": "#/components/schemas/Params_ky_siba_registration_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "SIBA registered person: apply to deregister", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_company", "exempted_ldc", "llc", "elp", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_intention_to_deregister", "title": "Written notice of intention to deregister (SIBA s.5)", "source": "generated", "required": true }, { "key": "senior_officers_resolution_certified", "title": "Certified copy of the senior officers' resolution stating the date business ceased", "source": "generated", "required": true }, { "key": "senior_officer_affidavit", "title": "Senior officer's affidavit", "source": "uploaded", "required": false }, { "key": "notice_of_voluntary_winding_up", "title": "Notice of voluntary winding up", "source": "generated", "required": false }, { "key": "liquidator_consent_to_act", "title": "Voluntary liquidator's consent to act", "source": "uploaded", "required": false }, { "key": "declaration_of_solvency", "title": "Declaration of solvency", "source": "uploaded", "required": false }, { "key": "court_order_certified_copy", "title": "Certified copy of the Grand Court supervision or winding up order", "source": "uploaded", "required": false }, { "key": "merger_approval_application", "title": "Application for CIMA's prior approval of the merger, with resolutions and plan of merger", "source": "uploaded", "required": false }, { "key": "certificate_of_merger_certified_copy", "title": "Certified copy of the certificate of merger", "source": "uploaded", "required": false }, { "key": "cima_termination_status_notice", "title": "CIMA 'registration under termination' notice", "source": "registry_issued", "required": false }, { "key": "cima_deregistration_confirmation", "title": "CIMA deregistration confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_of_intention_to_deregister", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "senior_officers_resolution_certified", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "senior_officers_resolution_certified", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "senior_officer_affidavit", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "declaration_of_solvency", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_voluntary_winding_up", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_intention_to_deregister", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Written notice under SIBA s.5", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "outstanding_annual_declaration", "type": null, "when": "annual_declarations_up_to_date is false or a declaration is missing (reg 3)." }, { "code": "outstanding_fees", "type": null, "when": "fees_paid_up_to_date is false (reg 3)." }, { "code": "clients_not_terminated", "type": null, "when": "clients_properly_terminated_or_transferred is false (reg 3, 3)." }, { "code": "reason_documents_incomplete", "type": null, "when": "A document required for the chosen deregistration_reason is missing." }, { "code": "affidavit_not_sworn", "type": null, "when": "The affidavit upload lacks a notary or Justice of the Peace jurat." }, { "code": "registration_already_terminating", "type": null, "when": "CIMA already shows 'registration under termination' for this person." }, { "code": "registered_person_not_found", "type": null, "when": "registered_person_number does not match a current CIMA registration." } ] } }, "Params_ky_spc_annual_return_file": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "January of the filing; default is the next unfiled one." }, "entity_type": { "type": "string", "enum": [ "exempted_spc" ], "description": "Must match the entity record." }, "nature_of_business": { "type": "string", "description": "Nature of business (s.168); Registry drop-down value, pre-filled." }, "memorandum_unaltered": { "type": "boolean", "description": "Declaration: memorandum unaltered since the last return, bar a s.31 name change or a change reported under s.10." }, "operations_mainly_outside_islands": { "type": "boolean", "description": "Declaration: operations mainly outside the Islands." }, "section_174_compliant": { "type": "boolean", "description": "Declaration: s.174 complied with." }, "portfolio_notice": { "type": "object", "description": "s.213 notice: opening_portfolios, created_during_year, terminated_during_year." }, "registered_capital": { "$ref": "#/components/schemas/Money", "description": "Authorised capital, which sets the fee band." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Director who confirms the facts; defaults to a verified director." } }, "required": [ "entity_type", "nature_of_business", "memorandum_unaltered", "operations_mainly_outside_islands", "section_174_compliant", "portfolio_notice" ], "description": "Files the SPC's s.168 return with the s.213 notice of segregated portfolios, and pays the annual, additional SPC and per-portfolio fees. One form, one action." }, "Create_ky_spc_annual_return_file": { "type": "object", "properties": { "type": { "const": "ky.spc_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_spc_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return, annual fee and notice of segregated portfolios", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_return_declaration", "title": "Annual Return and Declaration, exempted SPC", "source": "generated", "required": true }, { "key": "segregated_portfolio_notice", "title": "Notice under s.213", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_declaration", "signer_role": "declarant", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "annual_return_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "General Registry", "form": "Annual Return and Declaration, exempted SPC", "channel": "online", "government_fee": { "amount": 3025, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No ESN on file; the Registry takes no return before it." }, { "code": "portfolio_list_mismatch", "type": "requirement_error", "when": "Portfolio lists do not reconcile with the register or the last notice." }, { "code": "declaration_cannot_be_given", "type": "requirement_error", "when": "A declaration is answered false; not filed, routed to the partner and counsel." }, { "code": "registry_rejected_filing", "type": "registry_error", "when": "Registry rejected the filing; see the reason returned." } ] } }, "Params_ky_trust_annual_fee_pay": { "type": "object", "properties": { "trust_registration_number": { "type": "string", "description": "Reference on the exempted trust certificate." }, "fee_year": { "type": "integer", "description": "Year of the March payment.", "examples": [ "2027" ] }, "paying_trustee": { "type": "string", "pattern": "^per_", "description": "The trustee or corporate trustee authorising payment." }, "pay_by": { "type": "string", "format": "date", "description": "Target date; default 15 March." } }, "required": [ "trust_registration_number", "fee_year", "paying_trustee" ], "description": "Pays the CI$500 annual fee that the trustees of every exempted trust owe the Registrar of Trusts each March, and records the receipt. Due whether or not the trust holds assets." }, "Create_ky_trust_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "ky.trust_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_ky_trust_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the exempted trust annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "ongoing_compliance", "applies_to": [ "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustee_payment_authorisation", "title": "Trustee payment authorisation", "source": "generated", "required": true }, { "key": "trust_certificate", "title": "Exempted trust certificate", "source": "uploaded", "required": false }, { "key": "fee_payment_receipt", "title": "Registrar of Trusts receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "none" }, { "role": "trustee", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustee_payment_authorisation", "signer_role": "trustee", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Trusts", "form": "Annual fee payment", "channel": "paper", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trust_not_registered", "type": null, "when": "[requirement_error] No exempted trust registration number on record." }, { "code": "fee_already_paid", "type": null, "when": "[invalid_request_error] A payment is recorded for this fee year." }, { "code": "trustee_unverified", "type": null, "when": "[requirement_error] A trustee has not completed verification." }, { "code": "payment_channel_unconfirmed", "type": null, "when": "" } ] } }, "Params_ky_annual_general_meeting_hold": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "ordinary_resident_company", "ordinary_nonresident_company" ], "description": "Entity type; one of applies_to." }, "meeting_date": { "type": "string", "format": "date", "description": "With Table A, within 15 months of the last meeting.", "examples": [ "2026-12-10" ] }, "meeting_time": { "type": "string", "description": "HH:MM, Cayman local time.", "examples": [ "10:00" ] }, "format": { "type": "string", "enum": [ "in_person", "virtual", "hybrid" ], "description": "Virtual and hybrid need articles that allow it." }, "venue": { "$ref": "#/components/schemas/Address", "description": "Required unless virtual." }, "notice_date": { "type": "string", "format": "date", "description": "Date notice is served; Table A reg 41: at least seven days unless the articles differ.", "examples": [ "2026-11-19" ] }, "short_notice_consent": { "type": "boolean", "description": "All members entitled to notice agreed to shorter notice." }, "previous_general_meeting_date": { "type": "string", "format": "date", "description": "Tests the 15-month interval." }, "accounts_made_up_to": { "type": "string", "format": "date", "description": "Accounts to be laid; at most six months before the meeting." }, "chair": { "type": "string", "pattern": "^per_", "description": "Presides and signs the minutes." }, "agenda": { "type": "array", "items": {}, "description": "Items as {title, resolution_type, proposed_text}." }, "proxies": { "type": "array", "items": {}, "description": "Proxies as {member, proxy_holder, document}; lodged 48 hours before." }, "auto_file_special_resolutions": { "type": "boolean", "description": "Default true: queue ky.special_resolution.file per special resolution." } }, "required": [ "entity_type", "meeting_date", "meeting_time", "format", "notice_date", "chair", "agenda" ], "description": "Convene, hold and minute the annual general meeting that every company other than an exempted company must hold at least once a year. Entiva drafts the notice, agenda and proxy forms, tracks notice and proxies, records attendance and." }, "Create_ky_annual_general_meeting_hold": { "type": "object", "properties": { "type": { "const": "ky.annual_general_meeting.hold" }, "params": { "$ref": "#/components/schemas/Params_ky_annual_general_meeting_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Hold and minute an annual general meeting", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "constitution", "title": "Memorandum and articles, or LLC agreement", "source": "uploaded", "required": false }, { "key": "financial_statements", "title": "Accounts to be laid", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution convening the meeting", "source": "generated", "required": true }, { "key": "notice_of_meeting", "title": "Notice of annual general meeting", "source": "generated", "required": true }, { "key": "proxy_form", "title": "Form of proxy", "source": "generated", "required": false }, { "key": "minutes", "title": "Minutes and attendance record", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "proxy", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "proxy_form", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing for the AGM", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "An exempted company type; s.58 excludes them, use ky.general_meeting.hold." }, { "code": "notice_period_too_short", "type": null, "when": "Notice is shorter than the articles require and short_notice_consent is not true." }, { "code": "articles_not_on_file", "type": null, "when": "No current articles or LLC agreement on file or uploaded." }, { "code": "format_not_permitted", "type": null, "when": "Virtual, video, telephone or hybrid chosen but the articles do not allow it." } ] } }, "Params_ky_apostille_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp", "section_80_company", "exempted_trust" ], "description": "Entity type; one of applies_to." }, "documents": { "type": "array", "items": {}, "description": "As {document, kind, document_date, signed_by}." }, "destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code; Entiva checks it is a 1961 Hague Apostille Convention party." }, "notarisation": { "type": "string", "enum": [ "not_needed", "arrange_cayman_notary", "already_notarised" ], "description": "not_needed for a document a public officer signed; arrange_cayman_notary for a private one; already_notarised if done." }, "express": { "type": "boolean", "description": "Default false." }, "delivery": { "type": "string", "enum": [ "courier_to_address", "partner_holds_for_collection" ], "description": "Where the documents go." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for courier_to_address." } }, "required": [ "entity_type", "documents", "destination_country", "notarisation", "delivery" ], "description": "Have the Passport and Corporate Services Office affix a Hague Convention apostille to a Cayman public document. Registry certificates signed by General Registry officers can be apostilled directly; private documents such as officer's." }, "Create_ky_apostille_request": { "type": "object", "properties": { "type": { "const": "ky.apostille.request" }, "params": { "$ref": "#/components/schemas/Params_ky_apostille_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain a Hague apostille for Cayman documents", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp", "section_80_company", "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "source_document", "title": "Document to legalise", "source": "uploaded", "required": true }, { "key": "instruction_letter", "title": "Typed instruction letter on letterhead", "source": "generated", "required": true }, { "key": "apostilled_document", "title": "Apostilled document", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "notary", "verification_level": "none" }, { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "source_document", "signer_role": "officer", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "source_document", "signer_role": "registered_agent", "method": "wet_ink_notarised_apostilled", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "source_document", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "instruction_letter", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Passport and Corporate Services Office, Cayman Islands Government", "form": "Hague apostille", "channel": "paper", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "destination_not_hague_party", "type": null, "when": "destination_country is not a Hague party; use ky.document_authentication.request." }, { "code": "document_too_old", "type": null, "when": "A document is dated more than 12 months before submission." }, { "code": "notarisation_required", "type": null, "when": "A private document is not notarised by a Cayman notary." }, { "code": "signature_specimen_not_on_file", "type": null, "when": "The signer's or notary's signature matches no specimen held by the office." } ] } }, "Params_ky_board_meeting_record": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type; one of applies_to." }, "meeting_date": { "type": "string", "format": "date", "description": "Date held.", "examples": [ "2026-10-15" ] }, "meeting_time": { "type": "string", "description": "HH:MM, Cayman local time.", "examples": [ "11:00" ] }, "format": { "type": "string", "enum": [ "in_person", "video", "telephone", "hybrid" ], "description": "Video or telephone attendance is valid only as the articles allow." }, "chair": { "type": "string", "pattern": "^per_", "description": "Director who chaired." }, "attendees": { "type": "array", "items": {}, "description": "Those present as {person, attendance, alternate_for}." }, "notice_given_on": { "type": "string", "format": "date", "description": "Date notice was given; omit if waived." }, "notice_waived": { "type": "boolean", "description": "All directors waived notice." }, "quorum_required": { "type": "integer", "description": "Default per articles." }, "agenda": { "type": "array", "items": {}, "description": "Items as {title, summary}." }, "resolutions": { "type": "array", "items": {}, "description": "Decisions as {title, text, votes_for, votes_against, abstentions, interested_directors}; the chair has a casting vote." }, "minutes_document": { "type": "string", "pattern": "^doc_", "description": "Your own draft minutes, used instead of generating them." } }, "required": [ "entity_type", "meeting_date", "meeting_time", "format", "chair", "attendees", "agenda", "resolutions" ], "description": "Prepare the notice, agenda and minutes of a meeting of the directors and record attendance, quorum, interests and the votes on each resolution. The chair signs the minutes, which are evidence of the proceedings (s.73), and each director." }, "Create_ky_board_meeting_record": { "type": "object", "properties": { "type": { "const": "ky.board_meeting.record" }, "params": { "$ref": "#/components/schemas/Params_ky_board_meeting_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record and minute a directors' meeting", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_meeting", "title": "Notice and agenda", "source": "generated", "required": false }, { "key": "minutes", "title": "Minutes and attendance record", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "alternate_director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "quorum_not_met", "type": null, "when": "Fewer directors attended than quorum_required, so resolutions cannot be recorded as carried." }, { "code": "notice_not_evidenced", "type": null, "when": "No notice date or waiver and the articles require notice." }, { "code": "attendee_not_a_director", "type": null, "when": "A person recorded as voting is not a current director or full alternate." } ] } }, "Params_ky_board_resolution_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type; one of applies_to." }, "category": { "type": "string", "enum": [ "general_business", "banking_and_signatories", "approve_agreement", "approve_accounts", "delegate_authority", "appoint_agent_or_attorney", "convene_general_meeting", "other" ], "description": "Decisions with a dedicated action are rejected." }, "title": { "type": "string", "description": "Short title.", "examples": [ "Open a bank account and appoint signatories" ] }, "resolution_text": { "type": "string", "description": "Text; give this or resolution_document, else Entiva drafts from the title." }, "resolution_document": { "type": "string", "pattern": "^doc_", "description": "A resolution you drafted." }, "effective_date": { "type": "string", "format": "date", "description": "Takes effect on this date or the last signature, if later.", "examples": [ "2026-10-20" ] }, "signatories": { "type": "array", "items": {}, "description": "person_ref values of directors to sign; default all current." }, "required_signatures": { "type": "string", "enum": [ "all", "majority", "as_per_articles" ], "description": "Default all; fewer only if the articles allow." }, "articles_allow_written_resolution": { "type": "boolean", "description": "Confirm the articles allow a written resolution; Table A does not." }, "declared_interests": { "type": "array", "items": {}, "description": "Directors with a declared interest as {person, nature}." } }, "required": [ "entity_type", "category", "title", "effective_date", "articles_allow_written_resolution" ], "description": "Draft and collect a written resolution of the directors for a decision with no dedicated action, such as opening a bank account, authorising signatories or approving an agreement. Each director signs personally by e-signature and Entiva." }, "Create_ky_board_resolution_pass": { "type": "object", "properties": { "type": { "const": "ky.board_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_ky_board_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass a written resolution of the directors or managers", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Written resolution of the directors", "source": "generated", "required": true }, { "key": "constitution", "title": "Memorandum and articles, or LLC agreement", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "alternate_director", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "dedicated_action_required", "type": null, "when": "The decision has its own action; the error names it." }, { "code": "written_resolution_not_permitted", "type": null, "when": "articles_allow_written_resolution is false; use ky.board_meeting.record." }, { "code": "signatory_not_a_director", "type": null, "when": "A signatory is not a current director, full alternate or manager." } ] } }, "Params_ky_branch_register_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "description": "Entity type; one of applies_to." }, "branch_register_id": { "type": "string", "description": "Identifier from ky.branch_register.open, or the country code for a register that predates Entiva." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; the 21 days run from here.", "examples": [ "2026-12-03" ] }, "change_type": { "type": "string", "enum": [ "new_member", "transfer", "member_details_changed", "shares_moved_to_principal_register", "other" ], "description": "Kind of change." }, "changes": { "type": "array", "items": {}, "description": "Entries as {member or from_member and to_member, class, shares, details_changed}." } }, "required": [ "entity_type", "branch_register_id", "effective_date", "change_type", "changes" ], "description": "Record changes made to a branch register of members and update the duplicate held with the principal register. The duplicate must be current within 21 days of any change (s.40A,); Entiva tracks the deadline." }, "Create_ky_branch_register_change": { "type": "object", "properties": { "type": { "const": "ky.branch_register.change" }, "params": { "$ref": "#/components/schemas/Params_ky_branch_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a change to a branch register and refresh the duplicate", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "branch_register_extract", "title": "Updated branch register or transaction report", "source": "uploaded", "required": true }, { "key": "branch_register_duplicate", "title": "Updated duplicate for the principal register", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "branch_register_duplicate", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "branch_register_not_found", "type": null, "when": "branch_register_id matches no branch register for this entity." }, { "code": "duplicate_deadline_passed", "type": null, "when": "Over 21 days since change_date; recorded with a warning that the s.40A penalty may apply." } ] } }, "Params_ky_branch_register_continue_out": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "description": "Entity type; one of applies_to." }, "branch_register_id": { "type": "string", "description": "Identifier from ky.branch_register.open." }, "effective_date": { "type": "string", "format": "date", "description": "Date the branch register stops and entries move.", "examples": [ "2027-03-31" ] }, "transfer_destination": { "type": "string", "enum": [ "principal_register", "other_branch_register" ], "description": "Where the entries go (s.40A)." }, "destination_branch_register_id": { "type": "string", "description": "Required for other_branch_register." } }, "required": [ "entity_type", "branch_register_id", "effective_date", "transfer_destination" ], "description": "Stop keeping a branch register of members. All its entries must move to another branch register or to the principal register (Companies Act s.40A)." }, "Create_ky_branch_register_continue_out": { "type": "object", "properties": { "type": { "const": "ky.branch_register.continue_out" }, "params": { "$ref": "#/components/schemas/Params_ky_branch_register_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Discontinue a branch register of members", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution discontinuing the branch register", "source": "generated", "required": true }, { "key": "register_of_members_extract", "title": "Register of members after the transfer", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "branch_register_not_found", "type": null, "when": "branch_register_id matches no branch register for this entity." }, { "code": "destination_required", "type": null, "when": "other_branch_register chosen without destination_branch_register_id." } ] } }, "Params_ky_branch_register_open": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "description": "Entity type; one of applies_to." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code where it is kept (s.40A).", "examples": [ "SG" ] }, "member_categories": { "type": "string", "description": "Category or categories of members on it (s.40A).", "examples": [ "Holders of Class A ordinary shares resident in Singapore" ] }, "branch_registrar": { "type": "object", "description": "Who keeps it as {name, role, address, contact_email}." }, "effective_date": { "type": "string", "format": "date", "description": "Date established; the 21-day duplicate deadline runs from here.", "examples": [ "2026-11-02" ] }, "members_to_transfer": { "type": "array", "items": {}, "description": "Holdings moved from the principal register as {member, class, shares}; a share sits on one register only (s.40A)." }, "is_listed_share_register": { "type": "boolean", "description": "True for a register of exchange-listed shares (s.40B); that is not a branch register (s.40A)." } }, "required": [ "entity_type", "country", "member_categories", "branch_registrar", "effective_date" ], "description": "Establish a branch register of members in another country or territory for an exempted company. The branch register is part of the register of members." }, "Create_ky_branch_register_open": { "type": "object", "properties": { "type": { "const": "ky.branch_register.open" }, "params": { "$ref": "#/components/schemas/Params_ky_branch_register_open" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Open a branch register of members abroad", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution establishing the branch register", "source": "generated", "required": true }, { "key": "branch_registrar_agreement", "title": "Agreement with the branch registrar", "source": "uploaded", "required": false }, { "key": "branch_register_duplicate", "title": "Duplicate for the principal register", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "branch_register_duplicate", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "listed_register_not_branch_register", "type": null, "when": "is_listed_share_register is true (s.40A)." }, { "code": "shares_already_on_branch_register", "type": null, "when": "A share is already on another branch register (s.40A)." }, { "code": "licensed_company_register_location", "type": null, "when": "The company is licensed to do business in the Islands; its register of members stays at the registered office (s.44)." } ] } }, "Params_ky_certified_copy_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp" ], "description": "Entity type; one of applies_to." }, "documents": { "type": "array", "items": {}, "description": "As {document_type, filed_on, description}." }, "certified": { "type": "boolean", "description": "Default true; false requests an uncertified copy, which is cheaper." }, "copies": { "type": "integer", "description": "Sets, default 1; each document carries its own fee." }, "express": { "type": "boolean", "description": "Default false." }, "needs_apostille": { "type": "boolean", "description": "Queue a ky.apostille.request for the issued document." }, "apostille_destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code; required with needs_apostille." } }, "required": [ "entity_type", "documents" ], "description": "Order copies of documents on the General Registry's file for an entity, such as its memorandum and articles, certificate of incorporation or registration, special resolutions and registered statements, with the Registrar's certification." }, "Create_ky_certified_copy_request": { "type": "object", "properties": { "type": { "const": "ky.certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_ky_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order certified copies of registered documents", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "copy_request", "title": "Request for certified copies", "source": "generated", "required": true }, { "key": "certified_copy", "title": "Certified copy of each registered document", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "copy_request", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "copy_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Cayman Islands", "form": "Certified copy of registered document", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "document_not_found", "type": null, "when": "The Registry holds no document matching the description and date." }, { "code": "records_not_public", "type": null, "when": "The entity is struck off; its records need a court order or law enforcement request." }, { "code": "authorisation_missing", "type": null, "when": "No principal or authorised person has requested it." } ] } }, "Params_ky_charge_record": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "description": "Entity type; one of applies_to." }, "charge_type": { "type": "string", "enum": [ "mortgage", "fixed_charge", "floating_charge", "share_charge", "security_interest_over_partnership_interest", "other" ], "description": "Use security_interest_over_partnership_interest for an ELP." }, "creation_date": { "type": "string", "format": "date", "description": "Date created; for an ELP, the date written notice was validly served at the registered office (s.31).", "examples": [ "2026-10-09" ] }, "property_description": { "type": "string", "description": "Short description of the property charged (s.54); for an ELP, the partnership interest." }, "secured_amount": { "$ref": "#/components/schemas/Money", "description": "Minor units." }, "chargees": { "type": "array", "items": {}, "description": "Mortgagees or persons entitled as {name, person or entity ref}; for an ELP, the grantee." }, "grantor": { "type": "object", "description": "ELP only: {name, person or entity ref}." }, "notice_served_on": { "type": "string", "description": "ELP only: ISO 8601 time the notice was served; priority runs from it (s.31)." }, "security_agreement_date": { "type": "string", "format": "date", "description": "An ELP notice must give the agreement, date and parties (s.32)." } }, "required": [ "entity_type", "charge_type", "creation_date", "property_description", "chargees" ], "description": "Enter a mortgage, charge or security interest in the entity's own register. A company, LLC or LLP records the property charged, the amount secured and the persons entitled." }, "Create_ky_charge_record": { "type": "object", "properties": { "type": { "const": "ky.charge.record" }, "params": { "$ref": "#/components/schemas/Params_ky_charge_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a mortgage, charge or security interest in the register", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "security_document", "title": "Charge, mortgage or security agreement", "source": "uploaded", "required": true }, { "key": "notice_of_security_interest", "title": "Notice of security interest served at the registered office", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Resolution approving the charge", "source": "generated", "required": false }, { "key": "register_entry", "title": "Register entry", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_entry", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "secured_amount_required", "type": null, "when": "A company, LLC or LLP entry has no secured_amount." }, { "code": "elp_notice_invalid", "type": null, "when": "An ELP notice lacks the agreement, date, parties, grantor, grantee or interest (s.32)." }, { "code": "general_partner_consent_missing", "type": null, "when": "A limited partner grants security without the general partner's written consent (s.32)." } ] } }, "Params_ky_charge_release": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "description": "Entity type; one of applies_to." }, "charge_entry": { "type": "string", "description": "Entry identifier returned by ky.charge.record." }, "release_type": { "type": "string", "enum": [ "full_discharge", "partial_release" ], "description": "Whole security or part." }, "release_date": { "type": "string", "format": "date", "description": "Date the chargee released the security.", "examples": [ "2026-12-15" ] }, "released_amount": { "$ref": "#/components/schemas/Money", "description": "Minor units, for a partial release." }, "release_document": { "type": "string", "pattern": "^doc_", "description": "The release, deed of release or satisfaction letter." } }, "required": [ "entity_type", "charge_entry", "release_type", "release_date" ], "description": "Mark a mortgage, charge or security interest as released or partly released in the entity's own register, with the release date and the chargee's evidence. The entry stays on the register as history." }, "Create_ky_charge_release": { "type": "object", "properties": { "type": { "const": "ky.charge.release" }, "params": { "$ref": "#/components/schemas/Params_ky_charge_release" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the release or discharge of a charge", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "release_evidence", "title": "Chargee's release or satisfaction", "source": "uploaded", "required": true }, { "key": "register_entry", "title": "Updated register entry", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "register_entry", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "charge_entry_not_found", "type": null, "when": "charge_entry matches no entry on this entity's register." }, { "code": "release_evidence_missing", "type": null, "when": "No release document from the chargee was uploaded." } ] } }, "Params_ky_distribution_declare": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc", "elp" ], "description": "Entity type; one of applies_to." }, "distribution_type": { "type": "string", "enum": [ "profit_distribution", "return_of_contribution" ], "description": "Profit distribution, or a return of all or part of a contribution." }, "decision_maker": { "type": "string", "enum": [ "managers", "members", "general_partner" ], "description": "Per the agreement: managers or members, general partner." }, "declaration_date": { "type": "string", "format": "date", "description": "Date of the decision.", "examples": [ "2026-10-20" ] }, "record_date": { "type": "string", "format": "date", "description": "If the agreement uses a record date (LLC Act s.24)." }, "payment_date": { "type": "string", "format": "date", "description": "Date paid.", "examples": [ "2026-11-06" ] }, "total_amount": { "$ref": "#/components/schemas/Money", "description": "Minor units." }, "allocation_basis": { "type": "string", "enum": [ "per_agreement", "default_by_agreed_contribution" ], "description": "per_agreement, or the LLC Act s.23 fallback on agreed contributions." }, "class_or_group": { "type": "string", "description": "Class of interest or group paid, if not all." }, "solvency_confirmed": { "type": "boolean", "description": "Managers or general partner confirm the entity is not, and will not as a result be, unable to pay its debts as they fall due." }, "agreement_document": { "type": "string", "pattern": "^doc_", "description": "The LLC or partnership agreement, if not on file." } }, "required": [ "entity_type", "distribution_type", "decision_maker", "declaration_date", "payment_date", "total_amount", "allocation_basis", "solvency_confirmed" ], "description": "Declare a distribution to the members of an LLC or the limited partners of an ELP, or a return of contribution. The LLC agreement or partnership agreement governs how, when and by whom." }, "Create_ky_distribution_declare": { "type": "object", "properties": { "type": { "const": "ky.distribution.declare" }, "params": { "$ref": "#/components/schemas/Params_ky_distribution_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a distribution of an LLC or exempted limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "distribution_resolution", "title": "Managers' consent, members' resolution or general partner's decision", "source": "generated", "required": true }, { "key": "solvency_confirmation", "title": "Solvency confirmation", "source": "generated", "required": true }, { "key": "distribution_schedule", "title": "Payment schedule, notices and updated contributions record", "source": "generated", "required": true } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "recipient", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "distribution_resolution", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "distribution_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "solvency_confirmation", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_confirmation", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing for a distribution", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "solvency_confirmation_required", "type": null, "when": "solvency_confirmed is not true." }, { "code": "agreement_not_on_file", "type": null, "when": "No current agreement on file or uploaded to check the mechanics." }, { "code": "default_allocation_not_available", "type": null, "when": "default_by_agreed_contribution requested for an ELP." }, { "code": "date_sequence_invalid", "type": null, "when": "declaration_date, record_date and payment_date are not in that order." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert on a payee holds that payment until compliance clears it." } ] } }, "Params_ky_dividend_declare": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "description": "Entity type; one of applies_to." }, "dividend_type": { "type": "string", "enum": [ "interim", "final", "special" ], "description": "Interim, final or special." }, "declaring_body": { "type": "string", "enum": [ "board", "members_on_board_recommendation" ], "description": "Interim: the board." }, "declaration_date": { "type": "string", "format": "date", "description": "Date of the resolution.", "examples": [ "2026-10-20" ] }, "record_date": { "type": "string", "format": "date", "description": "Date the register of members is read to fix who is paid.", "examples": [ "2026-10-30" ] }, "payment_date": { "type": "string", "format": "date", "description": "Date paid; the share premium solvency test applies just after it.", "examples": [ "2026-11-06" ] }, "currency": { "type": "string", "description": "ISO 4217 code.", "examples": [ "USD" ] }, "total_amount": { "$ref": "#/components/schemas/Money", "description": "Minor units." }, "amount_per_share": { "type": "number", "description": "Per share in the dividend currency, such as 0.0125." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Default all classes by their rights." }, "segregated_portfolio": { "type": "string", "description": "Segregated portfolio company only: paid by reference to that portfolio alone (s.217,)." }, "funding_source": { "type": "string", "enum": [ "profits", "share_premium_account", "profits_and_share_premium", "other_as_permitted_by_articles" ], "description": "Table A reg 90 allows payment only out of profits if the articles adopt it; the Act also allows share premium under s.34." }, "solvency_confirmed": { "type": "boolean", "description": "Directors confirm the company can pay its debts as they fall due immediately after the payment date." }, "supporting_accounts": { "type": "string", "pattern": "^doc_", "description": "Management accounts or balance sheet." } }, "required": [ "entity_type", "dividend_type", "declaring_body", "declaration_date", "record_date", "payment_date", "currency", "funding_source", "solvency_confirmed" ], "description": "Declare an interim, final or special dividend of a Cayman company. Entiva records the board resolution, takes the directors' solvency confirmation, fixes the record and payment dates against the register of members, and produces the." }, "Create_ky_dividend_declare": { "type": "object", "properties": { "type": { "const": "ky.dividend.declare" }, "params": { "$ref": "#/components/schemas/Params_ky_dividend_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a dividend", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution declaring or recommending the dividend", "source": "generated", "required": true }, { "key": "solvency_confirmation", "title": "Directors' solvency confirmation", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution declaring the dividend", "source": "generated", "required": false }, { "key": "dividend_schedule", "title": "Register snapshot, payment schedule and notices", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "solvency_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "dividend_schedule", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing for a dividend", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "solvency_confirmation_required", "type": null, "when": "funding_source includes share premium and solvency_confirmed is not true." }, { "code": "share_premium_insufficient", "type": null, "when": "The amount exceeds the share premium account balance in the books." }, { "code": "profits_not_evidenced", "type": null, "when": "Table A reg 90 applies and the accounts show profits below the dividend." }, { "code": "date_sequence_invalid", "type": null, "when": "declaration_date, record_date and payment_date are not in that order." }, { "code": "screening_alert_open", "type": null, "when": "An open sanctions alert on a payee holds that payment until compliance clears it." } ] } }, "Params_ky_document_authentication_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp", "section_80_company", "exempted_trust" ], "description": "Entity type; one of applies_to." }, "documents": { "type": "array", "items": {}, "description": "As {document, kind, document_date, signed_by}." }, "destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code; rejected if a Hague Apostille Convention party." }, "notarisation": { "type": "string", "enum": [ "not_needed", "arrange_cayman_notary", "already_notarised" ], "description": "not_needed for a document a public officer signed; arrange_cayman_notary for a private one; already_notarised if done." }, "express": { "type": "boolean", "description": "Default false." }, "delivery": { "type": "string", "enum": [ "courier_to_address", "partner_holds_for_collection" ], "description": "Where the documents go." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for courier_to_address." } }, "required": [ "entity_type", "documents", "destination_country", "notarisation", "delivery" ], "description": "Have the Passport and Corporate Services Office authenticate a Cayman document 'for Governor' when the receiving country is not a Hague Apostille Convention party. The notary's or officer's signature is certified by standard wording typed." }, "Create_ky_document_authentication_request": { "type": "object", "properties": { "type": { "const": "ky.document_authentication.request" }, "params": { "$ref": "#/components/schemas/Params_ky_document_authentication_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain authentication of Cayman documents for a non-Hague country", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_company", "foreign_lp", "section_80_company", "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "source_document", "title": "Document to legalise", "source": "uploaded", "required": true }, { "key": "instruction_letter", "title": "Typed instruction letter on letterhead", "source": "generated", "required": true }, { "key": "authenticated_document", "title": "Authenticated document", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "notary", "verification_level": "none" }, { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "source_document", "signer_role": "officer", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "source_document", "signer_role": "registered_agent", "method": "wet_ink_notarised_apostilled", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "source_document", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "instruction_letter", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Passport and Corporate Services Office, Cayman Islands Government", "form": "Authentication for a non-Hague country", "channel": "paper", "government_fee": { "amount": 75, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "destination_is_hague_party", "type": null, "when": "destination_country is a Hague party; use ky.apostille.request." }, { "code": "document_too_old", "type": null, "when": "A document is dated more than 12 months before submission." }, { "code": "notarisation_required", "type": null, "when": "A private document is not notarised by a Cayman notary." } ] } }, "Params_ky_general_meeting_hold": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type; one of applies_to." }, "meeting_type": { "type": "string", "enum": [ "extraordinary", "class", "annual_by_articles" ], "description": "annual_by_articles is for an exempted company whose articles require an AGM." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "For a class meeting." }, "convened_by": { "type": "string", "enum": [ "board", "members" ], "description": "Table A reg 40: the directors, or if too few can act, any director or two members." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting.", "examples": [ "2026-11-12" ] }, "meeting_time": { "type": "string", "description": "HH:MM, Cayman local time.", "examples": [ "15:00" ] }, "format": { "type": "string", "enum": [ "in_person", "virtual", "hybrid" ], "description": "Virtual and hybrid need articles that allow it." }, "venue": { "$ref": "#/components/schemas/Address", "description": "Required unless virtual." }, "notice_date": { "type": "string", "format": "date", "description": "Date notice is served; Table A reg 41: at least seven days.", "examples": [ "2026-11-02" ] }, "short_notice_consent": { "type": "boolean", "description": "All members entitled to notice agreed to shorter notice." }, "chair": { "type": "string", "pattern": "^per_", "description": "Presides and signs the minutes." }, "resolutions": { "type": "array", "items": {}, "description": "Items as {title, resolution_type, proposed_text}." }, "proxies": { "type": "array", "items": {}, "description": "Proxies as {member, proxy_holder, document}." }, "auto_file_special_resolutions": { "type": "boolean", "description": "Default true for companies, ignored for an LLC: queue ky.special_resolution.file." } }, "required": [ "entity_type", "meeting_type", "convened_by", "meeting_date", "meeting_time", "format", "notice_date", "chair", "resolutions" ], "description": "Convene, hold and minute an extraordinary, class or articles-required annual general meeting of members and record the resolutions passed. Entiva drafts the notice, checks the notice period, tracks proxies, records votes and prepares." }, "Create_ky_general_meeting_hold": { "type": "object", "properties": { "type": { "const": "ky.general_meeting.hold" }, "params": { "$ref": "#/components/schemas/Params_ky_general_meeting_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Hold and minute a general meeting of members", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "constitution", "title": "Memorandum and articles, or LLC agreement", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Resolution convening the meeting", "source": "generated", "required": true }, { "key": "notice_of_meeting", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "proxy_form", "title": "Form of proxy", "source": "generated", "required": false }, { "key": "minutes", "title": "Minutes and attendance record", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "proxy", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "proxy_form", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None for the meeting", "form": "No Registry filing for the meeting", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "notice_period_too_short", "type": null, "when": "Notice is shorter than the articles require and short_notice_consent is not true." }, { "code": "special_resolution_notice_missing", "type": null, "when": "A special resolution is proposed but the notice does not say so (s.60)." }, { "code": "articles_not_on_file", "type": null, "when": "No current articles or LLC agreement on file or uploaded." }, { "code": "format_not_permitted", "type": null, "when": "Virtual, video, telephone or hybrid chosen but the articles do not allow it." } ] } }, "Params_ky_good_standing_certificate_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_lp" ], "description": "Entity type; one of applies_to." }, "purpose": { "type": "string", "enum": [ "bank_or_financial_institution", "regulator", "counterparty_or_transaction", "foreign_registration", "court_or_litigation", "other" ], "description": "What it is for; receivers set their own age limit." }, "copies": { "type": "integer", "description": "Default 1; each carries its own fee." }, "express": { "type": "boolean", "description": "Default false." }, "addressee": { "type": "string", "description": "Receiving institution, for your records." }, "needs_apostille": { "type": "boolean", "description": "Queue a ky.apostille.request for the issued document." }, "apostille_destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code; required with needs_apostille." } }, "required": [ "entity_type", "purpose" ], "description": "Order the General Registry's certificate of good standing for a Cayman entity. An entity is in good standing if all fees and penalties are paid and the Registrar knows of no default." }, "Create_ky_good_standing_certificate_request": { "type": "object", "properties": { "type": { "const": "ky.good_standing_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_ky_good_standing_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a certificate of good standing", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp", "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_request", "title": "Request for the certificate", "source": "generated", "required": true }, { "key": "certificate_of_good_standing", "title": "Certificate of good standing", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "certificate_request", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Cayman Islands", "form": "Certificate of good standing", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The Registry shows unpaid fees, penalties or a known default and will not issue; the error lists them." }, { "code": "entity_struck_off", "type": null, "when": "The entity is struck off or dissolved." }, { "code": "authorisation_missing", "type": null, "when": "No principal or authorised person has requested it." } ] } }, "Params_ky_member_resolution_pass": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type; one of applies_to." }, "resolution_type": { "type": "string", "enum": [ "ordinary", "special", "class" ], "description": "Ordinary, special or class." }, "title": { "type": "string", "description": "Short title.", "examples": [ "Change of name" ] }, "resolution_text": { "type": "string", "description": "Text; give this or resolution_document, else Entiva drafts from the title." }, "resolution_document": { "type": "string", "pattern": "^doc_", "description": "A resolution you drafted." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "For a class resolution." }, "articles_allow_written_resolution": { "type": "boolean", "description": "Confirm the articles allow it; for a special resolution they must expressly authorise it (s.60)." }, "signatories": { "type": "array", "items": {}, "description": "Signers as {member, signs_as, mandate}." }, "auto_file_special_resolution": { "type": "boolean", "description": "Default true for companies, ignored for an LLC: queue ky.special_resolution.file." } }, "required": [ "entity_type", "resolution_type", "title", "articles_allow_written_resolution", "signatories" ], "description": "Draft and collect a written ordinary, special or class resolution of the members without a meeting. For a company, a written special resolution needs articles that authorise it and the signature of every member entitled to vote (s.60); it." }, "Create_ky_member_resolution_pass": { "type": "object", "properties": { "type": { "const": "ky.member_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_ky_member_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass a written resolution of the members", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "member_resolution", "title": "Written resolution of the members", "source": "generated", "required": true }, { "key": "constitution", "title": "Memorandum and articles, or LLC agreement", "source": "uploaded", "required": false }, { "key": "register_of_members_extract", "title": "Register of members extract", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting" } ], "signatures": [ { "document_key": "member_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "member_resolution", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None for the resolution", "form": "No Registry filing for the resolution", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "written_special_resolution_not_authorised", "type": null, "when": "A company special resolution is requested and the articles do not authorise it in writing." }, { "code": "member_missing", "type": null, "when": "A written special resolution omits a member entitled to vote." }, { "code": "mandate_scope_insufficient", "type": null, "when": "A signer is an agent whose mandate lacks this action type or signing authority." }, { "code": "dedicated_action_required", "type": null, "when": "The matter has its own action." } ] } }, "Params_ky_registry_certificate_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp" ], "description": "Entity type; one of applies_to." }, "certificate_type": { "type": "string", "enum": [ "incumbency", "existence", "incorporation_or_registration", "change_of_name", "strike_off", "dissolution_or_termination", "restoration", "shareholders", "customised_certificate", "customised_letter", "other" ], "description": "Incumbency: companies, foundation companies, LLCs, LLPs only." }, "other_description": { "type": "string", "description": "Required for other: the certificate as named in the Registry schedule." }, "required_wording": { "type": "string", "description": "Required for customised types: the exact statements to certify, limited to facts on the Registry's record." }, "purpose": { "type": "string", "enum": [ "bank_or_financial_institution", "regulator", "counterparty_or_transaction", "foreign_registration", "court_or_litigation", "other" ], "description": "What it is for." }, "copies": { "type": "integer", "description": "Default 1; each carries its own fee." }, "express": { "type": "boolean", "description": "Default false." }, "needs_apostille": { "type": "boolean", "description": "Queue a ky.apostille.request for the issued document." }, "apostille_destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code; required with needs_apostille." } }, "required": [ "entity_type", "certificate_type", "purpose" ], "description": "Order any other certificate the General Registry issues from its record: incumbency, existence, incorporation or registration, change of name, strike-off, dissolution or termination, restoration, a shareholders certificate, or a customised." }, "Create_ky_registry_certificate_request": { "type": "object", "properties": { "type": { "const": "ky.registry_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_ky_registry_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a Registry certificate of incumbency, existence, status or custom wording", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_request", "title": "Request for the certificate", "source": "generated", "required": true }, { "key": "registry_certificate", "title": "Registry certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "certificate_request", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Cayman Islands", "form": "Registry certificate", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "certificate_type_not_available_for_entity_type", "type": null, "when": "The Registry does not list it for the type, such as incumbency for an ELP." }, { "code": "wording_not_certifiable", "type": null, "when": "Customised wording goes beyond what the Registry's record shows, or required_wording is missing." }, { "code": "status_does_not_support_certificate", "type": null, "when": "The entity's status does not allow it, such as strike-off for an entity not struck off." }, { "code": "authorisation_missing", "type": null, "when": "No principal or authorised person has requested it." } ] } }, "Params_ky_registry_search_request": { "type": "object", "properties": { "search_type": { "type": "string", "enum": [ "general_search", "register_of_companies", "current_directors", "llc_managers", "lp_statements", "elp_statements" ], "description": "Fee in CI$ and legal basis: general_search 30 (Sch.5 Part 6); register_of_companies 50 (s.26, companies only); current_directors 50 (s.55A, companies only)." }, "target": { "type": "object", "description": "Entity to look up as {name, registration_number}; defaults to the entity in the path. applies_to lists the target types; the path entity can be any type." }, "target_entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc", "foundation_company", "elp", "lp", "llp", "foreign_company", "foreign_lp", "section_80_company" ], "description": "Type of the target, if known; it selects the fee regulation and checks search_type fits." }, "purpose": { "type": "string", "enum": [ "kyc", "transaction_due_diligence", "litigation", "name_history", "other" ], "description": "Why the search is made, for the audit trail." }, "focus": { "type": "string", "enum": [ "general", "status", "name_history", "deregistration_details" ], "description": "general_search only." } }, "required": [ "search_type", "purpose" ], "description": "Look up an entity on the General Registry's record through Entiva CORIS account: a general search report, the Registrar's register of companies entry, the list of current directors and alternates, an LLC's current managers, or the." }, "Create_ky_registry_search_request": { "type": "object", "properties": { "type": { "const": "ky.registry_search.request" }, "params": { "$ref": "#/components/schemas/Params_ky_registry_search_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Search or inspect the General Registry record of an entity", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc", "foundation_company", "elp", "lp", "llp", "foreign_company", "foreign_lp", "section_80_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "search_request", "title": "Search or inspection request", "source": "generated", "required": true }, { "key": "search_result", "title": "Search report, register entry, directors list or registered statements", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "search_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Cayman Islands", "form": "Registry search or inspection", "channel": "online", "government_fee": { "amount": 30, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "target_entity_type_not_supported", "type": null, "when": "target_entity_type is not one of applies_to." }, { "code": "search_type_not_available_for_entity_type", "type": null, "when": "search_type does not fit the target type, such as current_directors for an ELP or llc_managers for a company." }, { "code": "target_not_found", "type": null, "when": "No Cayman entity matches target on the Registry's record." }, { "code": "target_ambiguous", "type": null, "when": "Several entities match the name; add the registration number." }, { "code": "records_not_public", "type": null, "when": "The target is struck off and its records are not public." } ] } }, "Params_ky_special_resolution_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type; one of applies_to." }, "resolution_date": { "type": "string", "format": "date", "description": "Date passed; for a written resolution, the last signature.", "examples": [ "2026-10-14" ] }, "resolution_purpose": { "type": "string", "enum": [ "alter_memorandum", "alter_articles", "reduce_capital", "appoint_inspectors", "change_name", "voluntary_winding_up", "merger_or_continuation", "other" ], "description": "Purposes with their own action are rejected to avoid a double filing." }, "resolution_title": { "type": "string", "description": "Short description.", "examples": [ "Adopt amended and restated articles of association" ] }, "resolution_document": { "type": "string", "pattern": "^doc_", "description": "Signed copy; else the source action's copy is used." }, "passed_by": { "type": "string", "enum": [ "meeting", "written" ], "description": "How it was passed." }, "source_action": { "type": "string", "description": "act_ id of the meeting or member-resolution action." }, "authentication": { "type": "string", "enum": [ "director", "secretary", "licensed_partner_as_secretary" ], "description": "Who authenticates the return: a director, the secretary, or Entiva once appointed secretary." }, "express": { "type": "boolean", "description": "Default false." }, "late_filing_reason": { "type": "string", "description": "Required after 15 days; the Registrar may extend time (s.199)." } }, "required": [ "entity_type", "resolution_date", "resolution_purpose", "resolution_title", "passed_by", "authentication" ], "description": "Forward a copy of a special resolution to the General Registry within 15 days of its passing, as Companies Act s.62 requires. Entiva it on CAP and returns the recorded copy." }, "Create_ky_special_resolution_file": { "type": "object", "properties": { "type": { "const": "ky.special_resolution.file" }, "params": { "$ref": "#/components/schemas/Params_ky_special_resolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a special resolution with the Registrar", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Copy of the special resolution", "source": "uploaded", "required": true }, { "key": "filing_authorisation", "title": "Director's authorisation of the filing", "source": "generated", "required": true }, { "key": "filed_copy", "title": "Recorded copy and receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Cayman Islands", "form": "Special resolution filing", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "An LLC or other type outside applies_to." }, { "code": "dedicated_action_required", "type": null, "when": "The purpose has its own Registry application." }, { "code": "filing_deadline_passed", "type": null, "when": "Over 15 days since resolution_date and no late_filing_reason." }, { "code": "registry_rejected", "type": null, "when": "The Registry rejected or queried the filing; its reason is in the message." } ] } }, "Params_ky_statutory_register_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "description": "Entity type; one of applies_to." }, "register": { "type": "string", "enum": [ "members", "directors_officers", "managers", "partners", "supervisors" ], "description": "Key as in GET /v1/entities/{id}/registers/{register}; managers is for an LLC, partners for an ELP or LLP, supervisors for a foundation company." }, "operation": { "type": "string", "enum": [ "add_entry", "amend_entry", "close_entry", "change_location" ], "description": "close_entry records the date a person ceased; entries are closed, not deleted." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; update deadlines run from here.", "examples": [ "2026-09-01" ] }, "reason": { "type": "string", "enum": [ "transaction_outside_entiva", "correction_of_error", "transfer_in_catch_up", "court_order", "other" ], "description": "Why the register changes outside a dedicated action." }, "entries": { "type": "array", "items": {}, "description": "Not for change_location. members: {person, class, shares, amount_paid, voting_rights, date_entered, date_ceased}. officers and supervisors: {person, office." }, "location": { "$ref": "#/components/schemas/Address", "description": "For change_location." }, "supporting_documents": { "type": "array", "items": {}, "description": "document_ref values: transfer form, resolution, court order." } }, "required": [ "entity_type", "register", "operation", "effective_date", "reason" ], "description": "Bring a statutory register up to date outside the actions that normally write to it: record a transaction that did not go through Entiva, correct an error, catch up a transferred-in entity, or change where a register is kept. Entiva." }, "Create_ky_statutory_register_change": { "type": "object", "properties": { "type": { "const": "ky.statutory_register.change" }, "params": { "$ref": "#/components/schemas/Params_ky_statutory_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Add, amend or close an entry in a statutory register", "x-entiva": { "jurisdiction": "ky", "stage": "governance", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "supporting_evidence", "title": "Evidence for the entry", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Resolution approving the entry", "source": "generated", "required": false }, { "key": "register_extract", "title": "Updated register extract", "source": "generated", "required": true } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_extract", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No Registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not one of applies_to." }, { "code": "register_not_available_for_entity_type", "type": null, "when": "The register does not exist for the type, such as supervisors on a non-foundation company." }, { "code": "registrar_notification_required", "type": null, "when": "directors_officers change also needs the Registrar notified in 30 days; use the officer action." }, { "code": "evidence_missing", "type": null, "when": "reason needs evidence and none was given." } ] } }, "Params_ky_aml_officers_designate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "llc", "elp", "foundation_company", "ordinary_nonresident_company" ], "description": "Entity type." }, "designations": { "type": "array", "items": {}, "description": "[{role, person, effective_date, replaces, outsourced}]." }, "rfb_basis": { "type": "string", "enum": [ "regulated_fund", "private_trust_company", "siba_registered_person", "dnfbp", "other_relevant_financial_business" ], "description": "Why the entity carries on relevant financial business." }, "supervisory_authority": { "type": "string", "enum": [ "cima", "other_designated_authority" ], "description": "CIMA for CIMA-regulated entities; otherwise the authority designated under the AML Regulations." }, "supervisory_authority_name": { "type": "string", "description": "Required for other_designated_authority." }, "outsourcing_provider": { "type": "string", "pattern": "^per_", "description": "AML service provider whose employee performs a role; the entity stays responsible (reg 3)." }, "decision_body": { "type": "string", "enum": [ "board", "managers_or_members", "general_partner" ], "description": "Who designates: board, managers or members, general partner." } }, "required": [ "entity_type", "designations", "rfb_basis", "supervisory_authority", "decision_body" ], "description": "Records the designation of an Anti-Money Laundering Compliance Officer, a Money Laundering Reporting Officer and a Deputy MLRO, each at managerial level, and notifies the supervisory authority. Needed before the entity carries on relevant." }, "Create_ky_aml_officers_designate": { "type": "object", "properties": { "type": { "const": "ky.aml_officers.designate" }, "params": { "$ref": "#/components/schemas/Params_ky_aml_officers_designate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Designate or replace the AML Compliance Officer, MLRO and Deputy MLRO", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "llc", "elp", "foundation_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "designating_resolution", "title": "Resolution or general partner decision designating the officers", "source": "generated", "required": true }, { "key": "designee_acceptance", "title": "Each designee's acceptance of the role", "source": "generated", "required": true }, { "key": "designee_cv", "title": "Curriculum vitae showing managerial level", "source": "uploaded", "required": true }, { "key": "outsourcing_agreement", "title": "Outsourcing agreement", "source": "uploaded", "required": false }, { "key": "supervisory_authority_notice", "title": "Notice of names and appointment dates to the supervisory authority", "source": "generated", "required": false } ], "people": [ { "role": "aml_officer", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "designating_resolution", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "designating_resolution", "signer_role": "other", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "designating_resolution", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "designee_acceptance", "signer_role": "aml_officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "supervisory_authority_notice", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Supervisory authority for the entity's relevant financial business", "form": "Notice of names and appointment dates of the AMLCO, MLRO and Deputy MLRO", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deputy_must_differ_from_mlro", "type": null, "when": "The same person is MLRO and Deputy MLRO." }, { "code": "not_managerial_level", "type": null, "when": "The CV does not show managerial level." }, { "code": "no_relevant_financial_business", "type": null, "when": "The entity carries on none; no designation is required." } ] } }, "Params_ky_director_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type." }, "capacity": { "type": "string", "enum": [ "director", "alternate_director" ], "description": "director, or alternate_director (appointed by a director to exercise all that director's powers, s.55)." }, "appointee": { "type": "string", "pattern": "^per_", "description": "Individual, or corporate party created with POST /v1/people." }, "position": { "type": "string", "description": "Position on the register, for example Director, Chairperson, Managing Director." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect; for a CIMA-regulated entity not before CIMA approval." }, "appointment_method": { "type": "string", "enum": [ "board_resolution", "members_resolution", "founder_notice", "appointing_director_instrument" ], "description": "Who appoints under the articles. founder_notice: foundation companies only." }, "register_address": { "$ref": "#/components/schemas/Address", "description": "Address entered in the register." }, "appointing_director": { "type": "string", "pattern": "^per_", "description": "Required for an alternate: the director who appoints." }, "alternate_scope": { "type": "string", "enum": [ "full", "limited" ], "description": "Alternates: full is registered and filed; limited (any s.55 case, including a period under 90 days) is recorded internally with no filing or fee." }, "articles_permit_alternates": { "type": "boolean", "description": "Required for an alternate: the articles provide for alternates." }, "acting_individuals": { "type": "array", "items": {}, "description": "Required for a corporate appointee: person_ref of each individual who acts for it." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing director replaced in the same filing." }, "nominee_arrangement": { "type": "boolean", "description": "True for a nominee or professional director; use ky.nominee_director.appoint." }, "cima_approval_date": { "type": "string", "format": "date", "description": "CIMA-regulated entity needing approval: the approval date, which fixes the effective date." }, "drla_registration_number": { "type": "string", "description": "Covered entity under the DRLA: the appointee's CIMA registration or licence number." }, "residency_status": { "type": "string", "enum": [ "caymanian", "non_caymanian" ], "description": "Ordinary resident company: for the Registry's 60% Caymanian-director check." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." }, "cbp_principal": { "type": "string", "pattern": "^per_", "description": "Ordinary resident company without a licensed registered office: the CBP account holder." } }, "required": [ "entity_type", "capacity", "appointee", "position", "effective_date", "appointment_method", "register_address" ], "description": "Appoints a director or a registered alternate, collects the consent to act, updates the register of directors and officers and notifies the Registrar within 30 days of the effective date." }, "Create_ky_director_appoint": { "type": "object", "properties": { "type": { "const": "ky.director.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director or alternate director", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution appointing the director", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Members' resolution appointing the director", "source": "generated", "required": false }, { "key": "founder_notice", "title": "Founder's notice appointing the director", "source": "generated", "required": false }, { "key": "instrument_of_appointment", "title": "Appointing director's instrument appointing the alternate", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "passport", "title": "Passport or photo ID", "source": "uploaded", "required": true }, { "key": "corporate_appointee_documents", "title": "Corporate appointee: incorporation and good standing certificates, constitution, resolution naming.", "source": "uploaded", "required": false }, { "key": "cima_approval_letter", "title": "CIMA approval", "source": "uploaded", "required": false }, { "key": "register_of_directors_and_officers", "title": "Updated register of directors and officers", "source": "generated", "required": true } ], "people": [ { "role": "appointee", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "founder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "founder_notice", "signer_role": "founder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "instrument_of_appointment", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "register_of_directors_and_officers", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of directors and officers showing the appointment", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "appointee_not_verified", "type": null, "when": "Verification below identity_address or expired." }, { "code": "use_nominee_director_action", "type": null, "when": "nominee_arrangement is true." }, { "code": "drla_registration_required", "type": null, "when": "Covered entity and no DRLA number." }, { "code": "appointee_is_director", "type": null, "when": "Alternate who is already a director (s.55) or already another director's alternate (s.55)." }, { "code": "cbp_principal_required", "type": null, "when": "Ordinary resident company without the partner as registered office and no cbp_principal." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_director_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type." }, "capacity": { "type": "string", "enum": [ "director", "alternate_director" ], "description": "director or registered alternate_director." }, "director": { "type": "string", "pattern": "^per_", "description": "The outgoing person, as on the register." }, "reason": { "type": "string", "enum": [ "resignation", "removal", "vacation_of_office", "death", "revoked_by_appointing_director", "appointing_director_ceased", "term_expired" ], "description": "Why office ends; the last three are for alternates." }, "effective_date": { "type": "string", "format": "date", "description": "Date the office ends." }, "removal_method": { "type": "string", "enum": [ "members_special_resolution", "members_ordinary_resolution", "board_resolution", "founder_notice" ], "description": "Required for removal." }, "replacement_action_id": { "type": "string", "description": "act_ id of a ky.director.appoint action filed together with this one." }, "cima_approval_date": { "type": "string", "format": "date", "description": "CIMA-regulated entity: date of approval or notification that fixes the effective date." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." }, "cbp_principal": { "type": "string", "pattern": "^per_", "description": "Ordinary resident company without a licensed registered office: the CBP account holder." } }, "required": [ "entity_type", "capacity", "director", "reason", "effective_date" ], "description": "Ends a director's or registered alternate's office, updates the register and notifies the Registrar within 30 days." }, "Create_ky_director_remove": { "type": "object", "properties": { "type": { "const": "ky.director.remove" }, "params": { "$ref": "#/components/schemas/Params_ky_director_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a director or alternate director", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Resignation letter or revocation notice", "source": "generated", "required": false }, { "key": "removal_resolution", "title": "Resolution or founder's notice removing the director", "source": "generated", "required": false }, { "key": "death_certificate", "title": "Certified death certificate", "source": "uploaded", "required": false }, { "key": "register_of_directors_and_officers", "title": "Updated register of directors and officers", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "founder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resignation_letter", "signer_role": "director", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "removal_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "removal_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "removal_resolution", "signer_role": "founder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of directors and officers showing the cessation", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_director_removal_blocked", "type": null, "when": "Would leave fewer directors than the articles need or none, with no replacement; Entiva guard, not statute." }, { "code": "resignation_letter_required", "type": null, "when": "Resignation without a signed letter." }, { "code": "cbp_principal_required", "type": null, "when": "Ordinary resident company without the partner as registered office and no cbp_principal." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_director_registration_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_spc", "llc", "foundation_company" ], "description": "Entity type of the covered entity the director serves." }, "director": { "type": "string", "pattern": "^per_", "description": "The director: an individual, or a corporate party for a corporate director." }, "category": { "type": "string", "enum": [ "registered_director", "professional_director", "corporate_director" ], "description": "registered_director: individual on fewer than 20 covered entities; professional_director: 20 or more; corporate_director: body corporate." }, "covered_entity_count": { "type": "integer", "description": "Covered entities the director sits on or will sit on, including this one; 20 or more makes an individual a professional director." }, "covered_entity_basis": { "type": "string", "enum": [ "regulated_mutual_fund", "siba_registered_person_company" ], "description": "Why the entity is covered." }, "intended_appointment_date": { "type": "string", "format": "date", "description": "Registration must be complete before this date." }, "gateway_account_email": { "type": "string", "description": "Email for the director's Gateway Portal account." }, "insurance_confirmed": { "type": "boolean", "description": "Professional and corporate directors: cover of at least US$1.25m in aggregate and per claim." }, "disclosures": { "type": "string", "description": "Any fraud or dishonesty conviction or relevant sanction; CIMA may refuse registration." } }, "required": [ "entity_type", "director", "category", "covered_entity_count", "covered_entity_basis", "intended_appointment_date", "gateway_account_email" ], "description": "Prepares a director's initial registration or licence application on CIMA's Director's Gateway Portal. The director must be registered before being appointed to a covered entity." }, "Create_ky_director_registration_apply": { "type": "object", "properties": { "type": { "const": "ky.director_registration.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_director_registration_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register or license a director of a CIMA-regulated fund or SIBA registered person", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_spc", "llc", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cima_application", "title": "Application data prepared for the Gateway Portal", "source": "generated", "required": true }, { "key": "curriculum_vitae", "title": "Curriculum vitae", "source": "uploaded", "required": false }, { "key": "insurance_certificate", "title": "Insurance certificate", "source": "uploaded", "required": false }, { "key": "corporate_director_documents", "title": "Incorporation and good standing certificates and details of two fit and proper natural-person board.", "source": "uploaded", "required": false }, { "key": "cima_registration_confirmation", "title": "CIMA registration or licence confirmation with the identification number", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "cima_application", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Initial registration", "channel": "online", "government_fee": { "amount": 700, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "category_mismatch", "type": null, "when": "category does not fit covered_entity_count or the director's legal form." }, { "code": "application_returned", "type": null, "when": "The 14-day window after the identification number ran out." }, { "code": "entity_not_covered", "type": null, "when": "Not a covered entity." }, { "code": "director_not_verified", "type": null, "when": "Verification below identity_address or expired." } ] } }, "Params_ky_director_registration_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_spc", "llc", "foundation_company" ], "description": "Entity type of the covered entity the director serves." }, "director": { "type": "string", "pattern": "^per_", "description": "The director: an individual, or a corporate party for a corporate director." }, "change_type": { "type": "string", "enum": [ "directorship_added", "directorship_ceased", "personal_details_changed", "death_of_director", "annual_fee" ], "description": "What changed." }, "fee_year": { "type": "integer", "description": "Required for annual_fee: calendar year the fee is for." }, "category": { "type": "string", "enum": [ "registered_director", "professional_director", "corporate_director" ], "description": "Required for annual_fee: the director's category." }, "covered_entity_name": { "type": "string", "description": "Required for an added or ended directorship." }, "covered_entity_cima_reference": { "type": "string", "description": "CIMA reference of that entity." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; the 21 days run from it." }, "details_changed": { "type": "object", "description": "Required for personal_details_changed: {field, old_value, new_value}." }, "fund_in_liquidation": { "type": "boolean", "description": "True if the directorship ends on the fund's winding up." } }, "required": [ "entity_type", "director", "change_type", "effective_date" ], "description": "Prepares the director's 'Manage Directorships' update in CIMA's Director's Gateway Portal after an appointment, resignation, change of details or death, or the annual fee." }, "Create_ky_director_registration_change": { "type": "object", "properties": { "type": { "const": "ky.director_registration.change" }, "params": { "$ref": "#/components/schemas/Params_ky_director_registration_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a director's DRLA record or pay the annual fee", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_spc", "llc", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "manage_directorships", "title": "Directorship update data prepared for the Gateway Portal", "source": "generated", "required": true }, { "key": "acceptance_or_resignation_letter", "title": "Signed, dated letter accepting the appointment or resigning", "source": "generated", "required": false }, { "key": "directorship_support", "title": "Register of directors and signed written resolutions of the covered entity", "source": "generated", "required": false }, { "key": "fund_closure_documents", "title": "CWR 19 or CWR 20 and certificate of dissolution of the fund", "source": "uploaded", "required": false }, { "key": "death_certificate", "title": "Certified death certificate and directors' resolution", "source": "uploaded", "required": false }, { "key": "cima_payment_receipt", "title": "CIMA payment receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "acceptance_or_resignation_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "directorship_support", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "manage_directorships", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Manage Directorships update, or annual fee payment, on the Director's Gateway Portal", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "update_window_passed", "type": null, "when": "More than 21 days have passed; CIMA may treat it as a serious breach." }, { "code": "registration_surrendered", "type": null, "when": "annual_fee for a surrendered registration; a new application is needed." }, { "code": "covered_entity_required", "type": null, "when": "covered_entity_name missing for an added or ended directorship." }, { "code": "entity_not_covered", "type": null, "when": "Not a covered entity." }, { "code": "director_not_verified", "type": null, "when": "Verification below identity_address or expired." } ] } }, "Params_ky_director_registration_surrender": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_spc", "llc", "foundation_company" ], "description": "Entity type of the covered entity the director serves." }, "director": { "type": "string", "pattern": "^per_", "description": "The director: an individual, or a corporate party for a corporate director." }, "category_surrendered": { "type": "string", "enum": [ "registered_director", "professional_director", "corporate_director" ], "description": "What is surrendered." }, "reason": { "type": "string", "enum": [ "ceased_all_covered_directorships", "change_to_professional_licence", "change_to_registered_director" ], "description": "Why." }, "resigned_from_all_covered_entities": { "type": "boolean", "description": "The portal requires confirmation of resignation from every covered entity; false is allowed for a category change." }, "effective_date": { "type": "string", "format": "date", "description": "Surrender date; do it by 31 December." } }, "required": [ "entity_type", "director", "category_surrendered", "reason", "resigned_from_all_covered_entities", "effective_date" ], "description": "Prepares the surrender of a registration or licence, or a switch between registered and professional status, before 31 December so the next year's fee is not due." }, "Create_ky_director_registration_surrender": { "type": "object", "properties": { "type": { "const": "ky.director_registration.surrender" }, "params": { "$ref": "#/components/schemas/Params_ky_director_registration_surrender" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Surrender a director's DRLA registration or licence", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_spc", "llc", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cima_surrender_application", "title": "Surrender data prepared for the Gateway Portal", "source": "generated", "required": true }, { "key": "resignation_evidence", "title": "Resignation letters or updated registers for each covered entity", "source": "uploaded", "required": true }, { "key": "cima_payment_receipt", "title": "CIMA payment receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cima_surrender_application", "signer_role": "director", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "Surrender application on the Director's Gateway Portal", "channel": "online", "government_fee": { "amount": 600, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "directorships_remaining", "type": null, "when": "A covered entity still lists the director." }, { "code": "surrender_window_passed", "type": null, "when": "31 December has passed; next year's fee is due." }, { "code": "entity_not_covered", "type": null, "when": "Not a covered entity." }, { "code": "director_not_verified", "type": null, "when": "Verification below identity_address or expired." } ] } }, "Params_ky_foundation_secretary_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foundation_company" ], "description": "Entity type." }, "incoming_secretary": { "type": "string", "pattern": "^per_", "description": "The new secretary: a qualified person, normally a CIMA-licensed service provider." }, "outgoing_secretary": { "type": "string", "pattern": "^per_", "description": "The current secretary on the register." }, "proposed_effective_date": { "type": "string", "format": "date", "description": "Intended date; in law the change takes effect only when the Registrar is notified, so Entiva files at once." }, "appointed_by": { "type": "string", "enum": [ "founder", "directors" ], "description": "Model articles: the founder by notice or the directors; a bespoke constitution may differ." }, "qualified_person_basis": { "type": "string", "enum": [ "company_manager_licence", "other_permitted_person" ], "description": "Why the incoming secretary is a qualified person." }, "cima_licence_number": { "type": "string", "description": "Licence number or exemption relied on; Entiva checks CIMA's register." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Required if the incoming secretary's business address differs; the registered office is that address." }, "reason_for_change": { "type": "string", "description": "Why the company changes provider; the incoming provider must ask." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "incoming_secretary", "outgoing_secretary", "proposed_effective_date", "appointed_by", "qualified_person_basis", "cima_licence_number", "reason_for_change" ], "description": "Replaces the qualified-person secretary of a foundation company and notifies the Registrar with the prescribed fee. The outgoing secretary stays in office until a qualified successor is appointed and notice is given (FCA s.16); the." }, "Create_ky_foundation_secretary_change": { "type": "object", "properties": { "type": { "const": "ky.foundation_secretary.change" }, "params": { "$ref": "#/components/schemas/Params_ky_foundation_secretary_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the secretary of a foundation company", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointing_instrument", "title": "Directors' resolution or founder's notice appointing the secretary", "source": "generated", "required": true }, { "key": "notice_of_change_of_secretary", "title": "Notice of change of secretary (FCA s.16)", "source": "generated", "required": true }, { "key": "secretary_consent_to_act", "title": "Incoming secretary's consent to act", "source": "generated", "required": true }, { "key": "cima_licence_evidence", "title": "Incoming secretary's CIMA licence or exemption evidence", "source": "uploaded", "required": true }, { "key": "outgoing_secretary_handover", "title": "Outgoing secretary's registers, BO data and CDD records", "source": "uploaded", "required": true }, { "key": "registered_office_notice", "title": "Notice of the situation of the new registered office", "source": "generated", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "founder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "appointing_instrument", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "appointing_instrument", "signer_role": "founder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_consent_to_act", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "notice_of_change_of_secretary", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_change_of_secretary", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of change of secretary with prescribed fee", "channel": "online", "government_fee": { "amount": 75, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "qualified_person_required", "type": null, "when": "Incoming secretary holds no CIMA Company Manager Licence or recognised exemption." }, { "code": "outgoing_secretary_not_found", "type": null, "when": "outgoing_secretary is not the secretary on the register." }, { "code": "handover_incomplete", "type": null, "when": "Outgoing secretary's registers and CDD records not received." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_general_partner_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp" ], "description": "Entity type." }, "incoming_gp": { "type": "string", "pattern": "^per_", "description": "Individual, company or registered partnership, created with POST /v1/people." }, "gp_type": { "type": "string", "enum": [ "individual", "company", "registered_partnership" ], "description": "Kind of GP (s.4, s.9)." }, "qualifying_basis": { "type": "string", "enum": [ "not_qualifying", "resident_individual", "cayman_company", "part9_foreign_company", "registered_partnership" ], "description": "Why the incoming GP meets s.4, or not_qualifying." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the arrangement; the 15 days run from it." }, "gp_address": { "$ref": "#/components/schemas/Address", "description": "Residential address or registered office for the statement." }, "signing_general_partner": { "type": "string", "pattern": "^per_", "description": "A GP who signs the statement: an existing GP, or the incoming GP once admitted." }, "adherence_method": { "type": "string", "enum": [ "deed_of_adherence", "signature_page", "accession_under_agreement_terms" ], "description": "How the incoming GP becomes bound (s.32)." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing GP replaced in the same statement; use it when that GP is the only or only qualifying GP." }, "pre_existing_debts_consents": { "type": "boolean", "description": "With replaces: written consents held for any release from earlier debts (s.10); otherwise the outgoing GP stays liable." }, "partnership_agreement_clause": { "type": "string", "description": "Clause under which the GP is admitted; the Act needs no limited partner consent, subject to the agreement (s.32)." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "incoming_gp", "gp_type", "qualifying_basis", "effective_date", "gp_address", "signing_general_partner", "adherence_method" ], "description": "Admits a general partner, or replaces one in the same statement, by a s.10 statement signed by a GP and filed within 15 days. Not effective until the Registrar has the statement." }, "Create_ky_general_partner_appoint": { "type": "object", "properties": { "type": { "const": "ky.general_partner.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_general_partner_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Admit or replace a general partner of an exempted limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_admission_instrument", "title": "Instrument admitting the general partner", "source": "generated", "required": true }, { "key": "s10_statement", "title": "Statement of change of general partner (ELP Act s.10)", "source": "generated", "required": true }, { "key": "gp_consent_to_act", "title": "Consent to act as general partner", "source": "generated", "required": true }, { "key": "deed_of_adherence", "title": "Incoming GP's adherence to the partnership agreement", "source": "generated", "required": true }, { "key": "passport", "title": "Individual GP: photo ID", "source": "uploaded", "required": false }, { "key": "proof_of_address", "title": "Individual GP: evidence of residential address", "source": "uploaded", "required": false }, { "key": "gp_entity_certificates", "title": "Corporate or partnership GP: certificate of incorporation or registration, and good standing", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "s10_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gp_admission_instrument", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "deed_of_adherence", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "deed_of_adherence", "signer_role": "general_partner", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "gp_consent_to_act", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "s10_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Statement of change of general partner", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "incoming_gp_documents_missing", "type": null, "when": "Documents s.9 requires for this kind of GP are missing." }, { "code": "gp_type_mismatch", "type": null, "when": "gp_type does not match the person record." }, { "code": "deadline_passed", "type": null, "when": "15-day period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_general_partner_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp" ], "description": "Entity type." }, "outgoing_gp": { "type": "string", "pattern": "^per_", "description": "The GP leaving." }, "reason": { "type": "string", "enum": [ "withdrawal", "removal_under_agreement", "dissolution_or_insolvency_of_gp", "death" ], "description": "Why the GP leaves under the partnership agreement." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the arrangement; the 15 days run from it." }, "signing_general_partner": { "type": "string", "pattern": "^per_", "description": "A continuing GP who signs the statement." }, "pre_existing_debts_consents": { "type": "boolean", "description": "True if written consents are held for any release from earlier debts (s.10); otherwise the GP stays liable." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "outgoing_gp", "reason", "effective_date", "signing_general_partner" ], "description": "Removes a general partner by a s.10 statement filed within 15 days. Not effective until filed; at least one GP, and one meeting s.4, must remain." }, "Create_ky_general_partner_remove": { "type": "object", "properties": { "type": { "const": "ky.general_partner.remove" }, "params": { "$ref": "#/components/schemas/Params_ky_general_partner_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a general partner of an exempted limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_removal_instrument", "title": "Withdrawal notice or instrument removing the GP", "source": "generated", "required": true }, { "key": "s10_statement", "title": "Statement of change of general partner (ELP Act s.10)", "source": "generated", "required": true }, { "key": "death_certificate", "title": "Certified death certificate", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "gp_removal_instrument", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s10_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s10_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Statement of change of general partner", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_general_partner_remaining", "type": null, "when": "Would leave no GP (s.4); use ky.general_partner.appoint with replaces." }, { "code": "no_qualifying_general_partner_remaining", "type": null, "when": "No continuing GP meets s.4; Entiva guard." }, { "code": "deadline_passed", "type": null, "when": "15-day period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_llc_manager_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc" ], "description": "Entity type." }, "appointee": { "type": "string", "pattern": "^per_", "description": "Individual, or corporate party." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "appointment_method": { "type": "string", "enum": [ "members_consent", "managers_consent", "llc_agreement_mechanism" ], "description": "How the LLC agreement appoints; written consents need no meeting (ss.19, 28)." }, "is_member": { "type": "boolean", "description": "True for a managing member (allowed if the LLC agreement permits, s.27-)." }, "register_address": { "$ref": "#/components/schemas/Address", "description": "Address on the register of managers." }, "acting_individuals": { "type": "array", "items": {}, "description": "Required for a corporate manager: person_ref of each acting individual." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing manager ended on effective_date in the same filing." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "appointee", "effective_date", "appointment_method", "register_address" ], "description": "Names a manager as the LLC agreement provides, updates the register of managers and files it with the Registrar within 30 days." }, "Create_ky_llc_manager_appoint": { "type": "object", "properties": { "type": { "const": "ky.llc_manager.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_manager_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an LLC manager", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "manager_consent", "title": "Written consent of members or managers appointing the manager", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act as manager", "source": "generated", "required": true }, { "key": "llc_agreement_extract", "title": "LLC agreement extract showing management powers", "source": "uploaded", "required": true }, { "key": "corporate_manager_documents", "title": "Corporate manager: incorporation and good standing certificates", "source": "uploaded", "required": false }, { "key": "register_of_managers", "title": "Updated register of managers", "source": "generated", "required": true } ], "people": [ { "role": "appointee", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "manager_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "register_of_managers", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_managers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of managers showing the appointment", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "appointee_not_verified", "type": null, "when": "Verification below identity_address or expired." }, { "code": "appointment_method_not_allowed", "type": null, "when": "The LLC agreement does not allow this method." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_llc_manager_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc" ], "description": "Entity type." }, "manager": { "type": "string", "pattern": "^per_", "description": "The outgoing manager." }, "reason": { "type": "string", "enum": [ "resignation", "removal", "ceased_under_llc_agreement", "death" ], "description": "Why office ends." }, "effective_date": { "type": "string", "format": "date", "description": "Date the office ends." }, "replacement_action_id": { "type": "string", "description": "act_ id of a ky.llc_manager.appoint action filed together with this one." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "manager", "reason", "effective_date" ], "description": "Ends a manager's office as the LLC agreement provides (s.27), updates the register of managers and files it with the Registrar within 30 days." }, "Create_ky_llc_manager_remove": { "type": "object", "properties": { "type": { "const": "ky.llc_manager.remove" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_manager_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove an LLC manager", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Resignation letter", "source": "generated", "required": false }, { "key": "manager_consent", "title": "Written consent removing the manager", "source": "generated", "required": false }, { "key": "death_certificate", "title": "Certified death certificate", "source": "uploaded", "required": false }, { "key": "register_of_managers", "title": "Updated register of managers", "source": "generated", "required": true } ], "people": [ { "role": "manager", "verification_level": "none" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "manager_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "register_of_managers", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_managers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of managers showing the cessation", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_manager_removal_blocked", "type": null, "when": "Would leave a manager-managed LLC with no manager and no replacement; Entiva guard, the LLC agreement decides." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_nominee_director_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "description": "Entity type." }, "position": { "type": "string", "enum": [ "director", "manager", "qualifying_general_partner" ], "description": "director: company or foundation company; manager: LLC; qualifying_general_partner: ELP (s.4)." }, "nominee": { "type": "string", "pattern": "^per_", "description": "The individual who serves; for a qualifying GP, the Cayman company or resident individual supplied." }, "provider_source": { "type": "string", "enum": [ "entiva_partner", "other_licensee" ], "description": "entiva_partner: Entiva's Entiva supplies; other_licensee: a third-party licensee." }, "provider": { "type": "string", "pattern": "^per_", "description": "Required for other_licensee: the providing company." }, "provider_licence_number": { "type": "string", "description": "Required for other_licensee: CIMA Company Manager Licence number, checked by Entiva." }, "instructing_parties": { "type": "array", "items": {}, "description": "person_ref of everyone on whose instructions the nominee acts; verified, and possibly beneficial owners." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "register_address": { "$ref": "#/components/schemas/Address", "description": "Address on the register, normally the provider's business address." }, "drla_registration_number": { "type": "string", "description": "Covered entity under the DRLA: the nominee's CIMA registration or licence number." }, "cima_approval_date": { "type": "string", "format": "date", "description": "CIMA-regulated entity needing approval: the approval date." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "position", "nominee", "provider_source", "instructing_parties", "effective_date", "register_address" ], "description": "Engages a CIMA-licensed provider to supply a nominee or professional director, manager or qualifying general partner, identifies who instructs the nominee, and runs the matching appointment filing. Cayman has no resident-director." }, "Create_ky_nominee_director_appoint": { "type": "object", "properties": { "type": { "const": "ky.nominee_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_nominee_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a nominee or professional director, manager or qualifying general partner", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nominee_services_agreement", "title": "Nominee or service agreement", "source": "uploaded", "required": true }, { "key": "provider_cima_licence", "title": "Provider's CIMA licence", "source": "uploaded", "required": false }, { "key": "appointment_resolution", "title": "Resolution, consent or statement appointing the nominee", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Nominee's consent to act", "source": "generated", "required": true }, { "key": "gp_entity_certificates", "title": "Qualifying GP that is a company: incorporation and good standing certificates", "source": "uploaded", "required": false }, { "key": "updated_register", "title": "Updated register of directors and officers, register of managers, or s.10 statement", "source": "generated", "required": true } ], "people": [ { "role": "nominee", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nominee_services_agreement", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nominee_services_agreement", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "nominee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "updated_register", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of directors and officers", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "position_not_valid_for_entity_type", "type": null, "when": "For example director on an LLC." }, { "code": "provider_not_licensed", "type": null, "when": "No valid CIMA Company Manager Licence for the provider." }, { "code": "instructing_parties_required", "type": null, "when": "No instructing party given." }, { "code": "drla_registration_required", "type": null, "when": "Covered entity and the nominee has no DRLA registration or licence." }, { "code": "no_qualifying_general_partner_after_change", "type": null, "when": "ELP: neither the nominee nor any other GP meets s.4." } ] } }, "Params_ky_register_of_directors_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type." }, "filing_reason": { "type": "string", "enum": [ "first_appointments", "change_of_particulars", "full_refresh", "correction" ], "description": "first_appointments: s.55. change_of_particulars: name or address change, s.55. full_refresh: re-file the whole register. correction: fix an earlier filing." }, "register_as_at": { "type": "string", "format": "date", "description": "Date to which the register is complete." }, "first_appointment_date": { "type": "string", "format": "date", "description": "Required for first_appointments: date of the first appointment; the 60 days run from the next day." }, "changes": { "type": "array", "items": {}, "description": "Required for change_of_particulars: [{person_id, field, old_value, new_value, effective_date}]." }, "correction_type": { "type": "string", "enum": [ "spelling_of_name_or_address", "wrong_office_or_date", "appointment_filed_in_error", "filed_before_effective_date" ], "description": "Required for correction." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." }, "cbp_principal": { "type": "string", "pattern": "^per_", "description": "Ordinary resident company without a licensed registered office: the CBP account holder." } }, "required": [ "entity_type", "filing_reason", "register_as_at" ], "description": "Files the register of directors, alternate directors and officers with the Registrar: the first copy within 60 days of the first appointment, name or address changes within 30 days, a full refresh, or a correction." }, "Create_ky_register_of_directors_file": { "type": "object", "properties": { "type": { "const": "ky.register_of_directors.file" }, "params": { "$ref": "#/components/schemas/Params_ky_register_of_directors_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the register of directors and officers", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_directors_and_officers", "title": "Register of directors and officers", "source": "generated", "required": true }, { "key": "correction_letter", "title": "Letter or resolution explaining the correction", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "General Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "register_of_directors_and_officers", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of directors and officers", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_empty", "type": null, "when": "No director or officer entries to file." }, { "code": "unfiled_changes_pending", "type": null, "when": "Open appointment or removal actions must finish first." }, { "code": "cbp_principal_required", "type": null, "when": "Ordinary resident company without the partner as registered office and no cbp_principal." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_register_of_managers_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc" ], "description": "Entity type." }, "filing_reason": { "type": "string", "enum": [ "first_filing", "change_of_particulars", "full_refresh", "correction" ], "description": "first_filing: within 60 days of the first appointment. change_of_particulars: name or address. full_refresh. correction." }, "register_as_at": { "type": "string", "format": "date", "description": "Date to which the register is complete." }, "first_appointment_date": { "type": "string", "format": "date", "description": "Required for first_filing." }, "changes": { "type": "array", "items": {}, "description": "Required for change_of_particulars: [{person_id, field, old_value, new_value, effective_date}]." }, "correction_type": { "type": "string", "enum": [ "spelling_of_name_or_address", "wrong_date", "appointment_filed_in_error" ], "description": "Required for correction." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." } }, "required": [ "entity_type", "filing_reason", "register_as_at" ], "description": "Files the LLC's register of managers with the Registrar: the first copy within 60 days of the first appointment, name or address changes within 30 days, a full refresh, or a correction." }, "Create_ky_register_of_managers_file": { "type": "object", "properties": { "type": { "const": "ky.register_of_managers.file" }, "params": { "$ref": "#/components/schemas/Params_ky_register_of_managers_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the register of managers", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_managers", "title": "Register of managers", "source": "generated", "required": true }, { "key": "correction_letter", "title": "Letter or resolution explaining the correction", "source": "uploaded", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "register_of_managers", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_managers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of managers", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_empty", "type": null, "when": "No manager entries; a member-managed LLC with no designated manager may have nothing to file." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_secretary_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type." }, "office": { "type": "string", "enum": [ "secretary", "assistant_secretary", "other_officer" ], "description": "Office to fill." }, "office_title": { "type": "string", "description": "Required for other_officer: title on the register, for example Chief Financial Officer." }, "appointee": { "type": "string", "pattern": "^per_", "description": "Individual, or corporate party." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "appointed_by": { "type": "string", "enum": [ "board", "members", "founder" ], "description": "Who appoints under the articles; founder only where a foundation constitution gives the power." }, "register_address": { "$ref": "#/components/schemas/Address", "description": "Address on the register." }, "acts_for_reward": { "type": "boolean", "description": "True if the appointee acts for profit or reward; that needs a CIMA Company Manager Licence." }, "cima_licence_number": { "type": "string", "description": "Required if acts_for_reward, and for every foundation company secretary." }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing holder of the same office, ended on effective_date in one filing." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." }, "cbp_principal": { "type": "string", "pattern": "^per_", "description": "Ordinary resident company without a licensed registered office: the CBP account holder." } }, "required": [ "entity_type", "office", "appointee", "effective_date", "appointed_by", "register_address", "acts_for_reward" ], "description": "Appoints a secretary, assistant secretary or other officer, updates the register of directors and officers and notifies the Registrar within 30 days. A secretary is optional except for a foundation company." }, "Create_ky_secretary_appoint": { "type": "object", "properties": { "type": { "const": "ky.secretary.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_secretary_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a company secretary or other officer", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution appointing the officer", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "cima_licence_evidence", "title": "CIMA licence evidence", "source": "uploaded", "required": false }, { "key": "register_of_directors_and_officers", "title": "Updated register of directors and officers", "source": "generated", "required": true } ], "people": [ { "role": "appointee", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "register_of_directors_and_officers", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of directors and officers showing the officer", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "licence_required_for_reward", "type": null, "when": "acts_for_reward and no valid CIMA Company Manager Licence found." }, { "code": "qualified_person_required", "type": null, "when": "Foundation company secretary is not a qualified person." }, { "code": "foundation_secretary_change_required", "type": null, "when": "Foundation company already has a secretary; use ky.foundation_secretary.change." }, { "code": "cbp_principal_required", "type": null, "when": "Ordinary resident company without the partner as registered office and no cbp_principal." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_secretary_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type." }, "officer": { "type": "string", "pattern": "^per_", "description": "The outgoing officer, as on the register." }, "office": { "type": "string", "enum": [ "secretary", "assistant_secretary", "other_officer" ], "description": "Office held." }, "reason": { "type": "string", "enum": [ "resignation", "removal", "death", "term_expired" ], "description": "Why office ends." }, "effective_date": { "type": "string", "format": "date", "description": "Date the office ends." }, "removed_by": { "type": "string", "enum": [ "board", "members", "founder" ], "description": "Required for removal." }, "replacement_action_id": { "type": "string", "description": "act_ id of a ky.secretary.appoint action filed together with this one." }, "express": { "type": "boolean", "description": "Pay the CI$150 express fee for same-day completion." }, "acknowledge_late_penalty": { "type": "boolean", "description": "True to file late and accept the penalty." }, "cbp_principal": { "type": "string", "pattern": "^per_", "description": "Ordinary resident company without a licensed registered office: the CBP account holder." } }, "required": [ "entity_type", "officer", "office", "reason", "effective_date" ], "description": "Ends the office of a secretary, assistant secretary or other officer, updates the register and notifies the Registrar within 30 days. A foundation company's secretary must be replaced, not removed." }, "Create_ky_secretary_remove": { "type": "object", "properties": { "type": { "const": "ky.secretary.remove" }, "params": { "$ref": "#/components/schemas/Params_ky_secretary_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a company secretary or other officer", "x-entiva": { "jurisdiction": "ky", "stage": "officers_and_people", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Resignation letter", "source": "generated", "required": false }, { "key": "removal_resolution", "title": "Resolution removing the officer", "source": "generated", "required": false }, { "key": "death_certificate", "title": "Certified death certificate", "source": "uploaded", "required": false }, { "key": "register_of_directors_and_officers", "title": "Updated register of directors and officers", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resignation_letter", "signer_role": "officer", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "removal_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "register_of_directors_and_officers", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Register of directors and officers showing the cessation", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "foundation_secretary_replacement_required", "type": null, "when": "Foundation company secretary stays in office until a qualified successor is appointed and the Registrar notified (FCA s.16); use ky.foundation_secretary.change." }, { "code": "resignation_letter_required", "type": null, "when": "Resignation without a signed letter." }, { "code": "cbp_principal_required", "type": null, "when": "Ordinary resident company without the partner as registered office and no cbp_principal." }, { "code": "deadline_passed", "type": null, "when": "Statutory period over; resubmit with acknowledge_late_penalty=true." } ] } }, "Params_ky_elp_interest_transfer": { "type": "object", "properties": { "transferor": { "type": "string", "pattern": "^per_", "description": "Transferring partner." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Individual or legal person." }, "interest_type": { "type": "string", "enum": [ "limited", "general" ], "description": "general also needs a s.10 statement." }, "interest_scope": { "type": "string", "enum": [ "whole", "part" ], "description": "whole or part." }, "interest_percentage": { "type": "number", "description": "Percentage of the partnership interest." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Zero for a gift." }, "gp_consent_obtained": { "type": "boolean", "description": "Written consent of a general partner, before or with the transfer (s.32-)." }, "agreement_conditions_met": { "type": "boolean", "description": "Admission conditions in the agreement met or waived (s.32)." }, "economic_rights_only": { "type": "boolean", "description": "Assignment of economic rights only (s.32-)." }, "transferee_qualifies_as_cayman_gp": { "type": "boolean", "description": "general: needed if it will be the only qualifying GP (s.4)." }, "effective_date": { "type": "string", "format": "date", "description": "General interests take effect only once the s.10 statement is filed." } }, "required": [ "transferor", "transferee", "interest_type", "interest_scope", "interest_percentage", "gp_consent_obtained", "agreement_conditions_met", "effective_date" ], "description": "Transfer a limited or general partnership interest in an ELP; a general-partner transfer also needs a s.10 statement within 15 days." }, "Create_ky_elp_interest_transfer": { "type": "object", "properties": { "type": { "const": "ky.elp_interest.transfer" }, "params": { "$ref": "#/components/schemas/Params_ky_elp_interest_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer partnership interests in an ELP", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "transfer_instrument", "title": "Transfer and adherence instrument", "source": "generated", "required": true }, { "key": "gp_consent", "title": "General partner's written consent", "source": "generated", "required": true }, { "key": "updated_register_of_limited_partners", "title": "Register of limited partners and contribution record", "source": "generated", "required": true }, { "key": "s10_statement", "title": "Section 10 statement", "source": "generated", "required": false }, { "key": "gp_evidence", "title": "Incoming GP: incorporation and good standing, or photo ID and Cayman address (s.9)", "source": "uploaded", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "sole", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "transfer_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "transfer_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gp_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "s10_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s10_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Section 10", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "gp_consent_missing", "type": null, "when": "No general partner consent is recorded (s.32-)." }, { "code": "no_qualifying_cayman_gp", "type": null, "when": "The transfer would leave no GP meeting s.4." }, { "code": "gp_statement_not_filed", "type": null, "when": "A general interest's effective_date precedes the s.10 filing." } ] } }, "Params_ky_llc_interest_transfer": { "type": "object", "properties": { "transferor": { "type": "string", "pattern": "^per_", "description": "Transferring member." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Individual or legal person." }, "interest_scope": { "type": "string", "enum": [ "whole", "part" ], "description": "whole or part." }, "interest_percentage": { "type": "number", "description": "Percentage of total interests transferred." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Zero for a gift." }, "admit_as_member": { "type": "boolean", "description": "False assigns economic rights only (s.11)." }, "agreement_permits_transfer": { "type": "boolean", "description": "The LLC agreement permits it (s.11); admission conditions met or waived." }, "all_member_approval_obtained": { "type": "boolean", "description": "Admission approval if the agreement is silent (s.12)." }, "effective_date": { "type": "string", "format": "date", "description": "Date of admission or assignment." } }, "required": [ "transferor", "transferee", "interest_scope", "interest_percentage", "admit_as_member", "agreement_permits_transfer", "effective_date" ], "description": "Transfer an LLC interest and admit the assignee; register updated within 21 days. No Registrar filing." }, "Create_ky_llc_interest_transfer": { "type": "object", "properties": { "type": { "const": "ky.llc_interest.transfer" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_interest_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer LLC interests", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "llc_agreement", "title": "LLC agreement", "source": "uploaded", "required": true }, { "key": "transfer_instrument", "title": "Instrument of transfer", "source": "generated", "required": true }, { "key": "member_consent", "title": "Members' consent to admission", "source": "generated", "required": false }, { "key": "manager_acknowledgement", "title": "Manager's acknowledgement and register instruction", "source": "generated", "required": true }, { "key": "certificate_of_llc_interest", "title": "Certificate of LLC interest (s.10)", "source": "generated", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "transfer_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "transfer_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "member_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "manager_acknowledgement", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_llc_interest", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "transfer_not_permitted_by_agreement", "type": null, "when": "The LLC agreement does not permit it and no all-member approval is recorded." }, { "code": "insufficient_interest", "type": null, "when": "The transferor holds less than interest_percentage." }, { "code": "transferee_verification_incomplete", "type": null, "when": "" } ] } }, "Params_ky_lp_interest_transfer": { "type": "object", "properties": { "transferor": { "type": "string", "pattern": "^per_", "description": "Assigning limited partner." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Individual or legal person." }, "contribution_transferred": { "$ref": "#/components/schemas/Money", "description": "Contribution the assignee takes over (s.51)." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref of every general partner; all make the declaration." }, "gp_consent_obtained": { "type": "boolean", "description": "Consent of the general partners (s.52)." }, "effective_date": { "type": "string", "format": "date", "description": "Starts the 7-day clock." } }, "required": [ "transferor", "transferee", "contribution_transferred", "general_partners", "gp_consent_obtained", "effective_date" ], "description": "Assign a limited partner's share (Partnership Act s.52): GP declaration within 7 days and Gazette notice." }, "Create_ky_lp_interest_transfer": { "type": "object", "properties": { "type": { "const": "ky.lp_interest.transfer" }, "params": { "$ref": "#/components/schemas/Params_ky_lp_interest_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Assign a limited partner's share in a Partnership Act LP", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "assignment_instrument", "title": "Instrument of assignment", "source": "generated", "required": true }, { "key": "gp_consent", "title": "General partners' consent", "source": "generated", "required": true }, { "key": "change_declaration", "title": "Declaration of change, Voluntary Declarations Act", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Notice for the Gazette", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry record of the declaration", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "assignment_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "assignment_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gp_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "change_declaration", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "gazette_notice", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Declaration", "channel": "paper", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "gp_consent_missing", "type": null, "when": "General partners' consent not recorded." }, { "code": "seven_day_window_at_risk", "type": null, "when": "A general partner cannot appear before a JP or notary within 7 days." }, { "code": "gazette_not_advertised", "type": null, "when": "No Gazette advertisement; the assignment has no effect." } ] } }, "Params_ky_minority_shares_acquire": { "type": "object", "properties": { "entity_role": { "type": "string", "enum": [ "transferor_company", "transferee_company" ], "description": "The entity is the target or the offeror." }, "counterparty": { "type": "object", "description": "{name, registration_number, jurisdiction}." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class or LLC interest under offer." }, "offer_date": { "type": "string", "format": "date", "description": "LLC: the 4-month approval window starts here." }, "approval_date": { "type": "string", "format": "date", "description": "Date holders of at least 90% in value approved." }, "approval_percentage": { "type": "number", "description": "At least 90." }, "offer_terms": { "type": "object", "description": "{price_per_share: money, consideration_form}; dissenters get the same terms." }, "dissenting_holders": { "type": "array", "items": {}, "description": "person_ref of each dissenting holder or member." }, "notice_date": { "type": "string", "format": "date", "description": "Notice in the prescribed manner; the 1-month dissent window runs from it." }, "trust_account_reference": { "type": "string", "description": "Separate account holding the consideration on trust (s.88; LLC s.44)." } }, "required": [ "entity_role", "counterparty", "share_class", "offer_date", "approval_date", "approval_percentage", "offer_terms", "dissenting_holders" ], "description": "Compulsorily acquire dissenting minority shares or LLC interests after a 90% offer." }, "Create_ky_minority_shares_acquire": { "type": "object", "properties": { "type": { "const": "ky.minority_shares.acquire" }, "params": { "$ref": "#/components/schemas/Params_ky_minority_shares_acquire" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Compulsorily acquire minority shares after a 90% offer", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "offer_document", "title": "Offer document", "source": "uploaded", "required": true }, { "key": "approval_evidence", "title": "Evidence of acceptances at the threshold", "source": "uploaded", "required": true }, { "key": "compulsory_acquisition_notice", "title": "Notice to dissenting holders", "source": "generated", "required": true }, { "key": "proof_of_service", "title": "Proof the notice was given", "source": "uploaded", "required": true }, { "key": "no_application_confirmation", "title": "Counsel's confirmation of no Court application within a month, or the order", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board or manager decisions of transferee and transferor", "source": "generated", "required": true }, { "key": "consideration_receipt", "title": "Evidence the consideration is held on trust by the transferor", "source": "uploaded", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "compulsory_acquisition_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Notice to dissenting holders in the prescribed manner", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "approval_threshold_not_met", "type": null, "when": "approval_percentage is below 90%." }, { "code": "notice_window_invalid", "type": null, "when": "notice_date is outside the window for the entity type." }, { "code": "dissent_application_pending", "type": null, "when": "A dissenter applied to the Court; completion is paused." }, { "code": "provision_disapplied", "type": null, "when": "The LLC agreement disapplies s.44 (s.44)." } ] } }, "Params_ky_resident_company_share_transfer": { "type": "object", "properties": { "transferor": { "type": "string", "pattern": "^per_", "description": "Registered holder." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Individual or legal person." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class transferred." }, "number_of_shares": { "type": "integer", "description": "Number of shares." }, "transfer_type": { "type": "string", "enum": [ "sale", "gift", "intra_group", "enforcement_of_security", "personal_representative" ], "description": "Nature of the transfer." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "The Registry form states it in words and figures; zero for a gift." }, "effective_date": { "type": "string", "format": "date", "description": "Entry on the register." }, "transferor_caymanian": { "type": "boolean", "description": "The instrument must state it (LCCA s.8)." }, "transferee_caymanian": { "type": "boolean", "description": "The instrument must state it (LCCA s.8)." }, "non_caymanian_percent_after": { "type": "number", "description": "Computed; above 40% needs prior Board consent (LCCA s.8)." }, "tbl_licence_holder": { "type": "boolean", "description": "A 10%+ interest may need prior Board approval." }, "holds_cayman_land": { "type": "boolean", "description": "True routes to counsel." }, "eft_confirmation_reference": { "type": "string", "description": "Registry confirmation-of-funds reference." } }, "required": [ "transferor", "transferee", "share_class", "number_of_shares", "transfer_type", "consideration", "effective_date", "transferor_caymanian", "transferee_caymanian", "holds_cayman_land" ], "description": "Transfer shares of an ordinary resident company: witnessed Registry form emailed to the General Registry, LCCA return within 21 days, register update." }, "Create_ky_resident_company_share_transfer": { "type": "object", "properties": { "type": { "const": "ky.resident_company_share.transfer" }, "params": { "$ref": "#/components/schemas/Params_ky_resident_company_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer shares of an ordinary resident company", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "ordinary_resident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registry_transfer_form", "title": "Registry form 'Assignment and Transfer of Share Certificate'", "source": "generated", "required": true }, { "key": "register_of_shareholders", "title": "Register of shareholders", "source": "generated", "required": true }, { "key": "transferee_id_documents", "title": "Photo ID of each new shareholder; corporate: good standing within 30 days", "source": "uploaded", "required": true }, { "key": "eft_confirmation", "title": "Registry confirmation of funds by EFT", "source": "uploaded", "required": true }, { "key": "lcca_return", "title": "LCCA return to the Trade and Business Licensing Board (s.7)", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board approval, if the articles require it", "source": "generated", "required": false }, { "key": "lcca_board_consent", "title": "Board's written consent above 40% non-Caymanian ownership", "source": "uploaded", "required": false }, { "key": "registry_filing_package", "title": "Package emailed to grmanual@gov.ky with written authorisation", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "percent": 40, "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "registry_transfer_form", "signer_role": "shareholder", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registry_transfer_form", "signer_role": "shareholder", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lcca_return", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_filing_package", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry, manual filing", "form": "Registry transfer form with register of shareholders, EFT form and ID", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "caymanian_status_not_stated", "type": null, "when": "A Caymanian flag is missing (LCCA s.8)." }, { "code": "non_caymanian_cap_exceeded", "type": null, "when": "Over 40% non-Caymanian with no Board consent uploaded." }, { "code": "witness_missing", "type": null, "when": "The Registry form is not witnessed by a notary or JP." }, { "code": "expired_id", "type": null, "when": "A new shareholder's ID is expired." } ] } }, "Params_ky_share_allot": { "type": "object", "properties": { "allotments": { "type": "array", "items": {}, "description": "[{allottee_id, share_class, number_of_shares, price_per_share, paid_up, allottee_caymanian}]." }, "allotment_type": { "type": "string", "enum": [ "subscription", "option_exercise", "bonus_issue", "conversion", "non_cash_consideration" ], "description": "Basis of the issue." }, "allotment_date": { "type": "string", "format": "date", "description": "Date of allotment." }, "pre_emption_waived": { "type": "boolean", "description": "Table A reg 34 pro rata offer waived or inapplicable." }, "option_plan_reference": { "type": "string", "description": "For option_exercise." }, "discount_court_order_reference": { "type": "string", "description": "Issue below par needs Court sanction; not for no-par shares." }, "carries_on_business_in_islands": { "type": "boolean", "description": "Exempted company licensed to trade locally: LCCA ss.7, 8 apply." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "allotments", "allotment_type", "allotment_date" ], "description": "Allot shares within authorised capital, including option exercises and bonus issues. No filing unless capital must first be increased." }, "Create_ky_share_allot": { "type": "object", "properties": { "type": { "const": "ky.share.allot" }, "params": { "$ref": "#/components/schemas/Params_ky_share_allot" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Allot or issue shares", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution allotting the shares", "source": "generated", "required": true }, { "key": "subscription_application", "title": "Application or subscription agreement (local companies state Caymanian status, LCCA s.8)", "source": "generated", "required": true }, { "key": "payment_evidence", "title": "Evidence of subscription funds", "source": "uploaded", "required": true }, { "key": "share_certificates", "title": "Share certificates", "source": "generated", "required": true }, { "key": "lcca_return", "title": "LCCA return (s.7)", "source": "generated", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "subscription_application", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_certificates", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lcca_return", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorised_capital_exceeded", "type": null, "when": "Allotment exceeds unissued authorised capital; run ky.share_capital.increase." }, { "code": "discount_requires_court_sanction", "type": null, "when": "Price is below par without a Court order." }, { "code": "pre_emption_rights_outstanding", "type": null, "when": "The articles or Table A reg 34 require an unwaived offer to members." }, { "code": "non_caymanian_cap_exceeded", "type": null, "when": "A local company would pass 40% non-Caymanian without Board consent." } ] } }, "Params_ky_share_redeem": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "redemption", "repurchase", "surrender" ], "description": "redemption (s.37), repurchase (s.37) or surrender for no consideration." }, "member": { "type": "string", "pattern": "^per_", "description": "Selling or surrendering member; the payee is screened." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class affected." }, "number_of_shares": { "type": "integer", "description": "Number of shares." }, "price_per_share": { "$ref": "#/components/schemas/Money", "description": "Including premium; zero for surrender." }, "shares_fully_paid": { "type": "boolean", "description": "Only fully paid shares qualify (ss.37, 37B)." }, "authority_basis": { "type": "string", "enum": [ "articles", "members_resolution", "directors_delegated" ], "description": "Who fixes manner and terms (s.37-); surrender: the articles permit it." }, "treatment": { "type": "string", "enum": [ "cancel", "hold_as_treasury" ], "description": "cancel (s.37) or hold_as_treasury." }, "funding_source": { "type": "string", "enum": [ "profits", "share_premium", "fresh_issue_proceeds", "capital", "mixed" ], "description": "Not for surrender (s.37,)." }, "capital_payment_amount": { "$ref": "#/components/schemas/Money", "description": "Part paid out of capital; needs the directors' solvency determination (s.37)." }, "completion_date": { "type": "string", "format": "date", "description": "Date of payment or acceptance." } }, "required": [ "mode", "member", "share_class", "number_of_shares", "price_per_share", "shares_fully_paid", "authority_basis", "treatment", "completion_date" ], "description": "Redeem or repurchase shares or accept a surrender for no consideration; cancel or hold as treasury. No filing." }, "Create_ky_share_redeem": { "type": "object", "properties": { "type": { "const": "ky.share.redeem" }, "params": { "$ref": "#/components/schemas/Params_ky_share_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redeem, repurchase or accept surrender of shares", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution fixing terms or accepting the surrender", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution on manner and terms (s.37)", "source": "generated", "required": false }, { "key": "share_instrument", "title": "Redemption notice, purchase agreement or surrender instrument", "source": "generated", "required": true }, { "key": "capital_payment_determination", "title": "Directors' solvency determination for a capital payment", "source": "generated", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "capital_payment_determination", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "share_instrument", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_instrument", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "shares_not_fully_paid", "type": null, "when": "Any share is not fully paid." }, { "code": "would_leave_no_issued_shares", "type": null, "when": "Only treasury shares would remain (ss.37, 37B)." }, { "code": "treasury_not_permitted", "type": null, "when": "hold_as_treasury but the articles prohibit it or authority is missing (s.37A)." } ] } }, "Params_ky_share_transfer": { "type": "object", "properties": { "transferor": { "type": "string", "pattern": "^per_", "description": "Registered holder." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Individual or legal person, created with POST /v1/people." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class transferred." }, "number_of_shares": { "type": "integer", "description": "Number of shares." }, "transfer_type": { "type": "string", "enum": [ "sale", "gift", "intra_group", "enforcement_of_security", "personal_representative" ], "description": "personal_representative uses s.39." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Zero for a gift." }, "effective_date": { "type": "string", "format": "date", "description": "Entry on the register; the transferor stays holder until then." }, "holds_cayman_land": { "type": "boolean", "description": "True routes to counsel." }, "carries_on_business_in_islands": { "type": "boolean", "description": "Exempted company licensed to trade locally: LCCA ss.7, 8 apply." }, "transferor_caymanian": { "type": "boolean", "description": "Required if carries_on_business_in_islands (LCCA s.8)." }, "transferee_caymanian": { "type": "boolean", "description": "Required if carries_on_business_in_islands." }, "is_cima_licensee": { "type": "boolean", "description": "CIMA licensee: change of control may need CIMA approval or notice." } }, "required": [ "transferor", "transferee", "share_class", "number_of_shares", "transfer_type", "effective_date", "holds_cayman_land" ], "description": "Transfer shares of an exempted, LDC, SPC, SEZC or non-resident company: instrument, board approval if needed, register entry. No filing." }, "Create_ky_share_transfer": { "type": "object", "properties": { "type": { "const": "ky.share.transfer" }, "params": { "$ref": "#/components/schemas/Params_ky_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer shares", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "instrument_of_transfer", "title": "Instrument of transfer", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board approval, if the articles require it", "source": "generated", "required": false }, { "key": "lcca_return", "title": "Return to the Trade and Business Licensing Board (LCCA s.7)", "source": "generated", "required": false }, { "key": "cima_approval", "title": "CIMA approval or notice", "source": "uploaded", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "instrument_of_transfer", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "instrument_of_transfer", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lcca_return", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insufficient_shares_held", "type": null, "when": "The transferor holds fewer shares than number_of_shares." }, { "code": "transfer_restricted_by_articles", "type": null, "when": "The articles bar the transfer or a pre-emption right is unwaived." }, { "code": "land_holding_company_requires_counsel", "type": null, "when": "holds_cayman_land is true." } ] } }, "Params_ky_share_capital_change": { "type": "object", "properties": { "alteration": { "type": "string", "enum": [ "consolidate", "subdivide", "convert_to_stock", "reconvert_stock", "cancel_unissued" ], "description": "s.13 power: consolidate, convert_to_stock or reconvert_stock, subdivide, cancel_unissued." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class affected." }, "share_denomination": { "type": "string", "enum": [ "par_value", "no_par_value" ], "description": "par_value except cancel_unissued: s.13 excludes no-par shares from-." }, "ratio": { "type": "string", "description": "consolidate or subdivide: old:new, e.g. 10:1." }, "par_value": { "$ref": "#/components/schemas/Money", "description": "consolidate, subdivide, reconvert_stock." }, "shares_affected": { "type": "integer", "description": "Shares converted, or unissued shares cancelled." }, "stock_amount": { "$ref": "#/components/schemas/Money", "description": "Stock conversions: nominal amount." }, "fraction_treatment": { "type": "string", "enum": [ "issue_fractional_shares", "round_down_pay_cash", "round_up_from_reserves" ], "description": "consolidate: as the articles allow (s.33)." }, "resulting_authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Authorised capital afterwards." }, "resulting_authorised_shares": { "type": "integer", "description": "Authorised shares of the class afterwards." }, "resulting_issued_shares": { "type": "integer", "description": "Issued shares of the class afterwards." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members' resolution passed." }, "articles_authorise_alteration": { "type": "boolean", "description": "The articles authorise it (s.13)." } }, "required": [ "alteration", "share_class", "share_denomination", "resulting_authorised_capital", "resulting_authorised_shares", "resulting_issued_shares", "resolution_date", "articles_authorise_alteration" ], "description": "Consolidate, subdivide, convert to stock or cancel unissued shares by members' resolution; the resolution is filed." }, "Create_ky_share_capital_change": { "type": "object", "properties": { "type": { "const": "ky.share_capital.change" }, "params": { "$ref": "#/components/schemas/Params_ky_share_capital_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Consolidate, subdivide, convert to stock or cancel unissued shares", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution proposing the alteration", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution (s.13)", "source": "generated", "required": true }, { "key": "resolution_for_filing", "title": "Resolution stating current capital, means of change, resulting capital", "source": "generated", "required": true }, { "key": "director_filing_authorisation", "title": "Director's authentication", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "director_filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resolution_for_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Resolution altering share capital, filed as 'any other document'", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "articles_do_not_authorise_alteration", "type": null, "when": "The articles do not authorise it (s.13)." }, { "code": "alteration_not_available_for_no_par_shares", "type": null, "when": "consolidate, subdivide or stock conversion on no-par shares (s.13)." }, { "code": "shares_already_issued", "type": null, "when": "cancel_unissued would cancel issued or agreed shares." } ] } }, "Params_ky_share_capital_increase": { "type": "object", "properties": { "increase_kind": { "type": "string", "enum": [ "share_capital", "member_number" ], "description": "share_capital, or member_number for a company with no share capital (s.45)." }, "share_denomination": { "type": "string", "enum": [ "par_value", "no_par_value" ], "description": "no_par: increase the shares or aggregate consideration (s.13 proviso)." }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Par value: capital after the increase; must exceed the registered capital." }, "additional_shares": { "type": "array", "items": {}, "description": "[{share_class, number_of_shares, par_value}]." }, "aggregate_consideration": { "$ref": "#/components/schemas/Money", "description": "No-par only." }, "registered_members": { "type": "integer", "description": "member_number only." }, "resolution_date": { "type": "string", "format": "date", "description": "Starts the 30-day clock." }, "resolution_type": { "type": "string", "enum": [ "ordinary", "special" ], "description": "ordinary unless the articles require special." }, "articles_authorise_increase": { "type": "boolean", "description": "The articles authorise an increase (s.13)." }, "memorandum_authorises_alteration": { "type": "boolean", "description": "Foundation company only (FCA s.9)." }, "acknowledge_late_filing": { "type": "boolean", "description": "Needed if over 30 days since the resolution." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "share_denomination", "resolution_date", "resolution_type", "articles_authorise_increase" ], "description": "Increase authorised share capital by members' resolution, then notify the Registrar within 30 days (Companies Act ss.13, 45)." }, "Create_ky_share_capital_increase": { "type": "object", "properties": { "type": { "const": "ky.share_capital.increase" }, "params": { "$ref": "#/components/schemas/Params_ky_share_capital_increase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Increase authorised share capital", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution proposing the increase", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution (s.13)", "source": "generated", "required": true }, { "key": "notice_of_increase_of_capital", "title": "Notice of increase of capital", "source": "generated", "required": true }, { "key": "director_filing_authorisation", "title": "Director's authentication", "source": "generated", "required": true }, { "key": "amended_memorandum", "title": "Memorandum with restated capital clause", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "director_filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_increase_of_capital", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of increase of capital", "channel": "online", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "articles_do_not_authorise_increase", "type": null, "when": "The articles do not authorise an increase (s.13)." }, { "code": "new_capital_not_greater", "type": null, "when": "new_authorised_capital is not above the registered capital." }, { "code": "late_filing_acknowledgement_required", "type": null, "when": "Over 30 days since the resolution and acknowledge_late_filing is not true." } ] } }, "Params_ky_share_capital_reduce": { "type": "object", "properties": { "reduction_purpose": { "type": "string", "enum": [ "cancel_lost_or_unrepresented_capital", "return_excess_capital", "extinguish_uncalled_liability", "other" ], "description": "Purpose per s.14." }, "reduction_amount": { "$ref": "#/components/schemas/Money", "description": "Amount of the reduction." }, "resulting_capital": { "type": "object", "description": "s.14B minute: {share_capital, number_of_shares, amount_per_share, paid_up_per_share}." }, "payment_to_members": { "$ref": "#/components/schemas/Money", "description": "Cash returned, if any." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Starts the 15-day clock." }, "solvency_statement_date": { "type": "string", "format": "date", "description": "No more than 30 days before the resolution (s.14A)." }, "signing_directors": { "type": "array", "items": {}, "description": "person_ref of every director making the statement." }, "articles_authorise_reduction": { "type": "boolean", "description": "The articles authorise a reduction (s.14)." }, "acknowledge_effective_on_registration": { "type": "boolean", "description": "No effect until registered (s.14B)." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "reduction_purpose", "reduction_amount", "resulting_capital", "special_resolution_date", "solvency_statement_date", "signing_directors", "articles_authorise_reduction", "acknowledge_effective_on_registration" ], "description": "Reduce a solvent company's capital without the court: directors' solvency statement, special resolution, then filing within 15 days." }, "Create_ky_share_capital_reduce": { "type": "object", "properties": { "type": { "const": "ky.share_capital.reduce" }, "params": { "$ref": "#/components/schemas/Params_ky_share_capital_reduce" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reduce share capital by solvency statement", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "solvency_support_pack", "title": "Management accounts and creditor list behind the enquiry", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the statement", "source": "generated", "required": true }, { "key": "solvency_statement", "title": "Solvency statement", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution for reducing share capital", "source": "generated", "required": true }, { "key": "minute_of_reduction", "title": "Minute of reduction (s.14B)", "source": "generated", "required": true }, { "key": "director_filing_authorisation", "title": "Director's authentication", "source": "generated", "required": true }, { "key": "registrar_certificate", "title": "Registrar's certificate (s.14B)", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "solvency_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "director_filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "minute_of_reduction", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Copy of solvency statement and minute", "channel": "online", "government_fee": { "amount": 350, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "solvency_statement_out_of_window", "type": null, "when": "The statement is dated over 30 days before, or after, the special resolution." }, { "code": "filing_window_missed", "type": null, "when": "Over 15 days since the resolution; use ky.share_capital.reduce_court." }, { "code": "articles_do_not_authorise_reduction", "type": null, "when": "The articles do not authorise a reduction (s.14)." } ] } }, "Params_ky_share_capital_reduce_court": { "type": "object", "properties": { "reduction_purpose": { "type": "string", "enum": [ "cancel_lost_or_unrepresented_capital", "return_excess_capital", "extinguish_uncalled_liability", "other" ], "description": "Purpose per s.14." }, "reduction_amount": { "$ref": "#/components/schemas/Money", "description": "Amount of the reduction." }, "resulting_capital": { "type": "object", "description": "s.17 minute: {share_capital, number_of_shares, amount_per_share, paid_up_per_share}." }, "involves_repayment_or_liability_reduction": { "type": "boolean", "description": "True triggers the creditor list and objections (s.15)." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution passed." }, "articles_authorise_reduction": { "type": "boolean", "description": "The articles authorise a reduction (s.14)." }, "instructed_counsel": { "type": "string", "description": "Cayman attorney-at-law; defaults to panel counsel." }, "court_order_date": { "type": "string", "format": "date", "description": "Supply once confirmed, to trigger the Registry filing." }, "court_order_reference": { "type": "string", "description": "Cause number or order reference." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "reduction_purpose", "reduction_amount", "resulting_capital", "involves_repayment_or_liability_reduction", "special_resolution_date", "articles_authorise_reduction" ], "description": "Reduce capital by special resolution confirmed by the Grand Court; effective when the order and minute are registered." }, "Create_ky_share_capital_reduce_court": { "type": "object", "properties": { "type": { "const": "ky.share_capital.reduce_court" }, "params": { "$ref": "#/components/schemas/Params_ky_share_capital_reduce_court" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reduce share capital with Grand Court confirmation", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution instructing counsel", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution for reducing share capital", "source": "generated", "required": true }, { "key": "creditor_list", "title": "Creditors and amounts", "source": "uploaded", "required": false }, { "key": "petition_and_affidavit", "title": "Petition (s.15) and affidavit", "source": "generated", "required": true }, { "key": "court_order", "title": "Order and Court-approved minute", "source": "uploaded", "required": true }, { "key": "director_filing_authorisation", "title": "Director's authentication", "source": "generated", "required": true }, { "key": "registrar_certificate", "title": "Registrar's certificate (s.17)", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "petition_and_affidavit", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "petition_and_affidavit", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_filing_authorisation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_order", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Grand Court", "form": "Petition under s.15", "channel": "online", "government_fee": { "amount": 350, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "counsel_not_instructed", "type": null, "when": "No Cayman counsel has accepted the engagement." }, { "code": "creditor_list_missing", "type": null, "when": "involves_repayment_or_liability_reduction is true and no creditor list is uploaded." }, { "code": "articles_do_not_authorise_reduction", "type": null, "when": "The articles do not authorise a reduction (s.14)." } ] } }, "Params_ky_treasury_share_dispose": { "type": "object", "properties": { "disposal": { "type": "string", "enum": [ "cancel", "transfer" ], "description": "cancel (s.37A) or transfer (s.37A)." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class of treasury shares." }, "number_of_shares": { "type": "integer", "description": "Treasury shares disposed of." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Required for transfer." }, "transfer_consideration": { "$ref": "#/components/schemas/Money", "description": "May be zero or below par." }, "proceeds_allocation": { "type": "string", "enum": [ "statutory", "directors_determination" ], "description": "statutory (s.37A) or directors_determination (s.37A, needs a solvency determination)." }, "transferee_caymanian": { "type": "boolean", "description": "Ordinary resident companies: instrument must state it (LCCA s.8)." }, "effective_date": { "type": "string", "format": "date", "description": "Date of cancellation or transfer." } }, "required": [ "disposal", "share_class", "number_of_shares", "effective_date" ], "description": "Cancel treasury shares or transfer them to anyone, with or without consideration (Companies Act s.37A). No Registrar filing." }, "Create_ky_treasury_share_dispose": { "type": "object", "properties": { "type": { "const": "ky.treasury_share.dispose" }, "params": { "$ref": "#/components/schemas/Params_ky_treasury_share_dispose" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel or transfer treasury shares", "x-entiva": { "jurisdiction": "ky", "stage": "ownership_and_capital", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution", "source": "generated", "required": true }, { "key": "transfer_instrument", "title": "Share transfer instrument", "source": "generated", "required": false }, { "key": "lcca_return", "title": "Return to the Trade and Business Licensing Board (LCCA s.7)", "source": "generated", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "transfer_instrument", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "transfer_instrument", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lcca_return", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insufficient_treasury_shares", "type": null, "when": "number_of_shares exceeds the treasury holding." }, { "code": "transferee_required", "type": null, "when": "disposal is transfer without transferee_id." }, { "code": "solvency_determination_missing", "type": null, "when": "directors_determination chosen without a determination (s.37A)." } ] } }, "Params_ky_constitution_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type of the company, including foundation companies." }, "amendment_target": { "type": "string", "enum": [ "memorandum", "articles", "memorandum_and_articles" ], "description": "memorandum: alter objects, powers or other matters in the memorandum. articles: alter or add to the articles. memorandum_and_articles: both, in one resolution." }, "amendment_summary": { "type": "string", "description": "Plain-language description of what changes, clause by clause." }, "amended_document": { "type": "string", "pattern": "^doc_", "description": "Your own amended or restated memorandum and/or articles." }, "approval_method": { "type": "string", "enum": [ "members_meeting", "members_written_resolution", "foundation_constitutional_process" ], "description": "members_meeting or members_written_resolution: special resolution under s.60 or. foundation_constitutional_process: for a foundation company, the process its." }, "foundation_authorising_provision": { "type": "string", "description": "Required for foundation_company." }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the amendment takes effect, if later than the resolution date." }, "cima_regulated": { "type": "boolean", "description": "True if the company is registered or licensed with CIMA." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "amendment_target", "amendment_summary", "approval_method" ], "description": "Members alter the memorandum or articles by special resolution, and a copy is filed with the Registrar through the registered office provider within 15 days. Share capital changes and name changes have their own actions." }, "Create_ky_constitution_amend": { "type": "object", "properties": { "type": { "const": "ky.constitution.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_constitution_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend the memorandum or articles of a Cayman company", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution altering the memorandum and/or articles", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Notice and minutes of the general meeting", "source": "generated", "required": false }, { "key": "foundation_alteration_instrument", "title": "Foundation company alteration instrument", "source": "generated", "required": false }, { "key": "amended_constitution", "title": "Amended memorandum and/or articles", "source": "generated", "required": true }, { "key": "certified_copy_of_special_resolution", "title": "Certified copy of the resolution or altering document", "source": "generated", "required": true }, { "key": "cima_notification_receipt", "title": "CIMA notification receipt", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "proxy", "verification_level": "identity_address" }, { "role": "council_member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "person_concerned", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "foundation_alteration_instrument", "signer_role": "founder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_copy_of_special_resolution", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_copy_of_special_resolution", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Copy of the special resolution altering the memorandum", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "share_capital_change_not_supported", "type": null, "when": "The amendment alters authorised share capital or share rights that need the capital provisions." }, { "code": "name_change_not_supported", "type": null, "when": "The amendment changes the company's name." }, { "code": "articles_conflict_with_memorandum", "type": null, "when": "The proposed articles contradict the memorandum, to which the power in s.24 is subject." }, { "code": "status_change_not_supported", "type": null, "when": "The amendment would remove the provisions that make the company an LDC, SPC or SEZC (for example SEZ business, s.182C)." }, { "code": "foundation_alteration_not_authorised", "type": null, "when": "entity_type is foundation_company and the memorandum or articles do not authorise the alteration (FCA ss.9, 10)." }, { "code": "foundation_requirements_breached", "type": null, "when": "The alteration would leave a foundation company outside the foundation company requirements, so the Registrar will not register it (FCA s.9,)." }, { "code": "special_resolution_threshold_not_met", "type": null, "when": "The recorded vote is below two-thirds, or a written resolution lacks a signature from every member entitled to vote." }, { "code": "verification_required", "type": null, "when": "A member, the holder of the foundation power, a director or the instructing person has no sufficient verification." } ] } }, "Params_ky_dual_foreign_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "description": "Only exempted companies may adopt a dual foreign name (Companies Act s.31)." }, "operation": { "type": "string", "enum": [ "adopt", "change" ], "description": "adopt: the company has no dual foreign name yet. change: replace the existing one." }, "dual_foreign_name": { "type": "string", "description": "The additional name, in any language not using the Roman alphabet, with any characters, script and diacritics.", "examples": [ "阿特拉斯创投有限公司" ] }, "language": { "type": "string", "description": "Language the dual foreign name is written in, as a BCP 47 tag, for example zh-Hans, zh-Hant, ja, ko, ar, ru.", "examples": [ "zh-Hans" ] }, "position": { "type": "string", "enum": [ "precedes", "follows" ], "description": "Whether the dual foreign name precedes or follows the English name on the register (s.31)." }, "translated_name": { "type": "string", "description": "English translation or transliteration of the dual foreign name.", "examples": [ "Atlas Chuangtou Youxian Gongsi" ] }, "translator_type": { "type": "string", "enum": [ "registered_office_provider", "certified_translator" ], "description": "Who provides the translated name: the company's CIMA-licensed registered office provider or a certified translator." }, "translator_credentials": { "type": "string", "pattern": "^doc_", "description": "Evidence that the translator is certified." }, "name": { "type": "string", "description": "Optional." }, "approval_method": { "type": "string", "enum": [ "members_meeting", "members_written_resolution" ], "description": "How the members approve the special resolution (Companies Act s.60)." }, "effective_date": { "type": "string", "format": "date", "description": "Future effective date for the altered certificate, if the Registry allows it." }, "restricted_word_approval": { "type": "string", "pattern": "^doc_", "description": "Registrar or CIMA approval where the translated name contains a restricted word." }, "express": { "type": "boolean", "description": "Request the Registry's express service." } }, "required": [ "entity_type", "operation", "dual_foreign_name", "language", "position", "translated_name", "translator_type", "approval_method" ], "description": "An exempted company adopts or changes an additional name in a non-Roman script by special resolution. The filing carries an English translated name and a statement of the language, and the Registrar issues an altered certificate of." }, "Create_ky_dual_foreign_name_change": { "type": "object", "properties": { "type": { "const": "ky.dual_foreign_name.change" }, "params": { "$ref": "#/components/schemas/Params_ky_dual_foreign_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt or change a dual foreign name", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution adopting or changing the dual foreign name", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Notice and minutes of the general meeting", "source": "generated", "required": false }, { "key": "translated_name_statement", "title": "Statement of the foreign language and translated name", "source": "generated", "required": true }, { "key": "translator_certificate", "title": "Certified translator's credentials", "source": "uploaded", "required": false }, { "key": "certified_copy_of_special_resolution", "title": "Certified copy of the special resolution", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_on_change_of_name", "title": "Altered certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "proxy", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "translator", "verification_level": "identity" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "translated_name_statement", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "translated_name_statement", "signer_role": "translator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_copy_of_special_resolution", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Special resolution adopting or changing a dual foreign name, with the translated name and ", "channel": "online", "government_fee": { "amount": 350, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not an exempted company type." }, { "code": "dual_foreign_name_uses_roman_script", "type": null, "when": "dual_foreign_name is written in the Roman alphabet." }, { "code": "translated_name_non_conforming", "type": null, "when": "The translated name contravenes s.30 or a regulatory-law name restriction, so the Registrar will not enter the dual foreign name or the translated name (s.30-)." }, { "code": "translator_credentials_missing", "type": null, "when": "translator_type is certified_translator and no credentials are attached." }, { "code": "special_resolution_threshold_not_met", "type": null, "when": "The recorded vote is below two-thirds, or a written resolution lacks a signature from every member entitled to vote." }, { "code": "verification_required", "type": null, "when": "A member, director, translator or the instructing person has no sufficient verification." } ] } }, "Params_ky_foreign_company_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Part 9 foreign company." }, "registration_number": { "type": "string", "description": "The foreign company's registration number with the Cayman Registrar." }, "effective_date": { "type": "string", "format": "date", "description": "Date the foreign company ceased to carry on or have a place of business in the Islands." }, "reason": { "type": "string", "description": "Why the foreign company has ceased." }, "holds_cayman_land": { "type": "boolean", "description": "True if the foreign company holds land in the Islands." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "registration_number", "effective_date", "reason", "holds_cayman_land" ], "description": "A foreign company registered under Part 9 gives the Registrar notice 'forthwith' that it has ceased to carry on or have a place of business in the Islands. From the date of notice its obligation to deliver documents to the Registrar ends." }, "Create_ky_foreign_company_cease": { "type": "object", "properties": { "type": { "const": "ky.foreign_company.cease" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_company_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Give notice that a registered foreign company has ceased business in the Cayman Islands", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_ceasing_business", "title": "Notice of ceasing business", "source": "generated", "required": true }, { "key": "filing_authorisation", "title": "Foreign company's authorisation to file", "source": "generated", "required": true }, { "key": "evidence_of_cessation", "title": "Evidence of cessation", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_ceasing_business", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of ceasing to carry on or have a place of business in the Islands", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered foreign company." }, { "code": "land_held_requires_counsel", "type": null, "when": "holds_cayman_land is true." }, { "code": "business_not_ceased", "type": null, "when": "The foreign company still has a place of business or carries on business in the Islands, so a s.192 notice would be wrong." }, { "code": "outstanding_annual_fee", "type": null, "when": "The annual fee for the current January is unpaid." }, { "code": "verification_required", "type": null, "when": "The instructing person has no verification at identity_address." } ] } }, "Params_ky_foreign_company_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Part 9 foreign company." }, "registration_number": { "type": "string", "description": "The foreign company's registration number with the Cayman Registrar." }, "alteration_date": { "type": "string", "format": "date", "description": "Date of the alteration.", "examples": [ "2026-10-05" ] }, "alterations": { "type": "array", "items": {}, "description": "One object per alteration: {kind, description}. kind is certificate_of_formation, constitutional_documents, directors or service_agents, matching s.184,, and.", "examples": [ "[{\"kind\": \"directors\", \"description\": \"Appointment of a director\"}]" ] }, "directors_added": { "type": "array", "items": {}, "description": "Person references of directors appointed." }, "directors_removed": { "type": "array", "items": {}, "description": "Person references of directors who left." }, "service_agents": { "type": "array", "items": {}, "description": "The full list of persons resident in the Islands authorised to accept service of process and notices after the change (s.184)." }, "updated_documents": { "type": "array", "items": {}, "description": "Document references for certified copies of the altered certificate of formation or constitutional documents." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "registration_number", "alteration_date", "alterations" ], "description": "A foreign company registered under Part 9 of the Companies Act delivers a return within 30 days of any alteration to its charter, constitution, directors or Cayman-resident persons authorised to accept service. The notice of ceasing." }, "Create_ky_foreign_company_return_file": { "type": "object", "properties": { "type": { "const": "ky.foreign_company_return.file" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_company_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a return of alterations for a registered foreign company", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "return_of_alterations", "title": "Return of alterations", "source": "generated", "required": true }, { "key": "certified_updated_documents", "title": "Certified copies of the altered documents", "source": "uploaded", "required": false }, { "key": "updated_list_of_directors", "title": "Updated list of directors", "source": "generated", "required": false }, { "key": "service_agent_authority", "title": "Authority to accept service", "source": "uploaded", "required": false }, { "key": "filing_authorisation", "title": "Foreign company's authorisation to file", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "filing_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "service_agent_authority", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_updated_documents", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "return_of_alterations", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Return containing the particulars of the alteration", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered foreign company." }, { "code": "alteration_not_filed_information", "type": null, "when": "The alteration is to something the foreign company never filed under s.184, or is a certificate of good standing (s.184), which s.187 excludes." }, { "code": "no_cayman_service_agent", "type": null, "when": "service_agents would leave the foreign company with no Cayman-resident person authorised to accept service, so service falls back on any place of business." }, { "code": "certified_copy_missing", "type": null, "when": "alterations includes a changed certificate of formation or constitutional document and no certified copy is attached." }, { "code": "alteration_overdue", "type": null, "when": "alteration_date is more than 30 days ago." }, { "code": "verification_required", "type": null, "when": "A director, service agent or the instructing person has no verification at identity_address." } ] } }, "Params_ky_foreign_lp_statement_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_lp" ], "description": "Foreign limited partnership registered under ELP Act s.42." }, "registration_number": { "type": "string", "description": "The foreign limited partnership's registration number with the Cayman Registrar." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change." }, "changes": { "type": "array", "items": {}, "description": "One object per change: {field, old_value, new_value}. field is one of name, dual_foreign_name, jurisdiction_of_establishment, separate_legal_person_status.", "examples": [ "[{\"field\": \"home_registered_office\", \"old_value\": \"1 Old St, Wilmington\", \"new_value\": \"9 New St, Wilmington\"}]" ] }, "service_agents": { "type": "array", "items": {}, "description": "Person references for the persons resident in the Islands authorised to accept service of process and notices after the change (s.42)." }, "general_partners": { "type": "array", "items": {}, "description": "Person references for the foreign limited partnership's general partners after the change (s.42)." }, "updated_documents": { "type": "array", "items": {}, "description": "Document references for certified copies of an altered certificate of formation or a fresh certificate of good standing, if the Registry asks for them." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "registration_number", "effective_date", "changes" ], "description": "A foreign limited partnership registered under s.42 of the ELP Act files a statement within 60 days of any change to the details in its registration statement. Its cessation as a general partner is a separate closure action." }, "Create_ky_foreign_lp_statement_file": { "type": "object", "properties": { "type": { "const": "ky.foreign_lp_statement.file" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_lp_statement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a statement of changes for a registered foreign limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "statement_of_changes", "title": "Statement of changes", "source": "generated", "required": true }, { "key": "service_agent_authority", "title": "Authority to accept service", "source": "uploaded", "required": false }, { "key": "supporting_documents", "title": "Supporting documents from the home registry", "source": "uploaded", "required": false }, { "key": "filing_authorisation", "title": "Foreign limited partnership's authorisation to file", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_changes", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "service_agent_authority", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statement_of_changes", "signer_role": "other", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Statement signed", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered foreign limited partnership." }, { "code": "change_not_in_registration_statement", "type": null, "when": "The change does not relate to a detail in the s.42 statement, so s.42 does not require a filing." }, { "code": "no_cayman_service_agent", "type": null, "when": "service_agents would leave the foreign limited partnership with no Cayman-resident person authorised to accept service." }, { "code": "change_overdue", "type": null, "when": "change_date is more than 60 days ago." }, { "code": "verification_required", "type": null, "when": "A general partner, service agent or the instructing person has no verification at identity_address." } ] } }, "Params_ky_name_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc", "llp", "elp" ], "description": "llc: certificate of amendment to the registration statement. llp: registration statement under s.19. elp: statement under s.10." }, "name": { "type": "string", "description": "The new name.", "examples": [ "Orchard Lane Capital, LLC" ] }, "dual_foreign_name": { "type": "string", "description": "Optional additional name in non-Roman script to adopt or change in the same filing.", "examples": [ "橙園路資本" ] }, "translated_name": { "type": "string", "description": "English translation or transliteration of the dual foreign name." }, "effective_date": { "type": "string", "format": "date", "description": "Date the members, managers or partners approved the name change.", "examples": [ "2026-10-19" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "The manager, managing partner or other partner or general partner who signs the statement, or on whose behalf it is signed." }, "authorising_document": { "type": "string", "pattern": "^doc_", "description": "The consent required by the LLC agreement or partnership agreement, if you already have one." }, "special_economic_zone_business": { "type": "boolean", "description": "True if the entity carries on special economic zone business, so the new name must include 'Special Economic Zone' or 'SEZ'." }, "cayman_enterprise_city_approval": { "type": "string", "pattern": "^doc_", "description": "Cayman Enterprise City approval letter." }, "restricted_word_approval": { "type": "string", "pattern": "^doc_", "description": "Registrar or CIMA approval where the name contains a restricted word." }, "name_reservation_id": { "type": "string", "description": "Reference of a name reservation, if you reserved the name first (LLC Act s.6; LLP Act s.8; ELP Act s.5A)." }, "cima_regulated": { "type": "boolean", "description": "True if the entity is registered with CIMA." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "name", "effective_date", "signatory" ], "description": "Files the amendment that changes the entity's registered name: a certificate of amendment, a registration statement or a s.10 statement. The new name takes effect when the Registrar registers it and issues a certificate." }, "Create_ky_name_amend": { "type": "object", "properties": { "type": { "const": "ky.name.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_name_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the name of a Cayman LLC, LLP or ELP", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "llc", "llp", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_amendment", "title": "LLC certificate of amendment to the registration statement", "source": "generated", "required": false }, { "key": "elp_change_statement", "title": "ELP statement of change in registered particulars", "source": "generated", "required": false }, { "key": "llp_registration_statement", "title": "LLP registration statement specifying the change of name", "source": "generated", "required": false }, { "key": "authorising_consent", "title": "Member, manager or partner consent", "source": "generated", "required": true }, { "key": "cayman_enterprise_city_approval", "title": "Cayman Enterprise City approval letter", "source": "uploaded", "required": false }, { "key": "restricted_word_approval", "title": "Registrar or CIMA approval for a restricted word", "source": "uploaded", "required": false }, { "key": "cima_notification_receipt", "title": "CIMA notification receipt", "source": "uploaded", "required": false }, { "key": "certificate_of_registration_on_change_of_name", "title": "Certificate of registration on change of name", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "certificate_of_amendment", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "elp_change_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "llp_registration_statement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "authorising_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "LLC: certificate of amendment to the registration statement", "channel": "online", "government_fee": { "amount": 250, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not llc, llp or elp." }, { "code": "name_not_available", "type": null, "when": "The new name is identical to, or so like, an existing LLC, exempted company, LLP or limited partnership name that it would mislead." }, { "code": "elp_name_suffix_required", "type": null, "when": "entity_type is elp and the name lacks 'Limited Partnership', 'L.P.' or 'LP' (ELP Act s.6)." }, { "code": "special_economic_zone_name_required", "type": null, "when": "special_economic_zone_business is true and the name lacks 'Special Economic Zone' or 'SEZ' (LLC Act s.6; LLP Act s.8; ELP Act s.6)." }, { "code": "cayman_enterprise_city_approval_missing", "type": null, "when": "An LLC adds 'Special Economic Zone' or 'SEZ' and no Cayman Enterprise City approval letter is attached." }, { "code": "restricted_word_approval_required", "type": null, "when": "The name contains a restricted word and no approval is attached." }, { "code": "signatory_not_authorised", "type": null, "when": "signatory is not a manager, partner or general partner on the register." }, { "code": "translated_name_non_conforming", "type": null, "when": "The translated name of a dual foreign name does not conform with the entity's naming rules, so the Registrar will not enter it (LLC Act s.6; LLP Act s.8A)." }, { "code": "verification_required", "type": null, "when": "The signatory or the instructing person has no verification at identity_address." } ] } }, "Params_ky_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type of the company, including foundation companies." }, "name": { "type": "string", "description": "The new name in the Roman alphabet or Arabic numerals.", "examples": [ "Atlas Ventures Ltd." ] }, "approval_method": { "type": "string", "enum": [ "members_meeting", "members_written_resolution" ], "description": "How the members approve the special resolution: at a general meeting (two-thirds of votes cast, or a higher majority in the articles, with notice of the." }, "name_reservation_id": { "type": "string", "description": "Reference of a name reservation under s.29A, if you reserved the name first." }, "effective_date": { "type": "string", "format": "date", "description": "Future effective date for the name-change certificate." }, "restricted_word_approval": { "type": "string", "pattern": "^doc_", "description": "Written approval where the new name contains a restricted word: Registrar approval for words such as 'royal', 'chartered', 'co-operative', 'assurance'." }, "cima_regulated": { "type": "boolean", "description": "True if the company is registered or licensed with CIMA." }, "express": { "type": "boolean", "description": "Request the Registry's express name-change service." } }, "required": [ "entity_type", "name", "approval_method" ], "description": "Members pass a special resolution changing the company's name, a copy is filed with the Registrar through the registered office provider, and the Registrar issues an altered certificate of incorporation. Adopting or changing a dual foreign." }, "Create_ky_name_change": { "type": "object", "properties": { "type": { "const": "ky.name.change" }, "params": { "$ref": "#/components/schemas/Params_ky_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the name of a Cayman company", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution of the members changing the company's name", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Notice and minutes of the general meeting", "source": "generated", "required": false }, { "key": "restricted_word_approval", "title": "Registrar or CIMA approval for a restricted word", "source": "uploaded", "required": false }, { "key": "certified_copy_of_special_resolution", "title": "Certified copy of the special resolution", "source": "generated", "required": true }, { "key": "cima_notification_receipt", "title": "CIMA notification receipt", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation_on_change_of_name", "title": "Certificate of incorporation on change of name", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "proxy", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_copy_of_special_resolution", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_copy_of_special_resolution", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Special resolution changing the name", "channel": "online", "government_fee": { "amount": 250, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_not_available", "type": null, "when": "The new name is identical to, or so like, an existing name or translated name that it would deceive (s.30)." }, { "code": "name_suffix_required", "type": null, "when": "The name omits a mandatory marker: 'Limited Duration Company' or 'LDC' at the end for an LDC, 'SPC' or 'Segregated Portfolio Company' for an SPC, 'Special Economic Zone Company'." }, { "code": "restricted_word_approval_required", "type": null, "when": "The name contains a restricted word and no Registrar or CIMA approval is attached." }, { "code": "llc_marker_not_permitted", "type": null, "when": "The name contains 'Limited Liability Company', 'L.L.C.' or 'LLC', which only LLC Act entities may use (LLC Act s.6)." }, { "code": "special_resolution_threshold_not_met", "type": null, "when": "The recorded vote is below two-thirds, or a written resolution lacks a signature from every member entitled to vote." }, { "code": "foundation_memorandum_alteration_not_authorised", "type": null, "when": "entity_type is foundation_company and the memorandum does not authorise the alteration (Foundation Companies Act s.9)." }, { "code": "verification_required", "type": null, "when": "A member, director or the instructing person has no verification at identity_address." } ] } }, "Params_ky_npo_registration_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "description": "Entity type of the underlying legal form that is also registered as a non-profit organisation." }, "npo_registration_number": { "type": "string", "description": "The NPO's number on the Registrar's register of non-profit organisations." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the earliest change being notified.", "examples": [ "2026-10-12" ] }, "changes": { "type": "array", "items": {}, "description": "One object per change: {field, description}. field is one of purposes_and_activities, constitutional_documents, name, address, contact_details, controllers.", "examples": [ "[{\"field\": \"controllers\", \"description\": \"Adds a controller; removes another\"}]" ] }, "controllers_added": { "type": "array", "items": {}, "description": "Person references of incoming controllers or senior officers.", "examples": [ "[\"per_1S4mQh4JtAed\"]" ] }, "controllers_removed": { "type": "array", "items": {}, "description": "Person references of controllers or senior officers who leave." }, "updated_constitution": { "type": "string", "pattern": "^doc_", "description": "The amended constitutional documents, with a signature page signed and dated by one or all controllers." }, "purposes_and_activities_statement": { "type": "string", "pattern": "^doc_", "description": "The detailed purposes and activities statement, updated." }, "filing_controller": { "type": "string", "pattern": "^per_", "description": "The controller who files from their own Cayman Business Portal account." } }, "required": [ "entity_type", "npo_registration_number", "effective_date", "changes", "filing_controller" ], "description": "A controller of a registered non-profit organisation notifies the Registrar of non-profit organisations within 30 days of any change in its purposes, activities, constitution, controllers or other registered particulars. This notifies the." }, "Create_ky_npo_registration_amend": { "type": "object", "properties": { "type": { "const": "ky.npo_registration.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_registration_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the NPO Registrar of changes to a registered non-profit organisation", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notification_of_change_form", "title": "Non-Profit Organisation Notification of Change Form", "source": "generated", "required": true }, { "key": "controllers_acknowledgement_form", "title": "Controllers and senior officers acknowledgement form", "source": "generated", "required": false }, { "key": "certified_passport_copy", "title": "Certified colour copy of a valid passport", "source": "uploaded", "required": false }, { "key": "updated_constitution", "title": "Amended constitutional documents", "source": "uploaded", "required": false }, { "key": "purposes_and_activities_statement", "title": "Detailed purposes and activities statement", "source": "uploaded", "required": false }, { "key": "banking_confirmation", "title": "Bank account confirmation", "source": "uploaded", "required": false }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement and updated register entry", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notification_of_change_form", "signer_role": "beneficial_owner", "method": "registry_authentication", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "controllers_acknowledgement_form", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_constitution", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_passport_copy", "signer_role": "officer", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Non-Profit Organisation Notification of Change Form", "channel": "online", "government_fee": { "amount": 25, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_registered_npo", "type": null, "when": "npo_registration_number is not on the NPO register, or the registration is cancelled or suspended." }, { "code": "filing_controller_not_a_controller", "type": null, "when": "filing_controller is not a controller of the NPO." }, { "code": "certified_id_missing", "type": null, "when": "An incoming controller or senior officer has no certified passport copy." }, { "code": "acknowledgement_form_missing", "type": null, "when": "An incoming controller or senior officer has not signed the acknowledgement form." }, { "code": "constitution_signature_page_missing", "type": null, "when": "updated_constitution lacks a signature page signed and dated by a controller." }, { "code": "constitution_clauses_missing", "type": null, "when": "The amended constitution drops the asset-application clause or the dissolution clause." }, { "code": "underlying_change_not_made", "type": null, "when": "The change is to the entity itself and has not been completed through the entity's own action." }, { "code": "verification_required", "type": null, "when": "A controller or the instructing person has no verification at identity_address." } ] } }, "Params_ky_npo_registration_cancel": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "description": "Entity type of the underlying legal form that is also registered as a non-profit organisation." }, "npo_registration_number": { "type": "string", "description": "The NPO's number on the Registrar's register." }, "request_type": { "type": "string", "enum": [ "cessation_notice", "cancellation_request", "suspension_request" ], "description": "cessation_notice: the NPO has ceased to exist; the person who was a controller at the time must notify the Registrar (s.7). cancellation_request or." }, "effective_date": { "type": "string", "format": "date", "description": "Date the NPO ceased to exist, or the date from which cancellation or suspension is requested." }, "suspension_end_date": { "type": "string", "format": "date", "description": "For suspension_request: when the suspension should end, if known." }, "reason": { "type": "string", "description": "Why the NPO is ceasing or asking for cancellation or suspension." }, "assets_transfer_recipient": { "type": "string", "description": "After dissolution, the remaining sums go to another registered NPO with similar purposes that is not carried on for profit." }, "filing_controller": { "type": "string", "pattern": "^per_", "description": "The controller who files." } }, "required": [ "entity_type", "npo_registration_number", "request_type", "effective_date", "reason", "filing_controller" ], "description": "A controller tells the Registrar of non-profit organisations that the organisation has ceased to exist, or asks in writing for its registration to be cancelled or suspended. The Registrar must then notify the Attorney General, who may." }, "Create_ky_npo_registration_cancel": { "type": "object", "properties": { "type": { "const": "ky.npo_registration.cancel" }, "params": { "$ref": "#/components/schemas/Params_ky_npo_registration_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the NPO Registrar of cessation, or request cancellation or suspension", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "section_80_company", "foundation_company", "exempted_company", "ordinary_resident_company", "exempted_trust", "cooperative_society", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "written_request", "title": "Written notice or request to the Registrar", "source": "generated", "required": true }, { "key": "governing_body_resolution", "title": "Resolution of the governing body", "source": "generated", "required": true }, { "key": "dissolution_evidence", "title": "Evidence that the NPO has ceased", "source": "uploaded", "required": false }, { "key": "final_accounts_and_asset_transfer", "title": "Final accounts and evidence of the transfer of remaining assets", "source": "uploaded", "required": false }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement and register update", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "written_request", "signer_role": "beneficial_owner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "governing_body_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of non-existence", "channel": "both", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_registered_npo", "type": null, "when": "npo_registration_number is not on the NPO register or is already cancelled." }, { "code": "dissolution_evidence_missing", "type": null, "when": "request_type is cessation_notice and no evidence that the NPO has ceased is attached." }, { "code": "assets_recipient_missing", "type": null, "when": "The NPO is dissolving and no registered NPO with similar purposes is named to receive remaining sums." }, { "code": "funds_held_pending_inquiry", "type": null, "when": "The NPO is under an inquiry or its registration is already liable to cancellation, so the Attorney General's role (ss.8, 10) may restrict how its funds are dealt with." }, { "code": "filing_controller_not_a_controller", "type": null, "when": "filing_controller is not, and was not, a controller of the NPO." }, { "code": "verification_required", "type": null, "when": "A controller or the instructing person has no sufficient verification." } ] } }, "Params_ky_registered_office_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc", "llp", "elp", "lp" ], "description": "llc: certificate of amendment (LLC Act ss.7, 8). llp: registration statement (LLP Act ss.9, 19). elp: statement of change (ELP Act s.10). lp: declaration by." }, "provider_type": { "type": "string", "enum": [ "entiva_partner", "other_licensed_provider", "own_address" ], "description": "Who provides the registered office after the change." }, "provider_name": { "type": "string", "description": "Name of the incoming provider." }, "provider_licence_number": { "type": "string", "description": "CIMA licence number of the incoming provider." }, "address": { "$ref": "#/components/schemas/Address", "description": "New registered office address in the Islands." }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address." }, "effective_date": { "type": "string", "format": "date", "description": "Date the registered office changed or will change.", "examples": [ "2026-10-14" ] }, "signatory": { "type": "string", "pattern": "^per_", "description": "Required for llc, llp and elp." }, "general_partners": { "type": "array", "items": {}, "description": "Required for lp.", "examples": [ "[\"per_1S4mQc2WnVzp\", \"per_1S4mQd8YtLmq\"]" ] }, "outgoing_provider_name": { "type": "string", "description": "Current registered office provider, if any." }, "reason_for_change": { "type": "string", "description": "Why the registered office is moving." }, "authorising_document": { "type": "string", "pattern": "^doc_", "description": "The member or manager consent required by the LLC agreement (LLC Act s.7 makes the change subject to the agreement), or the partners' decision under the." }, "cima_regulated": { "type": "boolean", "description": "True if the entity is registered with CIMA." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "provider_type", "address", "mailing_address", "effective_date" ], "description": "Files the statutory amendment that records a new registered office: a certificate of amendment, a registration statement, a s.10 statement or a declaration by all general partners. The deadline and fee depend on the entity type." }, "Create_ky_registered_office_amend": { "type": "object", "properties": { "type": { "const": "ky.registered_office.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_registered_office_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered office of a Cayman LLC, LLP, ELP or limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "llc", "llp", "elp", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_amendment", "title": "LLC certificate of amendment to the registration statement", "source": "generated", "required": false }, { "key": "elp_change_statement", "title": "ELP statement of change in registered particulars", "source": "generated", "required": false }, { "key": "llp_registration_statement", "title": "LLP registration statement specifying the change", "source": "generated", "required": false }, { "key": "lp_declaration_of_change", "title": "Declaration by all general partners", "source": "generated", "required": false }, { "key": "registered_office_consent", "title": "Registered office provider's consent", "source": "generated", "required": false }, { "key": "provider_resignation_notice", "title": "Outgoing provider's resignation of registered office", "source": "uploaded", "required": false }, { "key": "authorising_consent", "title": "Member, manager or partner consent", "source": "generated", "required": false }, { "key": "cima_notification_receipt", "title": "CIMA notification receipt", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "certificate_of_amendment", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "elp_change_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "llp_registration_statement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp_declaration_of_change", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registered_office_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "authorising_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "LLC: certificate of amendment to the registration statement", "channel": "both", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not llc, llp, elp or lp." }, { "code": "own_address_not_permitted", "type": null, "when": "new_provider_type is own_address for an llc or elp." }, { "code": "provider_licence_not_valid", "type": null, "when": "The incoming provider's licence is missing from CIMA's register or is not of a type the statute allows (LLC Act s.7; ELP Act s.6)." }, { "code": "signatory_not_authorised", "type": null, "when": "signatory is not a manager, partner or general partner on the register." }, { "code": "all_general_partners_required", "type": null, "when": "entity_type is lp and general_partners does not list every general partner on the register." }, { "code": "declaration_not_sworn", "type": null, "when": "The LP declaration is not yet sworn before a Justice of the Peace or notary by every general partner." }, { "code": "llc_agreement_consent_missing", "type": null, "when": "The LLC agreement requires member or manager consent and none is attached." }, { "code": "registered_office_gap", "type": null, "when": "For an LLC, the outgoing provider's resignation notice would be filed before the new consent and amendment, leaving the LLC with no registered office (LLC Act s.7-)." }, { "code": "address_incomplete", "type": null, "when": "new_address or mailing_address lacks a physical location, PO Box or KY postal code." }, { "code": "verification_required", "type": null, "when": "The signatory, a general partner or the instructing person has no verification at identity_address." } ] } }, "Params_ky_registered_office_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "description": "Entity type of the company. foundation_company is not accepted: Companies Act s.11 does not apply to foundation companies, whose registered office is the." }, "provider_type": { "type": "string", "enum": [ "entiva_partner", "other_cima_licensee", "own_address" ], "description": "Who provides the registered office after the change." }, "provider_name": { "type": "string", "description": "Name of the incoming provider." }, "provider_cima_licence_number": { "type": "string", "description": "CIMA licence number of the incoming provider." }, "address": { "$ref": "#/components/schemas/Address", "description": "New registered office address in the Islands, with the physical location." }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address for the registered office: PO Box and KY postal code." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the directors pass the resolution.", "examples": [ "2026-10-20" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the new address takes effect, if later than resolution_date." }, "outgoing_provider_name": { "type": "string", "description": "Current registered office provider, if the company has one." }, "reason_for_change": { "type": "string", "description": "Why the registered office is moving." }, "directors_resolution": { "type": "string", "pattern": "^doc_", "description": "A directors' resolution you have already signed." }, "cima_regulated": { "type": "boolean", "description": "True if the company is registered or licensed with CIMA.", "examples": [ "false" ] }, "express": { "type": "boolean", "description": "Request the Registry's express service.", "examples": [ "false" ] } }, "required": [ "entity_type", "provider_type", "address", "mailing_address", "resolution_date" ], "description": "The directors resolve to change the company's registered office address, and the CIMA-licensed registered office provider files a certified copy of the resolution with the Registrar of Companies within 30 days. Also used to move a company." }, "Create_ky_registered_office_change": { "type": "object", "properties": { "type": { "const": "ky.registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_ky_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the registered office of a Cayman company", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution of the directors changing the registered office", "source": "generated", "required": true }, { "key": "certified_copy_of_resolution", "title": "Certified copy of the directors' resolution", "source": "generated", "required": true }, { "key": "registered_office_consent", "title": "Registered office provider's consent", "source": "generated", "required": false }, { "key": "notice_of_registered_office", "title": "Notice of the situation of the registered office", "source": "generated", "required": true }, { "key": "outgoing_provider_release", "title": "Outgoing provider's handover confirmation", "source": "uploaded", "required": false }, { "key": "cima_notification_receipt", "title": "CIMA notification receipt", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registered_office_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "certified_copy_of_resolution", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_registered_office", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Certified copy of the directors' resolution under Companies Act s.11", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is foundation_company or any type this action does not cover." }, { "code": "own_address_not_permitted", "type": null, "when": "new_provider_type is own_address for an exempted, LDC, SPC, SEZC or non-resident company." }, { "code": "provider_licence_not_valid", "type": null, "when": "new_provider_type is other_cima_licensee and the licence number is not on CIMA's register, has lapsed, or is not a company management, trust or mutual fund administrator licence." }, { "code": "address_incomplete", "type": null, "when": "new_address or mailing_address lacks the physical location, the PO Box or the KY postal code." }, { "code": "provider_consent_missing", "type": null, "when": "The incoming provider has not consented, or the partner_acceptance requirement is still open." }, { "code": "resolution_filing_overdue", "type": null, "when": "resolution_date is more than 30 days ago." }, { "code": "verification_required", "type": null, "when": "A director or the instructing person has no verification at identity_address." } ] } }, "Params_ky_registered_particulars_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp", "llc", "llp", "lp" ], "description": "elp: ELP Act s.10. llc: LLC Act s.8. llp: LLP Act s.19. lp: Partnership Act s.51." }, "effective_date": { "type": "string", "format": "date", "description": "Date the particular changed or will change.", "examples": [ "2026-10-19" ] }, "nature_of_business": { "type": "string", "description": "New general nature of the business (ELP s.9; LLC s.5; LLP s.18; Partnership Act s.49)." }, "term": { "type": "object", "description": "New term: {\"unlimited\": true} or {\"unlimited\": false, \"end_date\": \"2041-12-31\"}.", "examples": [ "{\"unlimited\": false, \"end_date\": \"2041-12-31\"}" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "New financial year end as MM-DD." }, "signatory": { "type": "string", "pattern": "^per_", "description": "Required for llc, llp and elp." }, "general_partners": { "type": "array", "items": {}, "description": "Required for lp." }, "authorising_document": { "type": "string", "pattern": "^doc_", "description": "The partner, member or manager consent the governing agreement requires, and any amended partnership agreement, if you already have them." }, "cima_regulated": { "type": "boolean", "description": "True if the entity is registered with CIMA." }, "express": { "type": "boolean", "description": "Request the Registry's express filing service." } }, "required": [ "entity_type", "effective_date" ], "description": "Files the statutory amendment that records a new nature of business, term or financial year end: a s.10 statement, a certificate of amendment, a registration statement or a declaration by all general partners. Name, registered office and." }, "Create_ky_registered_particulars_amend": { "type": "object", "properties": { "type": { "const": "ky.registered_particulars.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_registered_particulars_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend the registered particulars of an ELP, LLC, LLP or limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "elp", "llc", "llp", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_amendment", "title": "LLC certificate of amendment to the registration statement", "source": "generated", "required": false }, { "key": "elp_change_statement", "title": "ELP statement of change in registered particulars", "source": "generated", "required": false }, { "key": "llp_registration_statement", "title": "LLP registration statement specifying the change", "source": "generated", "required": false }, { "key": "lp_declaration_of_change", "title": "Declaration by all general partners", "source": "generated", "required": false }, { "key": "authorising_consent", "title": "Member, manager or partner consent", "source": "generated", "required": true }, { "key": "agreement_amendment_evidence", "title": "Amended LLC agreement or partnership agreement", "source": "uploaded", "required": false }, { "key": "cima_notification_receipt", "title": "CIMA notification receipt", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "certificate_of_amendment", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "elp_change_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "llp_registration_statement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp_declaration_of_change", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "authorising_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "ELP: statement under s.10. LLC: certificate of amendment to the registration statement", "channel": "both", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not elp, llc, llp or lp." }, { "code": "no_change_specified", "type": null, "when": "None of new_nature_of_business, new_term or new_financial_year_end is given." }, { "code": "financial_year_end_not_applicable", "type": null, "when": "new_financial_year_end is given for an elp or lp, whose statements carry no financial year end." }, { "code": "signatory_not_authorised", "type": null, "when": "signatory is not a manager, partner or general partner on the register." }, { "code": "all_general_partners_required", "type": null, "when": "entity_type is lp and general_partners does not list every general partner on the register." }, { "code": "declaration_not_sworn", "type": null, "when": "The LP declaration is not yet sworn before a Justice of the Peace or notary by every general partner." }, { "code": "agreement_amendment_missing", "type": null, "when": "The change needs the governing agreement amended and no evidence is attached." }, { "code": "verification_required", "type": null, "when": "The signatory, a general partner or the instructing person has no verification at identity_address." } ] } }, "Params_ky_registry_error_rectify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc", "foundation_company", "elp", "lp", "llp", "foreign_company", "foreign_lp" ], "description": "Entity type." }, "document_type": { "type": "string", "description": "The kind of filed document with the error, for example register_of_directors, special_resolution, registration_statement, certificate_of_amendment.", "examples": [ "certificate_of_amendment" ] }, "document_reference": { "type": "string", "description": "Registry filing receipt number or other reference, with the filing date, so the Registry can find the document." }, "filed_date": { "type": "string", "format": "date", "description": "Date the document was filed." }, "error_description": { "type": "string", "description": "What is wrong in the filed document or on the register." }, "correct_information": { "type": "string", "description": "What the information should say." }, "corrected_document": { "type": "string", "pattern": "^doc_", "description": "The corrected document." }, "supporting_evidence": { "type": "array", "items": {}, "description": "Document references for evidence of the correct facts, for example a passport showing the right spelling of a name." }, "error_origin": { "type": "string", "enum": [ "filer", "registry", "unknown" ], "description": "filer: the entity or its provider made the error. registry: the Registry recorded a correct filing wrongly. unknown: not established." } }, "required": [ "entity_type", "document_type", "document_reference", "filed_date", "error_description", "correct_information", "corrected_document", "error_origin" ], "description": "The entity, usually through its registered office, asks the Registrar to correct an error in a document filed under the Act or on the register, using the Registrar's administrative service for correcting errors. It does not backdate a." }, "Create_ky_registry_error_rectify": { "type": "object", "properties": { "type": { "const": "ky.registry_error.rectify" }, "params": { "$ref": "#/components/schemas/Params_ky_registry_error_rectify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Ask the Registrar to correct an error in a registered document", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "llc", "foundation_company", "elp", "lp", "llp", "foreign_company", "foreign_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "correction_request", "title": "Request to correct an error", "source": "generated", "required": true }, { "key": "corrected_document", "title": "Corrected document", "source": "uploaded", "required": true }, { "key": "original_filing_copy", "title": "Copy of the original filing", "source": "generated", "required": false }, { "key": "supporting_evidence", "title": "Evidence of the correct facts", "source": "uploaded", "required": false }, { "key": "registry_confirmation", "title": "Registry confirmation of the corrected record", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "correction_request", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "correction_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for correction of an error", "channel": "both", "government_fee": { "amount": 125, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity type has no Registry correction service in the sources found." }, { "code": "substantive_change_not_correction", "type": null, "when": "The proposed correction changes a legal fact, such as a different director or a later date." }, { "code": "original_filing_not_found", "type": null, "when": "document_reference does not match a document on the Registry record." }, { "code": "corrected_document_missing", "type": null, "when": "No corrected document is attached." }, { "code": "verification_required", "type": null, "when": "The authorising officer or the instructing person has no verification at identity_address." } ] } }, "Params_ky_society_rules_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cooperative_society", "friendly_society" ], "description": "cooperative_society: Cooperative Societies Law s.11. friendly_society: Friendly Societies Law ss.12-13." }, "registration_number": { "type": "string", "description": "The society's number on the Registrar's register." }, "amendment_summary": { "type": "string", "description": "Plain-language description of the rule changes." }, "amended_rules": { "type": "string", "pattern": "^doc_", "description": "The amendment or the full amended rules." }, "changes_society_name": { "type": "boolean", "description": "Co-operative only." }, "name": { "type": "string", "description": "The new name, when changes_society_name is true." }, "is_credit_union": { "type": "boolean", "description": "Co-operative only." }, "alteration_route": { "type": "string", "enum": [ "general_meeting", "nominated_committee" ], "description": "Friendly society only. general_meeting: a meeting convened by public notice on the requisition of seven or more members. nominated_committee: a committee." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the general meeting that approved the amendment." }, "members_present": { "type": "integer", "description": "Friendly society: members present at the meeting, or members of the nominated committee." }, "members_in_favour": { "type": "integer", "description": "Friendly society: how many consented." } }, "required": [ "entity_type", "registration_number", "amendment_summary", "amended_rules" ], "description": "A co-operative society sends three copies of the rule amendment to the Registrar; a friendly society alters its rules at a properly called general meeting and deposits a transcript. The amendment is not valid until the Registrar registers." }, "Create_ky_society_rules_amend": { "type": "object", "properties": { "type": { "const": "ky.society_rules.amend" }, "params": { "$ref": "#/components/schemas/Params_ky_society_rules_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an amendment to the rules of a co-operative or friendly society", "x-entiva": { "jurisdiction": "ky", "stage": "changes", "applies_to": [ "cooperative_society", "friendly_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amended_rules", "title": "Amendment or amended rules", "source": "uploaded", "required": true }, { "key": "requisition_and_notice", "title": "Requisition and public notice of the meeting", "source": "generated", "required": false }, { "key": "meeting_minutes", "title": "Minutes of the general meeting", "source": "generated", "required": true }, { "key": "officers_certificate", "title": "Officers' certificate of the amendment", "source": "generated", "required": true }, { "key": "registrar_certified_copy", "title": "Registrar's certified copy of the amendment", "source": "registry_issued", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "requisition_and_notice", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "officers_certificate", "signer_role": "company_secretary", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Co-operative: three copies of the amendment sent to the Registrar for registration", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "entity_type is not cooperative_society or friendly_society." }, { "code": "meeting_vote_below_75_percent", "type": null, "when": "Friendly society: members_in_favour is below 75 per cent of members_present (s.13)." }, { "code": "requisition_below_seven_members", "type": null, "when": "Friendly society: the requisition was signed by fewer than seven members (s.13)." }, { "code": "rules_conflict_with_law", "type": null, "when": "The amendment appears contrary to the Law or the regulations, which is the Registrar's ground for refusing a co-operative amendment (s.11)." }, { "code": "credit_union_approval_not_confirmed", "type": null, "when": "is_credit_union is true." }, { "code": "verification_required", "type": null, "when": "An officer signing for the society or the instructing person has no verification at identity_address." } ] } }, "Params_ky_building_society_merge": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "union", "transfer_of_engagements" ], "description": "Union into one society, or transfer of engagements" }, "societies": { "type": "array", "items": {}, "description": "Societies taking part; for a transfer, the transferring and the receiving society" }, "united_society_name": { "type": "string", "description": "Name of the united society" }, "funds_treatment": { "type": "string", "enum": [ "with_dissolution_or_division", "without_dissolution_or_division" ], "description": "With or without dissolution or division of funds (s.9)" }, "meeting_dates": { "type": "array", "items": {}, "description": "Date of the general meeting of each society convened for the purpose" } }, "required": [ "kind", "societies", "funds_treatment", "meeting_dates" ], "description": "Building Societies Law s.9. Two or more societies unite, or one transfers its engagements to another, on written terms agreed by holders of at least 66.67% of the total shares of each society at general meetings called for the purpose." }, "Create_ky_building_society_merge": { "type": "object", "properties": { "type": { "const": "ky.building_society.merge" }, "params": { "$ref": "#/components/schemas/Params_ky_building_society_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Unite building societies or transfer a building society's engagements", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "building_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "instrument_of_union_or_transfer", "title": "Instrument of union or transfer of engagements, listing funds, property and assets (s.9)", "source": "generated", "required": true }, { "key": "meeting_notices_and_minutes", "title": "Notice and minutes of each general meeting", "source": "generated", "required": true }, { "key": "resolution_notice", "title": "Notice of each resolution for recording (s.9)", "source": "generated", "required": true }, { "key": "united_society_rules", "title": "Rules of the united society, certified through the Attorney General", "source": "uploaded", "required": false }, { "key": "cima_approval", "title": "CIMA approval or confirmation", "source": "uploaded", "required": false }, { "key": "registrar_record", "title": "Registrar's recording of the notice", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "instrument_of_union_or_transfer", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resolution_notice", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of resolution recorded in the Registrar's office", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "approval_threshold_not_met", "type": null, "when": "Holders of under 66.67% of a society's shares approved" }, { "code": "creditor_prejudice", "type": null, "when": "The terms would prejudice a creditor's rights (s.9)" } ] } }, "Params_ky_company_convert_to_exempted": { "type": "object", "properties": { "from_type": { "type": "string", "enum": [ "exempted_ldc", "sezc", "ordinary_nonresident_company", "llc", "foundation_company" ], "description": "Status being left" }, "name": { "type": "string", "description": "New name; must not end 'LDC' or 'SEZC' on those routes" }, "ldc_exit_route": { "type": "string", "enum": [ "remove_ldc_from_name", "extend_term_beyond_30_years" ], "description": "LDC only (s.181-)" }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Non-resident, LLC and foundation routes: sets the fee band" }, "operations_outside_islands": { "type": "boolean", "description": "Non-resident, LLC and foundation routes: operations mainly outside the Islands (s.210; registration declaration under ss.233A-233B)" }, "share_conversion": { "type": "object", "description": "LLC route: how each LLC interest converts to shares, at par, discount or premium (s.233A)" }, "apply_for_tax_undertaking": { "type": "boolean", "description": "LLC and foundation routes: seek a Tax Concessions Act s.6 undertaking; the old one ends" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "from_type", "name" ], "description": "Five routes end in a plain exempted company. LDC (s.181-) and SEZC (s.182C) drop their status by name change plus a resolution." }, "Create_ky_company_convert_to_exempted": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_exempted" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_exempted" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an LDC, SEZC, ordinary non-resident company, LLC or foundation company into a plain exempted company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_ldc", "sezc", "ordinary_nonresident_company", "llc", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution, or LLC conversion consent, adopting the new constitution", "source": "generated", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Memorandum and articles taking effect on re-registration", "source": "generated", "required": true }, { "key": "application_signed", "title": "Re-registration application", "source": "generated", "required": true }, { "key": "declaration_operations_outside", "title": "Director's registration declaration: operations mainly outside the Islands", "source": "generated", "required": false }, { "key": "certificate_of_good_standing", "title": "Certificate of good standing", "source": "registry_issued", "required": false }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_re_registration", "title": "Certificate of re-registration or altered certificate of incorporation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_signed", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_signed", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "declaration_operations_outside", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "LDC: s.181", "channel": "online", "government_fee": { "amount": 400, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "name_still_has_status_suffix", "type": null, "when": "Name still ends 'LDC' or 'SEZC'" }, { "code": "authorised_capital_required", "type": null, "when": "Capital needed to set the fee band" }, { "code": "llc_consent_threshold_not_met", "type": null, "when": "Fewer than two-thirds of LLC members consented" } ] } }, "Params_ky_company_convert_to_foundation_company": { "type": "object", "properties": { "limited_by": { "type": "string", "enum": [ "shares", "guarantee" ], "description": "Company is limited by shares or guarantee (s.4)" }, "objects": { "type": "string", "description": "Objects stated in the memorandum (s.4)" }, "surplus_assets_disposal": { "type": "string", "description": "Disposal of surplus assets on winding up (s.4)" }, "distributions_prohibited": { "type": "boolean", "description": "Memorandum bars dividends and distributions to members as such (s.4)" }, "secretary": { "type": "string", "pattern": "^per_", "description": "Qualified-person secretary (s.4, s.16)" }, "supervisors": { "type": "array", "items": {}, "description": "Supervisors, if the constitution has any" }, "founder": { "type": "string", "pattern": "^per_", "description": "Founder or endowing person, if any" }, "constitution_model": { "type": "string", "enum": [ "schedule_2_model", "custom" ], "description": "Use the Schedule 2 model constitution or a custom one" } }, "required": [ "limited_by", "objects", "surplus_assets_disposal", "distributions_prohibited", "secretary" ], "description": "Under Foundation Companies Act s.5 the directors and members of an existing company apply for a declaration that it is a foundation company, and a new certificate of incorporation issues. The memorandum must say it is a foundation company." }, "Create_ky_company_convert_to_foundation_company": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_foundation_company" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_foundation_company" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an existing company into a foundation company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution altering the memorandum and adopting articles", "source": "generated", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Foundation company memorandum and articles", "source": "generated", "required": true }, { "key": "secretary_consent", "title": "Consent of the qualified-person secretary", "source": "generated", "required": true }, { "key": "application_signed", "title": "Application by the directors and members (s.5)", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "new_certificate_of_incorporation", "title": "New certificate of incorporation with the foundation company declaration", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "none" }, { "role": "council_member", "verification_level": "identity_address" }, { "role": "founder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_signed", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_consent", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Foundation Companies Act s.5", "channel": "online", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "secretary_not_qualified", "type": null, "when": "Secretary is not licensed or permitted under the Companies Management Act (s.4)" }, { "code": "distributions_not_prohibited", "type": null, "when": "Memorandum does not bar distributions to members" }, { "code": "company_not_in_good_standing", "type": null, "when": "Fees or filings outstanding" } ] } }, "Params_ky_company_convert_to_ldc": { "type": "object", "properties": { "name": { "type": "string", "description": "New name ending 'Limited Duration Company' or 'LDC' (s.179)" }, "duration_years": { "type": "integer", "description": "Term in years, 30 or less (s.179)" }, "transfer_requires_unanimous_consent": { "type": "boolean", "description": "Articles need all other members to approve a share transfer (s.180)" }, "management_by_members": { "type": "boolean", "description": "Members manage and count as directors (s.180-)" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "name", "duration_years" ], "description": "Under s.178 an exempted company applies to be registered as an LDC. It needs two or more members, a term of 30 years or less and a name ending 'Limited Duration Company' or 'LDC'." }, "Create_ky_company_convert_to_ldc": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_ldc" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_ldc" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an exempted company into an exempted limited duration company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "special_resolution_duration", "title": "Special resolution limiting the term to 30 years or less", "source": "generated", "required": false }, { "key": "special_resolution_name", "title": "Special resolution changing the name to end 'LDC'", "source": "generated", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Amended memorandum and articles", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_incorporation_ldc", "title": "Certificate of incorporation recording LDC status", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_name", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_duration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.178 with certified special resolutions and amended memor", "channel": "online", "government_fee": { "amount": 400, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fewer_than_two_members", "type": null, "when": "Fewer than two members or subscribers (s.179)" }, { "code": "term_exceeds_30_years", "type": null, "when": "Memorandum would allow a term over 30 years" }, { "code": "name_suffix_missing", "type": null, "when": "Name does not end 'Limited Duration Company' or 'LDC'" } ] } }, "Params_ky_company_convert_to_llc": { "type": "object", "properties": { "llc_name": { "type": "string", "description": "LLC name; 'LLC' suffix optional, 'SEZ' needed for SEZ business" }, "dual_foreign_name": { "type": "string", "description": "Optional dual foreign name" }, "initial_members": { "type": "array", "items": {}, "description": "Names and addresses of the initial members (s.5)" }, "nature_of_business": { "type": "string", "description": "Nature of the business (s.5)" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day, for example 12-31 (s.5)" }, "term": { "type": "string", "description": "Term, if not unlimited (s.5)" }, "operations_outside_islands": { "type": "boolean", "description": "Declaration: no business with the public in the Islands beyond what the outside business needs (s.5)" }, "apply_for_tax_undertaking": { "type": "boolean", "description": "Apply for an LLC Act s.58 undertaking" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "llc_name", "initial_members", "nature_of_business", "financial_year_end", "operations_outside_islands" ], "description": "Under LLC Act s.56 an exempted company re-registers as an LLC by special resolution adopting a registration statement and an LLC agreement. A director or authorised person signs the application." }, "Create_ky_company_convert_to_llc": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_llc" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_llc" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register an exempted company as a limited liability company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution adopting the registration statement and LLC agreement (s.56)", "source": "generated", "required": true }, { "key": "registration_statement", "title": "LLC registration statement (s.5)", "source": "generated", "required": true }, { "key": "llc_agreement", "title": "LLC agreement", "source": "generated", "required": true }, { "key": "application_signed", "title": "Re-registration application (s.56)", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_re_registration", "title": "Certificate of re-registration as an LLC", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "application_signed", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for re-registration as an LLC under LLC Act s.56 with the registration stateme", "channel": "online", "government_fee": { "amount": 900, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "spc_cannot_convert", "type": null, "when": "The company is an SPC (s.56)" }, { "code": "llc_name_not_acceptable", "type": null, "when": "Name refused under LLC Act s.6" }, { "code": "no_initial_members", "type": null, "when": "No initial member listed (s.5)" } ] } }, "Params_ky_company_convert_to_ordinary_resident": { "type": "object", "properties": { "name": { "type": "string", "description": "Name an ordinary resident company may have (s.211A)" }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Sets the fee band: CI$300 up to CI$42,000, CI$500 above (Sch.5 Pt 1)" }, "business_activities_in_islands": { "type": "string", "description": "Business to be carried on in the Islands, for licensing screening" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "authorised_capital", "business_activities_in_islands" ], "description": "New route from 1 January 2026. A special resolution alters the memorandum and articles to fit an ordinary resident company, and a director signs the application with copies of the altered documents." }, "Create_ky_company_convert_to_ordinary_resident": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_ordinary_resident" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_ordinary_resident" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register an exempted company as an ordinary resident company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution altering memorandum and articles (s.211A)", "source": "generated", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Memorandum and articles as altered", "source": "generated", "required": true }, { "key": "application_signed_by_director", "title": "Application signed by a director (s.211A)", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_re_registration", "title": "Certificate of re-registration (s.211B)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "application_signed_by_director", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.211A with the altered memorandum and articles", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "authorised_capital_required", "type": null, "when": "Capital needed to set the fee band" }, { "code": "name_not_acceptable", "type": null, "when": "Name unavailable to an ordinary resident company" }, { "code": "company_not_in_good_standing", "type": null, "when": "Fees or filings outstanding" } ] } }, "Params_ky_company_convert_to_sezc": { "type": "object", "properties": { "name": { "type": "string", "description": "New name including 'Special Economic Zone Company' or 'SEZC' (s.182B)" }, "sez_business": { "type": "string", "description": "SEZ business to add to the memorandum (s.182B)" }, "special_economic_zone": { "type": "string", "description": "Zone or operator, for example Cayman Enterprise City" }, "confirms_no_section_174_licence": { "type": "boolean", "description": "Company holds no s.174 licence (s.182A)" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "name", "sez_business", "confirms_no_section_174_licence" ], "description": "An exempted company with no s.174 licence applies under s.182A. Two special resolutions are filed: the memorandum is altered to carry on special economic zone business, and the name is changed to include 'Special Economic Zone Company' or." }, "Create_ky_company_convert_to_sezc": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_sezc" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_sezc" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an exempted company into a special economic zone company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "special_resolution_memorandum", "title": "Special resolution altering the memorandum for SEZ business", "source": "generated", "required": true }, { "key": "special_resolution_name", "title": "Special resolution changing the name to include SEZC", "source": "generated", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Amended memorandum and articles", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "sezc_certificate", "title": "Certificate of SEZC registration (s.182B)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_memorandum", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_name", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.182A with certified special resolutions", "channel": "online", "government_fee": { "amount": 925, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "holds_section_174_licence", "type": null, "when": "Company holds a s.174 licence (s.182A)" }, { "code": "name_suffix_missing", "type": null, "when": "Name lacks 'Special Economic Zone Company' or 'SEZC'" }, { "code": "company_not_in_good_standing", "type": null, "when": "Annual fee or filings outstanding" } ] } }, "Params_ky_company_convert_to_spc": { "type": "object", "properties": { "name": { "type": "string", "description": "New name with 'SPC' or 'Segregated Portfolio Company'" }, "statement_date": { "type": "string", "format": "date", "description": "Date of the assets and liabilities statement; within 3 months before the declaration (s.214)" }, "portfolios": { "type": "array", "items": {}, "description": "Each portfolio: name and assets and liabilities moving into it (s.214)" }, "creditor_route": { "type": "string", "enum": [ "all_creditors_consented", "notice_and_95_percent_by_value" ], "description": "How creditors agree (s.214)" }, "cima_licensed": { "type": "boolean", "description": "Licensed by CIMA, so written consent is needed (s.214)" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "name", "statement_date", "portfolios", "creditor_route", "cima_licensed" ], "description": "Under s.213 an existing exempted company becomes an SPC. At least two directors declare assets and liabilities, the portfolios and what moves into each, solvency, and creditor consent." }, "Create_ky_company_convert_to_spc": { "type": "object", "properties": { "type": { "const": "ky.company.convert_to_spc" }, "params": { "$ref": "#/components/schemas/Params_ky_company_convert_to_spc" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert an exempted company into a segregated portfolio company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "directors_declaration_spc", "title": "Declaration by at least two directors (s.214)", "source": "generated", "required": true }, { "key": "special_resolution_asset_transfer", "title": "Special resolution authorising transfer into portfolios", "source": "generated", "required": true }, { "key": "special_resolution_name", "title": "Special resolution changing the name to include SPC", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "creditor_consents_or_notices", "title": "Creditor consents, or notices to creditors owed over CI$1,000", "source": "uploaded", "required": true }, { "key": "cima_consent", "title": "CIMA written consent", "source": "uploaded", "required": false }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "spc_certificate", "title": "Certificate showing SPC registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution_asset_transfer", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "special_resolution_name", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_declaration_spc", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application under Companies Act s.213 with s.214", "channel": "online", "government_fee": { "amount": 500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fewer_than_two_directors_declaring", "type": null, "when": "Fewer than two directors signed the declaration" }, { "code": "statement_too_old", "type": null, "when": "Assets statement is over 3 months old" }, { "code": "creditor_threshold_not_met", "type": null, "when": "Creditor consent or 95% by value not reached" } ] } }, "Params_ky_company_merge": { "type": "object", "properties": { "merger_type": { "type": "string", "enum": [ "merger", "consolidation" ], "description": "Merger into a survivor, or consolidation into a new company" }, "constituents": { "type": "array", "items": {}, "description": "Each constituent: Cayman entity_id or overseas company details, and whether it survives" }, "surviving_company_jurisdiction": { "type": "string", "enum": [ "cayman", "overseas" ], "description": "Where the survivor or consolidated company sits" }, "surviving_company_name": { "type": "string", "description": "Name of the surviving or consolidated company (s.233)" }, "share_exchange_terms": { "type": "object", "description": "How shares convert into shares, debt, cash or other property (s.233,)" }, "effective_date": { "type": "string", "format": "date", "description": "Later effective date, at most 90 days after registration" }, "director_benefits": { "type": "string", "description": "Benefits payable to any director because of the merger (s.233)" }, "secured_creditors": { "type": "array", "items": {}, "description": "Name, address and security of each secured creditor (s.233)" }, "parent_subsidiary_short_form": { "type": "boolean", "description": "Parent holding 90% or more of votes merges its subsidiary (s.233)" }, "regulated_constituent": { "type": "boolean", "description": "A constituent is a CIMA licensee (s.233)" }, "request_pre_clearance": { "type": "boolean", "description": "Registry reviews the draft plan before signing" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "merger_type", "constituents", "surviving_company_jurisdiction", "surviving_company_name", "share_exchange_terms" ], "description": "Companies limited by shares merge or consolidate under Companies Act s.233, or with an overseas company under s.237. Directors approve a written plan; members pass a special resolution; secured creditors consent; a director of each." }, "Create_ky_company_merge": { "type": "object", "properties": { "type": { "const": "ky.company.merge" }, "params": { "$ref": "#/components/schemas/Params_ky_company_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge or consolidate Cayman companies, or with an overseas company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc", "ordinary_resident_company", "ordinary_nonresident_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "plan_of_merger", "title": "Written plan of merger or consolidation (s.233-)", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution of each constituent's members (s.233)", "source": "generated", "required": true }, { "key": "directors_declarations", "title": "Declarations per constituent: solvency, bona fides, no proceedings, assets and liabilities.", "source": "generated", "required": true }, { "key": "certificates_of_good_standing", "title": "Certificate of good standing per constituent", "source": "registry_issued", "required": false }, { "key": "secured_creditor_consents", "title": "Consent of each secured creditor (s.233)", "source": "uploaded", "required": false }, { "key": "overseas_constituent_declaration", "title": "Overseas constituent director's declaration that s.237- is met", "source": "uploaded", "required": false }, { "key": "evidence_of_overseas_merger", "title": "Overseas survivor: evidence of the merger and its effective date (s.237)", "source": "uploaded", "required": false }, { "key": "dissenter_payment_undertaking", "title": "Overseas survivor: undertaking to pay dissenters (s.237)", "source": "uploaded", "required": false }, { "key": "gazette_notice", "title": "Gazette notice of the merger (undertaking in s.233)", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_merger", "title": "Certificate of merger, or of strike off by way of merger with an overseas company", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "each", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "plan_of_merger", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_declarations", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "overseas_constituent_declaration", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_consents", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Plan of merger or consolidation under Companies Act s.233", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "spc_cannot_merge", "type": null, "when": "A constituent is a segregated portfolio company" }, { "code": "secured_creditor_consent_missing", "type": null, "when": "A secured creditor has not consented and no Court waiver (s.233)" }, { "code": "declaration_missing", "type": null, "when": "A constituent lacks the director declarations (s.233)" } ] } }, "Params_ky_continuation_in_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "llc", "llp" ], "description": "Cayman entity to become" }, "foreign_entity_name": { "type": "string", "description": "Current name" }, "foreign_jurisdiction": { "type": "string", "description": "Jurisdiction of incorporation or registration" }, "foreign_registration_number": { "type": "string", "description": "Registration number there" }, "name": { "type": "string", "description": "Cayman name; for a company it must be acceptable under s.30" }, "name_change_undertaking": { "type": "boolean", "description": "Company or LLP will change to an acceptable name within 60 days (s.201; LLP s.39)" }, "nature_of_business": { "type": "string", "description": "Nature of business" }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Company: sets the registration fee band" }, "operations_outside_islands": { "type": "boolean", "description": "Company and LLC: operations mainly outside the Islands (s.201; LLC s.5)" }, "officers": { "type": "array", "items": {}, "description": "Directors, managers or partners" }, "members": { "type": "array", "items": {}, "description": "Initial LLC members (s.5) or LLP partners (s.18)" }, "formation_history": { "type": "object", "description": "LLC: date and place of first formation and any later migrations (s.54)" }, "effective_date": { "type": "string", "format": "date", "description": "LLC: future effective date (s.54)" }, "financial_year_end": { "type": "string", "format": "date", "description": "LLC and LLP: month and day" }, "term": { "type": "string", "description": "LLC and LLP term, if not unlimited" }, "concurrent_registration": { "type": "string", "enum": [ "none", "ldc", "sezc", "spc" ], "description": "Company only: also register as LDC, SEZC or SPC (ss.178, 182A, 213)" }, "needs_cayman_licence": { "type": "boolean", "description": "Will need a licence to operate; obtained first (s.201; LLC s.54)" }, "assets_and_liabilities_date": { "type": "string", "format": "date", "description": "Date of the statement in the declaration" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "entity_type", "foreign_entity_name", "foreign_jurisdiction", "foreign_registration_number", "name", "nature_of_business", "officers", "assets_and_liabilities_date" ], "description": "A foreign body corporate becomes an exempted company, a foreign entity with separate legal personality becomes an LLC, or a foreign LLP or LP becomes an LLP. Same legal entity; it must stop existing in its old jurisdiction." }, "Create_ky_continuation_in_apply": { "type": "object", "properties": { "type": { "const": "ky.continuation_in.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_continuation_in_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a foreign company, LLC or LLP into the Cayman Islands", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "llc", "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "foreign_certificate_of_incorporation", "title": "Certified certificate of incorporation or registration (s.184)", "source": "uploaded", "required": true }, { "key": "foreign_good_standing", "title": "Certificate of good standing dated within one month (s.184)", "source": "uploaded", "required": true }, { "key": "foreign_constitutional_documents", "title": "Certified charter documents (s.184)", "source": "uploaded", "required": true }, { "key": "foreign_law_confirmation", "title": "Counsel's confirmation the jurisdiction permits the transfer", "source": "uploaded", "required": true }, { "key": "transfer_approval", "title": "Approval of the transfer under the charter documents", "source": "uploaded", "required": true }, { "key": "third_party_consents", "title": "Contractual consents to the transfer, or waivers", "source": "uploaded", "required": false }, { "key": "continuation_declaration", "title": "Declaration or affidavit with statement of assets and liabilities (s.201; LLC s.54; LLP s.39)", "source": "generated", "required": true }, { "key": "operations_declaration", "title": "Director's declaration: operations mainly outside the Islands (s.201)", "source": "generated", "required": false }, { "key": "secured_creditor_undertaking", "title": "Undertaking that secured creditors are or will be notified within 21 days", "source": "generated", "required": true }, { "key": "application", "title": "Application, and registration statement for an LLC or LLP", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_continuation", "title": "Certificate of registration by way of continuation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "continuation_declaration", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "operations_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for continuation: Companies Act s.201", "channel": "online", "government_fee": { "amount": 700, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_law_does_not_permit_transfer", "type": null, "when": "The foreign jurisdiction does not permit the transfer" }, { "code": "insolvency_proceedings_pending", "type": null, "when": "Winding-up, receiver or creditor scheme in any jurisdiction" }, { "code": "name_not_acceptable", "type": null, "when": "Name refused and no undertaking to change" } ] } }, "Params_ky_continuation_out_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "llc", "elp", "llp" ], "description": "Entity leaving the Cayman register" }, "destination_jurisdiction": { "type": "string", "description": "Jurisdiction it will continue in" }, "destination_form": { "type": "string", "description": "Form it will take there; a company must stay a body corporate limited by shares (s.206)" }, "name": { "type": "string", "description": "New name, if it changes (s.206)" }, "destination_registered_office": { "$ref": "#/components/schemas/Address", "description": "Proposed registered office or agent for service of process there" }, "cima_licensed": { "type": "boolean", "description": "Licensed or registered with CIMA, so its consent is needed" }, "has_secured_creditors": { "type": "boolean", "description": "Secured creditors must be notified within 21 days" }, "assets_and_liabilities_date": { "type": "string", "format": "date", "description": "Date of the statement in the declaration" }, "regulated_elp": { "type": "boolean", "description": "ELP only: CIMA-regulated, which sets the fee tier" }, "provisional_deregistration": { "type": "boolean", "description": "LLP only: ask for provisional deregistration first (s.38)" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "entity_type", "destination_jurisdiction", "destination_form", "destination_registered_office", "cima_licensed", "has_secured_creditors", "assets_and_liabilities_date" ], "description": "Deregistration to continue abroad: exempted company, LDC or SPC, LLC, ELP or LLP. A director, authorised signatory or general partner declares that there is no winding-up, receiver or creditor scheme, that the entity can pay its debts, and." }, "Create_ky_continuation_out_apply": { "type": "object", "properties": { "type": { "const": "ky.continuation_out.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_continuation_out_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a Cayman company, LLC, ELP or LLP to continue in another jurisdiction", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "llc", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "approval_under_constitution", "title": "Resolution approving the transfer under the memorandum, LLC agreement or partnership agreement", "source": "generated", "required": true }, { "key": "continuation_declaration", "title": "Declaration or affidavit with statement of assets and liabilities (s.206; LLC s.55; ELP s.43-; LLP.", "source": "generated", "required": true }, { "key": "secured_creditor_undertaking", "title": "Undertaking to notify secured creditors within 21 days", "source": "generated", "required": true }, { "key": "destination_law_confirmation", "title": "Counsel's confirmation the destination permits the transfer", "source": "uploaded", "required": true }, { "key": "third_party_consents", "title": "Contractual consents to the transfer, or waivers", "source": "uploaded", "required": false }, { "key": "cima_consent", "title": "CIMA consent to the transfer", "source": "uploaded", "required": false }, { "key": "destination_registration_evidence", "title": "Evidence of re-registration at the destination", "source": "uploaded", "required": false }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_deregistration", "title": "Certificate of deregistration", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "approval_under_constitution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "continuation_declaration", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application to deregister: Companies Act s.206, LLC Act s.55, ELP Act s.43, LLP Act s.38", "channel": "online", "government_fee": { "amount": 2775, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "insolvency_proceedings_pending", "type": null, "when": "Winding-up, receiver or creditor scheme pending" }, { "code": "cima_consent_missing", "type": null, "when": "Licensed or registered and no CIMA consent" }, { "code": "fees_outstanding", "type": null, "when": "Good standing or fees outstanding (LLC s.55; ELP s.43)" } ] } }, "Params_ky_elp_continue_out": { "type": "object", "properties": { "destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the relevant jurisdiction (s.43).", "examples": [ "US" ] }, "destination_entity_form": { "type": "string", "description": "What the ELP becomes abroad: a partnership, body corporate or other entity, e.g. 'Delaware limited partnership' (s.43)." }, "proposed_name_abroad": { "type": "string", "description": "Name abroad incl. any dual foreign name; repeat the current name if unchanged (s.43)." }, "proposed_registered_office_abroad": { "$ref": "#/components/schemas/Address", "description": "Registered office abroad (s.43)." }, "planned_continuation_date": { "type": "string", "format": "date", "description": "Expected date of foreign registration." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Often a director of the corporate GP; makes the s.43 declaration and signs the undertaking." }, "statement_date": { "type": "string", "format": "date", "description": "Assets-and-liabilities statement date, as close as practicable to the declaration (s.43); within about 30 days of filing in practice." }, "has_secured_creditors": { "type": "boolean", "description": "s.43." }, "cima_regime": { "type": "array", "items": {}, "description": "CIMA regimes it is licensed or registered under: banks_and_trust, companies_management, insurance, mutual_funds, private_funds, securities_investment_business." }, "regulated_fee_tier": { "type": "boolean", "description": "True if the Registry charges the 'regulated' annual fee rather than 3x CI$2,100." }, "limited_partner_approval_required": { "type": "boolean", "description": "Whether the agreement needs LP approval (s.43)." }, "declaration_facts": { "type": "object", "description": "Draft booleans, keys as in the example: no_insolvency_events, able_to_pay_debts, bona_fide, consents_and_approvals_obtained, destination_law_complied_with." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express." } }, "required": [ "destination_country", "destination_entity_form", "proposed_name_abroad", "proposed_registered_office_abroad", "planned_continuation_date", "authorised_signatory", "statement_date", "has_secured_creditors", "cima_regime", "regulated_fee_tier", "limited_partner_approval_required", "declaration_facts" ], "description": "A general partner deregisters an ELP so it can continue abroad. The ELP must be solvent and in good standing; an authorised signatory files a notarised declaration or affidavit with a statement of assets and liabilities, and the ELP pays." }, "Create_ky_elp_continue_out": { "type": "object", "properties": { "type": { "const": "ky.elp.continue_out" }, "params": { "$ref": "#/components/schemas/Params_ky_elp_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister an ELP to continue abroad", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Current partnership agreement", "source": "uploaded", "required": true }, { "key": "gp_and_lp_approvals", "title": "Certified GP resolutions and, if required, LP resolutions", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "s43_declaration", "title": "Declaration or affidavit of the authorised signatory (s.43)", "source": "generated", "required": true }, { "key": "secured_creditor_undertaking", "title": "21-day secured-creditor undertaking (s.43)", "source": "generated", "required": true }, { "key": "deregistration_application", "title": "GP's application with notices of name, form and office changes (s.43,)", "source": "generated", "required": true }, { "key": "cima_consent", "title": "CIMA consent", "source": "uploaded", "required": false }, { "key": "certificate_of_deregistration", "title": "Certificate of de-registration and Gazette notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "gp_and_lp_approvals", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "s43_declaration", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "deregistration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application to de-register, ELP Act s.43, with s.43", "channel": "online", "government_fee": { "amount": 6300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "Unpaid fees or missing return (s.43). [registry_error]" }, { "code": "winding_up_or_insolvency_in_progress", "type": null, "when": "declaration_facts reports an insolvency event or inability to pay. [requirement_error]" }, { "code": "cima_consent_required", "type": null, "when": "cima_regime is not empty and no consent is uploaded. [requirement_error]" } ] } }, "Params_ky_exempted_company_convert_resident": { "type": "object", "properties": { "name": { "type": "string", "description": "New name, if any; must be one an ordinary resident company can use (s.211A)." }, "authorised_share_capital": { "$ref": "#/components/schemas/Money", "description": "In minor units." }, "memorandum_alterations_summary": { "type": "string", "description": "Changes needed to fit an ordinary resident company (s.211A)." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "Director who signs the application (s.211A)." }, "resolution_route": { "type": "string", "enum": [ "general_meeting", "written_resolution_all_members" ], "description": "Special resolution at a meeting or in writing by all members if the articles allow (s.60)." }, "intends_local_trading": { "type": "boolean", "description": "If true the partner checks licensing and Local Companies before filing." }, "acknowledges_tax_undertaking_lapses": { "type": "boolean", "description": "Must be true (s.211B)." } }, "required": [ "authorised_share_capital", "memorandum_alterations_summary", "signing_director", "resolution_route", "intends_local_trading", "acknowledges_tax_undertaking_lapses" ], "description": "Turns an exempted company into an ordinary resident company by special resolution altering its constitution, with a director-signed application and the ordinary resident registration fee. The tax undertaking lapses and local trading needs." }, "Create_ky_exempted_company_convert_resident": { "type": "object", "properties": { "type": { "const": "ky.exempted_company.convert_resident" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_company_convert_resident" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register an exempted company as an ordinary resident company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the re-registration", "source": "generated", "required": true }, { "key": "special_resolution", "title": "Special resolution altering the memorandum and articles", "source": "generated", "required": true }, { "key": "altered_memorandum_and_articles", "title": "Memorandum and articles as altered (s.211A)", "source": "generated", "required": true }, { "key": "reregistration_application", "title": "Application for re-registration", "source": "generated", "required": true }, { "key": "certificate_of_reregistration", "title": "Certificate of re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "reregistration_application", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reregistration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for re-registration as an ordinary resident company, Companies Act s.211A, wit", "channel": "online", "government_fee": { "amount": 300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_subtype_not_supported", "type": null, "when": "Company is an LDC, SPC or SEZC; only a plain exempted company is covered. [jurisdiction_error]" }, { "code": "name_not_acceptable", "type": null, "when": "new_name cannot be used by an ordinary resident company. [registry_error]" }, { "code": "articles_do_not_allow_written_resolution", "type": null, "when": "Written route chosen but the articles do not authorise it. [requirement_error]" } ] } }, "Params_ky_foreign_partnership_convert_to_elp": { "type": "object", "properties": { "home_jurisdiction": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the law it is established under.", "examples": [ "US" ] }, "current_name": { "type": "string", "description": "Current name under home law." }, "home_law_permits_registration_as_elp": { "type": "boolean", "description": "Whether home law allows it; s.40 does not require this but a conflict defeats the move in practice." }, "elp_name": { "type": "string", "description": "Must include 'Limited Partnership', 'L.P.' or 'LP' (s.6).", "examples": [ "Harbour Point Fund I L.P." ] }, "nature_of_business": { "type": "string", "description": "s.9." }, "term": { "type": "object", "description": "{unlimited: boolean, end_date?: date, commencement_date: date} (s.9)." }, "general_partners": { "type": "array", "items": {}, "description": "Items {person, kind: individual|company|partnership, cayman_qualifying}." }, "limited_partners": { "type": "array", "items": {}, "description": "Items {person, interest_percent, capital_commitment}; for CDD and the BO register." }, "partnership_agreement_amendment_required": { "type": "boolean", "description": "True if the agreement needs amending to comply with the ELP Act (s.40)." }, "confirm_no_business_with_public_in_islands": { "type": "boolean", "description": "Must be true: the s.9 declaration." }, "signing_general_partner": { "type": "string", "pattern": "^per_", "description": "GP, or individual for a corporate GP, who signs the s.9 statement." }, "cima_registered": { "type": "boolean", "description": "True if registered with CIMA; the partner checks what CIMA needs." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express (CI$500 per the batch; s.13 names ss.9 and 42, so confirm it covers s.40)." } }, "required": [ "home_jurisdiction", "current_name", "home_law_permits_registration_as_elp", "elp_name", "nature_of_business", "term", "general_partners", "partnership_agreement_amendment_required", "confirm_no_business_with_public_in_islands", "signing_general_partner", "cima_registered" ], "description": "Registers a partnership established under another jurisdiction's law as a Cayman ELP, with no new legal entity: agreement amended if needed, CI$1,000 paid, GP-signed s.9 statement filed. Full CDD runs because no entity record exists yet." }, "Create_ky_foreign_partnership_convert_to_elp": { "type": "object", "properties": { "type": { "const": "ky.foreign_partnership.convert_to_elp" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_partnership_convert_to_elp" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a foreign partnership as an ELP", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "elp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "current_partnership_agreement", "title": "Current partnership agreement", "source": "uploaded", "required": true }, { "key": "home_registration_evidence", "title": "Home certificate of formation or registration", "source": "uploaded", "required": true }, { "key": "register_of_partners", "title": "Register of partners with interests", "source": "uploaded", "required": true }, { "key": "partnership_agreement_amendment", "title": "Amendment to the partnership agreement", "source": "generated", "required": false }, { "key": "elp_registration_statement", "title": "Statement under ELP Act s.9", "source": "generated", "required": true }, { "key": "gp_documents", "title": "GP evidence: corporate certificates, or individual ID and Cayman address (s.9)", "source": "uploaded", "required": false }, { "key": "certificate_of_registration", "title": "ELP certificate of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement_amendment", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "elp_registration_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "elp_registration_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Statement under ELP Act s.9", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_qualifying_general_partner", "type": null, "when": "No GP meets s.4. [requirement_error]" }, { "code": "public_business_declaration_not_given", "type": null, "when": "confirm_no_business_with_public_in_islands is false. [requirement_error]" }, { "code": "home_registration_not_evidenced", "type": null, "when": "No evidence the partnership exists. [requirement_error]" } ] } }, "Params_ky_foundation_company_convert_exempted": { "type": "object", "properties": { "exempted_company_name": { "type": "string", "description": "Name in the new memorandum; must meet the Companies Act naming rules.", "examples": [ "Harbour Point Holdings Ltd." ] }, "authorised_share_capital": { "$ref": "#/components/schemas/Money", "description": "In minor units; sets the fee band (s.169)." }, "nature_of_business": { "type": "string", "description": "For the memorandum and annual declaration." }, "operations_outside_islands_confirmed": { "type": "boolean", "description": "Objects mainly outside the Islands. 'Registration declaration' is undefined in the Act; this follows s.165." }, "directors": { "type": "array", "items": {}, "description": "Future directors, each {person}." }, "initial_shareholders": { "type": "array", "items": {}, "description": "Each {person, shares}." }, "reserved_powers_cleared": { "type": "boolean", "description": "Whether the founder, guardian, supervisor and other reserved-power holders have consented; the constitution decides." }, "signing_director": { "type": "string", "pattern": "^per_", "description": "Director or authorised person who signs the application (s.233B)." } }, "required": [ "exempted_company_name", "authorised_share_capital", "nature_of_business", "operations_outside_islands_confirmed", "directors", "reserved_powers_cleared", "signing_director" ], "description": "Converts a Cayman foundation company into an exempted company by special resolution and a director-signed application; the fee equals the exempted annual fee for the capital band. Under the Registry's interim measure the documents are." }, "Create_ky_foundation_company_convert_exempted": { "type": "object", "properties": { "type": { "const": "ky.foundation_company.convert_exempted" }, "params": { "$ref": "#/components/schemas/Params_ky_foundation_company_convert_exempted" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a foundation company as an exempted company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "special_resolution", "title": "Special resolution adopting the registration declaration and memorandum and articles (s.233B-)", "source": "generated", "required": true }, { "key": "registration_declaration", "title": "Registration declaration", "source": "generated", "required": true }, { "key": "memorandum_and_articles", "title": "Memorandum and articles of the exempted company", "source": "generated", "required": true }, { "key": "foundation_constitution", "title": "Current foundation company constitution", "source": "uploaded", "required": true }, { "key": "consent_to_act", "title": "Incoming directors' consents to act", "source": "generated", "required": true }, { "key": "reregistration_application", "title": "Application, with good standing certificate (s.233B); emailed to cigenreg@gov.ky", "source": "generated", "required": true }, { "key": "certificate_of_reregistration", "title": "Certificate of re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "founder", "verification_level": "identity_address" }, { "role": "council_member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registration_declaration", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "reregistration_application", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reregistration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for re-registration as an exempted company, Companies Act s.233B, emailed to c", "channel": "online", "government_fee": { "amount": 925, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "special_resolution_not_passed", "type": null, "when": "Not passed as the articles require. [requirement_error]" }, { "code": "reserved_powers_not_cleared", "type": null, "when": "reserved_powers_cleared is false. [requirement_error]" }, { "code": "entity_not_in_good_standing", "type": null, "when": "No good standing certificate can issue. [registry_error]" } ] } }, "Params_ky_llc_continue_out": { "type": "object", "properties": { "destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the relevant jurisdiction (s.55).", "examples": [ "US" ] }, "destination_entity_form": { "type": "string", "description": "Foreign entity form the LLC becomes (s.55).", "examples": [ "Delaware limited liability company" ] }, "proposed_name_abroad": { "type": "string", "description": "Name abroad; repeat the current name if unchanged (s.55)." }, "proposed_registered_office_abroad": { "$ref": "#/components/schemas/Address", "description": "Registered office or equivalent abroad; add the agent for service in the notice if needed." }, "planned_continuation_date": { "type": "string", "format": "date", "description": "Expected date of foreign registration; Cayman deregistration must come first." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Manager or authorised person who makes the s.55 declaration and signs the undertaking." }, "statement_date": { "type": "string", "format": "date", "description": "Date the assets-and-liabilities statement is made up to: latest practicable date, about 30 days before filing in practice." }, "has_secured_creditors": { "type": "boolean", "description": "Whether there are secured creditors (s.55)." }, "cima_status": { "type": "string", "enum": [ "none", "licensed_or_registered", "previously_licensed_suspended_or_revoked" ], "description": "Any current or revoked CIMA licence or registration needs CIMA consent (s.55)." }, "approval_basis": { "type": "string", "enum": [ "member_vote", "written_consent_of_members", "managers_resolution", "other" ], "description": "How the LLC agreement approves the transfer (s.55); the Act sets no threshold." }, "declaration_facts": { "type": "object", "description": "Draft booleans, keys as in the example: no_insolvency_events, able_to_pay_debts, bona_fide, consents_and_approvals_obtained, destination_law_complied_with." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express." } }, "required": [ "destination_country", "destination_entity_form", "proposed_name_abroad", "proposed_registered_office_abroad", "planned_continuation_date", "authorised_signatory", "statement_date", "has_secured_creditors", "cima_status", "approval_basis", "declaration_facts" ], "description": "Deregisters a Cayman LLC so it can continue as a foreign entity abroad. The LLC must be solvent and in good standing; an authorised signatory files a notarised declaration or affidavit with a statement of assets and liabilities, and the." }, "Create_ky_llc_continue_out": { "type": "object", "properties": { "type": { "const": "ky.llc.continue_out" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a Cayman LLC to continue abroad", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "llc_agreement", "title": "Current LLC agreement", "source": "uploaded", "required": true }, { "key": "approval_consent", "title": "Members' or managers' consent to the continuation", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "s55_declaration", "title": "Declaration or affidavit of the authorised signatory (s.55)", "source": "generated", "required": true }, { "key": "secured_creditor_undertaking", "title": "21-day secured-creditor undertaking (s.55)", "source": "generated", "required": true }, { "key": "deregistration_application", "title": "Application to deregister, with notice of proposed name and office abroad (s.55)", "source": "generated", "required": true }, { "key": "cima_consent", "title": "CIMA consent", "source": "uploaded", "required": false }, { "key": "certificate_of_deregistration", "title": "Certificate of deregistration and Gazette notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "approval_consent", "signer_role": "member", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "s55_declaration", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "deregistration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application to deregister, LLC Act s.55, with s.55", "channel": "online", "government_fee": { "amount": 3300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "Unpaid fees or missing annual return (s.55). [registry_error]" }, { "code": "winding_up_or_insolvency_in_progress", "type": null, "when": "declaration_facts reports an insolvency event or inability to pay. [requirement_error]" }, { "code": "cima_consent_required", "type": null, "when": "cima_status is not none and no consent is uploaded. [requirement_error]" } ] } }, "Params_ky_llc_convert_exempted": { "type": "object", "properties": { "exempted_company_name": { "type": "string", "description": "Name in the new memorandum; must meet the Companies Act naming rules.", "examples": [ "Harbour Point Holdings Ltd." ] }, "authorised_share_capital": { "$ref": "#/components/schemas/Money", "description": "In minor units; sets the fee band (s.169)." }, "nature_of_business": { "type": "string", "description": "For the memorandum and annual declaration." }, "operations_outside_islands_confirmed": { "type": "boolean", "description": "Objects mainly outside the Islands. 'Registration declaration' is undefined in the Act; this follows s.165." }, "directors": { "type": "array", "items": {}, "description": "Future directors, each {person}." }, "conversion_consent_basis": { "type": "string", "enum": [ "two_thirds_of_members", "llc_agreement_alternative" ], "description": "Two-thirds of members, or the alternative the LLC agreement expressly allows (s.233A)." }, "member_share_allocation": { "type": "array", "items": {}, "description": "Per member {member, llc_interest_percent, shares, par_value, issue_basis: par|discount|premium} (s.233A)." }, "signing_manager": { "type": "string", "pattern": "^per_", "description": "Manager or authorised person who signs the application (s.233A)." } }, "required": [ "exempted_company_name", "authorised_share_capital", "nature_of_business", "operations_outside_islands_confirmed", "directors", "conversion_consent_basis", "member_share_allocation", "signing_manager" ], "description": "Converts a Cayman LLC into an exempted company on two-thirds member consent. A manager signs the application; the fee equals the exempted annual fee for the capital band." }, "Create_ky_llc_convert_exempted": { "type": "object", "properties": { "type": { "const": "ky.llc.convert_exempted" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_convert_exempted" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a Cayman LLC as an exempted company", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "conversion_consent", "title": "Members' consent adopting the registration declaration and memorandum and articles (s.233A-)", "source": "generated", "required": true }, { "key": "registration_declaration", "title": "Registration declaration", "source": "generated", "required": true }, { "key": "memorandum_and_articles", "title": "Memorandum and articles of the exempted company", "source": "generated", "required": true }, { "key": "llc_agreement", "title": "Current LLC agreement", "source": "uploaded", "required": true }, { "key": "consent_to_act", "title": "Incoming directors' consents to act", "source": "generated", "required": true }, { "key": "reregistration_application", "title": "Application for re-registration, with the LLC's good standing certificate (s.233A)", "source": "generated", "required": true }, { "key": "certificate_of_reregistration", "title": "Certificate of re-registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "conversion_consent", "signer_role": "member", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "registration_declaration", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "reregistration_application", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reregistration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for re-registration as an exempted company, Companies Act s.233A, with the reg", "channel": "online", "government_fee": { "amount": 925, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "consent_threshold_not_met", "type": null, "when": "Less than two-thirds of members. [requirement_error]" }, { "code": "entity_not_in_good_standing", "type": null, "when": "No good standing certificate can issue. [registry_error]" }, { "code": "share_allocation_invalid", "type": null, "when": "member_share_allocation misses a member or exceeds the authorised capital. [invalid_request_error]" } ] } }, "Params_ky_llc_merge": { "type": "object", "properties": { "merge_type": { "type": "string", "enum": [ "merger", "consolidation" ], "description": "Merger or consolidation" }, "counterparty_type": { "type": "string", "enum": [ "llc", "exempted_company", "foreign_entity" ], "description": "What the LLC merges with" }, "constituents": { "type": "array", "items": {}, "description": "Each constituent: Cayman entity_id or foreign entity details, and whether it survives" }, "surviving_entity_jurisdiction": { "type": "string", "enum": [ "cayman", "overseas" ], "description": "Where the survivor sits" }, "surviving_entity_name": { "type": "string", "description": "Name of the survivor or consolidated entity (s.46)" }, "interest_exchange_terms": { "type": "object", "description": "How LLC interests convert (s.46,)" }, "effective_date": { "type": "string", "format": "date", "description": "Later effective date, at most 90 days after registration" }, "llc_agreement_changes": { "type": "string", "description": "Amendment or new LLC agreement taking effect on merger (s.46)" }, "secured_creditors": { "type": "array", "items": {}, "description": "Secured creditors of each constituent (s.46)" }, "parent_subsidiary_short_form": { "type": "boolean", "description": "Parent entity merges its subsidiary; plan sent to every subsidiary member (s.46)" }, "request_pre_clearance": { "type": "boolean", "description": "Registry reviews the draft plan before signing" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "merge_type", "counterparty_type", "constituents", "surviving_entity_jurisdiction", "surviving_entity_name", "interest_exchange_terms" ], "description": "LLC Act ss.46-51. Managers approve a written plan; two-thirds in number of the members of each LLC approve it; secured creditors consent; a manager of each constituent signs the plan and gives declarations." }, "Create_ky_llc_merge": { "type": "object", "properties": { "type": { "const": "ky.llc.merge" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge or consolidate LLCs, or an LLC with an exempted company or foreign entity", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Written plan of merger or consolidation (s.46-)", "source": "generated", "required": true }, { "key": "managers_approval", "title": "Managers' approval of the plan (s.46)", "source": "generated", "required": true }, { "key": "members_approval", "title": "Member approval for each constituent (s.46)", "source": "generated", "required": true }, { "key": "managers_declarations", "title": "Declarations per constituent: solvency, bona fides, no proceedings, assets and liabilities.", "source": "generated", "required": true }, { "key": "certificates_of_good_standing", "title": "Certificate of good standing per constituent", "source": "registry_issued", "required": false }, { "key": "secured_creditor_consents", "title": "Consent of each secured creditor (s.46)", "source": "uploaded", "required": false }, { "key": "foreign_entity_declaration", "title": "Foreign entity manager's declaration that s.51- is met", "source": "uploaded", "required": false }, { "key": "evidence_of_foreign_merger", "title": "Foreign survivor: evidence of the merger and effective date (s.51)", "source": "uploaded", "required": false }, { "key": "gazette_notice", "title": "Gazette notice of the merger (undertaking in s.46)", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_merger", "title": "Certificate of merger, or of strike off by way of merger", "source": "registry_issued", "required": false } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "creditors", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "managers_approval", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_approval", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "plan_of_merger", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "managers_declarations", "signer_role": "manager", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "foreign_entity_declaration", "signer_role": "manager", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Plan of merger or consolidation under LLC Act ss.46-51, with the manager declarations", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "spc_cannot_merge", "type": null, "when": "A constituent company is a segregated portfolio company (s.50)" }, { "code": "member_threshold_not_met", "type": null, "when": "Fewer than two-thirds of an LLC's members approved" }, { "code": "secured_creditor_consent_missing", "type": null, "when": "A secured creditor has not consented and no Court waiver" } ] } }, "Params_ky_llp_continue_in": { "type": "object", "properties": { "home_jurisdiction": { "type": "string", "description": "ISO 3166-1 alpha-2 code.", "examples": [ "US" ] }, "name_before_continuation": { "type": "string", "description": "Name under home law." }, "llp_name": { "type": "string", "description": "Cayman name; must meet s.8 or be changed within 60 days under an undertaking (s.39)." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office in the Islands (s.18)." }, "nature_of_business": { "type": "string", "description": "s.18." }, "financial_year_end": { "type": "string", "format": "date", "description": "MM-DD (s.18)." }, "partners": { "type": "array", "items": {}, "description": "At least two items {person, kind: individual|company|partnership, managing_partner} (s.4, s.18)." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Partner who makes the s.39 declaration and signs the undertaking." }, "regulated_activity": { "type": "boolean", "description": "True if the LLP needs a licence to operate in or from the Islands; obtain it first (s.39)." }, "home_good_standing_date": { "type": "string", "format": "date", "description": "Date of the home good standing certificate; the Registry manual wants one within 30 days of application." }, "statement_date": { "type": "string", "format": "date", "description": "Date of the assets-and-liabilities statement (s.39)." }, "declaration_facts": { "type": "object", "description": "Draft booleans as for continuation out, plus will_cease_to_exist_under_home_law (s.39-,-,)." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express." } }, "required": [ "home_jurisdiction", "name_before_continuation", "llp_name", "registered_office", "nature_of_business", "financial_year_end", "partners", "authorised_signatory", "regulated_activity", "home_good_standing_date", "statement_date", "declaration_facts" ], "description": "Registers a foreign LLP or limited partnership from a recognised jurisdiction as a Cayman LLP by continuation: home certificates, a registration statement, a creditor undertaking and a notarised declaration, with the CI$1,000 LLP." }, "Create_ky_llp_continue_in": { "type": "object", "properties": { "type": { "const": "ky.llp.continue_in" }, "params": { "$ref": "#/components/schemas/Params_ky_llp_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a foreign LLP into Cayman as an LLP", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "home_registration_documents", "title": "Home certificate of registration and registration statement", "source": "uploaded", "required": true }, { "key": "home_good_standing", "title": "Home good standing certificate", "source": "uploaded", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "llp_registration_statement", "title": "LLP registration statement (s.18, s.39)", "source": "generated", "required": true }, { "key": "continuation_letter", "title": "Letter applying for continuation", "source": "generated", "required": true }, { "key": "secured_creditor_undertaking", "title": "21-day secured-creditor undertaking (s.39)", "source": "generated", "required": true }, { "key": "s39_declaration", "title": "Declaration or affidavit with statement of assets and liabilities (s.39)", "source": "generated", "required": true }, { "key": "licence_evidence", "title": "Licence for regulated activity", "source": "uploaded", "required": false }, { "key": "certificate_of_registration", "title": "Certificate of registration by continuation and Gazette notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "llp_registration_statement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s39_declaration", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "llp_registration_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Registration", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "jurisdiction_not_recognised", "type": null, "when": "home_jurisdiction is not recognised (s.39). [jurisdiction_error]" }, { "code": "fewer_than_two_partners", "type": null, "when": "partners has fewer than two persons (s.4). [invalid_request_error]" }, { "code": "home_certificate_stale", "type": null, "when": "Home good standing certificate older than 30 days. [requirement_error]" } ] } }, "Params_ky_llp_continue_out": { "type": "object", "properties": { "destination_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the relevant jurisdiction (s.38).", "examples": [ "US" ] }, "destination_entity_form": { "type": "string", "description": "Form the LLP takes abroad (s.38)." }, "proposed_name_abroad": { "type": "string", "description": "Name abroad; repeat the current name if unchanged (s.38)." }, "proposed_registered_office_abroad": { "$ref": "#/components/schemas/Address", "description": "Registered office abroad (s.38)." }, "planned_continuation_date": { "type": "string", "format": "date", "description": "Expected date of foreign registration." }, "deregistration_mode": { "type": "string", "enum": [ "immediate", "provisional" ], "description": "provisional: confirmed in writing, completed only on evidence of the foreign registration, else it lapses after 90 days (s.38); finish with." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Makes the s.38 declaration and signs the undertaking." }, "statement_date": { "type": "string", "format": "date", "description": "Assets-and-liabilities statement date (latest practicable, s.38)." }, "has_secured_creditors": { "type": "boolean", "description": "s.38." }, "cima_licensed": { "type": "boolean", "description": "True if licensed under the regulatory laws; CIMA consent needed (s.38)." }, "declaration_facts": { "type": "object", "description": "Draft booleans, keys as in the example: no_insolvency_events, able_to_pay_debts, bona_fide, consents_and_approvals_obtained, destination_law_complied_with." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express." } }, "required": [ "destination_country", "destination_entity_form", "proposed_name_abroad", "proposed_registered_office_abroad", "planned_continuation_date", "deregistration_mode", "authorised_signatory", "statement_date", "has_secured_creditors", "cima_licensed", "declaration_facts" ], "description": "Deregisters a Cayman LLP so it can continue abroad, immediately or provisionally. The LLP must be solvent and in good standing; an authorised signatory files a notarised declaration with a statement of assets and liabilities, and the LLP." }, "Create_ky_llp_continue_out": { "type": "object", "properties": { "type": { "const": "ky.llp.continue_out" }, "params": { "$ref": "#/components/schemas/Params_ky_llp_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a Cayman LLP to continue abroad", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Current partnership agreement", "source": "uploaded", "required": true }, { "key": "partner_approval", "title": "Partners' approval", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "s38_declaration", "title": "Declaration or affidavit (s.38; manual Appendix 9)", "source": "generated", "required": true }, { "key": "secured_creditor_undertaking", "title": "21-day secured-creditor undertaking (s.38; Appendix 9.2)", "source": "generated", "required": true }, { "key": "changes_notice", "title": "Notice of proposed name and registered office abroad (s.38)", "source": "generated", "required": true }, { "key": "cima_consent", "title": "CIMA consent", "source": "uploaded", "required": false }, { "key": "certificate_of_deregistration", "title": "Certificate of deregistration and Gazette notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partner_approval", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "s38_declaration", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "changes_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "De-registration or Provisional De-registration, LLP Act s.38", "channel": "online", "government_fee": { "amount": 6300, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "Unpaid fees or missing return; the Registry manual requires good standing. [registry_error]" }, { "code": "winding_up_or_insolvency_in_progress", "type": null, "when": "declaration_facts reports an insolvency event or inability to pay. [requirement_error]" }, { "code": "cima_consent_required", "type": null, "when": "cima_licensed is true and no consent is uploaded. [requirement_error]" } ] } }, "Params_ky_llp_continue_out_complete": { "type": "object", "properties": { "provisional_action_id": { "type": "string", "description": "Completed ky.llp.continue_out action with deregistration_mode provisional.", "examples": [ "act_1Te6Jm1ArH" ] }, "deregistration_date": { "type": "string", "format": "date", "description": "Date the foreign registration takes effect." }, "evidence_type": { "type": "string", "enum": [ "certificate_of_registration", "notice_of_deregistration", "contemporaneous_registration_confirmation" ], "description": "Evidence offered (s.38)." } }, "required": [ "provisional_action_id", "deregistration_date", "evidence_type" ], "description": "Completes a provisional LLP deregistration with evidence of the foreign registration; without it within 90 days the provisional deregistration is cancelled." }, "Create_ky_llp_continue_out_complete": { "type": "object", "properties": { "type": { "const": "ky.llp_continue_out.complete" }, "params": { "$ref": "#/components/schemas/Params_ky_llp_continue_out_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Complete a provisional LLP deregistration (LLP Act s.38)", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_registration_evidence", "title": "Certificate or notice of registration in the destination", "source": "uploaded", "required": true }, { "key": "completion_request", "title": "Request to complete the deregistration", "source": "generated", "required": true }, { "key": "certificate_of_deregistration", "title": "Certificate of deregistration and Gazette notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "completion_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Completion of De-registration, CAP smart form", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "provisional_deregistration_lapsed", "type": null, "when": "More than 90 days since provisional deregistration; start a new ky.llp.continue_out. [requirement_error]" }, { "code": "provisional_action_not_found", "type": null, "when": "provisional_action_id is not a completed provisional action for this entity. [invalid_request_error]" }, { "code": "foreign_registration_not_evidenced", "type": null, "when": "No acceptable evidence. [requirement_error]" } ] } }, "Params_ky_lp_convert_to_elp": { "type": "object", "properties": { "elp_name": { "type": "string", "description": "Must include 'Limited Partnership', 'L.P.' or 'LP' (s.6).", "examples": [ "Harbour Point Fund I L.P." ] }, "nature_of_business": { "type": "string", "description": "s.9." }, "term": { "type": "object", "description": "{unlimited: boolean, end_date?: date, commencement_date: date} (s.9)." }, "general_partners": { "type": "array", "items": {}, "description": "Items {person, kind: individual|company|partnership, cayman_qualifying}." }, "limited_partners": { "type": "array", "items": {}, "description": "Items {person, interest_percent, capital_commitment}; for CDD and the BO register." }, "partnership_agreement_amendment_required": { "type": "boolean", "description": "True if the agreement needs amending to comply with the ELP Act (s.40)." }, "confirm_no_business_with_public_in_islands": { "type": "boolean", "description": "Must be true: the s.9 declaration." }, "signing_general_partner": { "type": "string", "pattern": "^per_", "description": "GP, or individual for a corporate GP, who signs the s.9 statement." }, "cima_registered": { "type": "boolean", "description": "True if registered with CIMA; the partner checks what CIMA needs." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express (CI$500 per the batch; s.13 names ss.9 and 42, so confirm it covers s.40)." } }, "required": [ "elp_name", "nature_of_business", "term", "general_partners", "partnership_agreement_amendment_required", "confirm_no_business_with_public_in_islands", "signing_general_partner", "cima_registered" ], "description": "Re-registers a Cayman Partnership Act limited partnership as an exempted limited partnership, with no new legal entity. The agreement is amended if needed, CI$1,000 is paid and a general partner signs a s.9 statement." }, "Create_ky_lp_convert_to_elp": { "type": "object", "properties": { "type": { "const": "ky.lp.convert_to_elp" }, "params": { "$ref": "#/components/schemas/Params_ky_lp_convert_to_elp" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a Cayman limited partnership as an ELP", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "current_partnership_agreement", "title": "Current partnership agreement", "source": "uploaded", "required": true }, { "key": "partnership_agreement_amendment", "title": "Amendment to the partnership agreement", "source": "generated", "required": false }, { "key": "elp_registration_statement", "title": "Statement under ELP Act s.9", "source": "generated", "required": true }, { "key": "gp_documents", "title": "GP evidence: corporate certificates, or individual ID and Cayman address (s.9)", "source": "uploaded", "required": false }, { "key": "certificate_of_registration", "title": "ELP certificate of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement_amendment", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "elp_registration_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "elp_registration_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Statement under ELP Act s.9", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_qualifying_general_partner", "type": null, "when": "No GP meets s.4. [requirement_error]" }, { "code": "public_business_declaration_not_given", "type": null, "when": "confirm_no_business_with_public_in_islands is false. [requirement_error]" }, { "code": "entity_type_not_supported", "type": null, "when": "Entity is not a Partnership Act limited partnership. [jurisdiction_error]" } ] } }, "Params_ky_partnership_convert_to_elp": { "type": "object", "properties": { "source_type": { "type": "string", "enum": [ "partnership_act_lp", "foreign_partnership" ], "description": "Partnership being re-registered" }, "source_entity_id": { "type": "string", "pattern": "^ent_", "description": "Entiva entity of an existing Partnership Act LP" }, "foreign_jurisdiction": { "type": "string", "description": "Where a foreign partnership is established" }, "elp_name": { "type": "string", "description": "ELP name, and dual foreign name if any (s.9)" }, "nature_of_business": { "type": "string", "description": "General nature of the business (s.9)" }, "term": { "type": "string", "description": "Term, or 'unlimited' with start date (s.9)" }, "general_partners": { "type": "array", "items": {}, "description": "Each general partner: name, address, type." }, "no_public_business_in_islands": { "type": "boolean", "description": "Declaration under s.9" }, "cima_regulated": { "type": "boolean", "description": "ELP will be a CIMA-registered fund; sets the annual-fee tier" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "source_type", "elp_name", "nature_of_business", "term", "general_partners", "no_public_business_in_islands" ], "description": "Under ELP Act s.40 a Partnership Act LP, or a partnership formed in another jurisdiction, may register as an ELP by amending its partnership agreement, paying the fee and filing the s.9 statement signed by or for a general partner. It." }, "Create_ky_partnership_convert_to_elp": { "type": "object", "properties": { "type": { "const": "ky.partnership.convert_to_elp" }, "params": { "$ref": "#/components/schemas/Params_ky_partnership_convert_to_elp" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a Partnership Act limited partnership or foreign partnership as an exempted limited partnership", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "lp", "elp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "amended_partnership_agreement", "title": "Partnership agreement amended to comply with the ELP Act (s.40)", "source": "uploaded", "required": true }, { "key": "section_9_statement", "title": "Statement under s.9", "source": "generated", "required": true }, { "key": "gp_corporate_documents", "title": "Certificate of incorporation and good standing of a corporate general partner", "source": "uploaded", "required": false }, { "key": "existing_registration_evidence", "title": "Existing LP certificate, or foreign partnership registration extract", "source": "uploaded", "required": false }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "ELP certificate of registration (s.9)", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "amended_partnership_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "amended_partnership_agreement", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "section_9_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Statement under ELP Act s.9", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_qualifying_general_partner", "type": null, "when": "No general partner meets s.4" }, { "code": "agreement_not_amended", "type": null, "when": "Partnership agreement not amended to comply" }, { "code": "gp_documents_missing", "type": null, "when": "Corporate or individual GP documents missing (s.9)" } ] } }, "Params_ky_partnership_convert_to_llp": { "type": "object", "properties": { "source_entity_id": { "type": "string", "pattern": "^ent_", "description": "Entiva entity of the converting firm" }, "firm_name": { "type": "string", "description": "Firm's name, shown on correspondence and invoices for 12 months" }, "llp_name": { "type": "string", "description": "LLP name (LLP Act s.8)" }, "nature_of_business": { "type": "string", "description": "Nature of business (s.18)" }, "partners": { "type": "array", "items": {}, "description": "All partners of the firm and no one else; name and address each (ss.32, 18)" }, "managing_partners": { "type": "array", "items": {}, "description": "Partners who are managing partners (s.18)" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day (s.18)" }, "term": { "type": "string", "description": "Term, if not unlimited (s.18)" }, "proposed_conversion_date": { "type": "string", "format": "date", "description": "At least 28 days after the Gazette notice (s.32)" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "firm_name", "llp_name", "nature_of_business", "partners", "financial_year_end", "proposed_conversion_date" ], "description": "Under LLP Act ss.32-36 a firm converts to an LLP if the LLP's partners are exactly the firm's partners and notice is published in the Gazette at least 28 days before conversion. All partners consent and adopt a registration statement and." }, "Create_ky_partnership_convert_to_llp": { "type": "object", "properties": { "type": { "const": "ky.partnership.convert_to_llp" }, "params": { "$ref": "#/components/schemas/Params_ky_partnership_convert_to_llp" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a partnership firm into a limited liability partnership", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "general_partnership", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_consent", "title": "Consent signed by all partners adopting the registration statement and partnership agreement", "source": "generated", "required": true }, { "key": "registration_statement", "title": "LLP registration statement (s.18)", "source": "generated", "required": true }, { "key": "llp_partnership_agreement", "title": "LLP partnership agreement", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of the firm's application (s.32)", "source": "generated", "required": true }, { "key": "corporate_partner_documents", "title": "Certificates of incorporation and good standing of a corporate managing partner", "source": "uploaded", "required": false }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate that the firm has converted to an LLP (s.33)", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_consent", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "registration_statement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for conversion under LLP Act s.33 with the partners' consent and registration ", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "partners_do_not_match", "type": null, "when": "LLP partners differ from the firm's partners (s.32)" }, { "code": "gazette_notice_too_late", "type": null, "when": "Conversion date is under 28 days after the Gazette notice" }, { "code": "llp_name_not_acceptable", "type": null, "when": "Name refused under LLP Act s.8" } ] } }, "Params_ky_provisional_registration_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "llp" ], "description": "Cayman entity it would become" }, "foreign_entity_name": { "type": "string", "description": "Current name" }, "foreign_jurisdiction": { "type": "string", "description": "Jurisdiction of incorporation or registration" }, "foreign_registration_number": { "type": "string", "description": "Registration number there" }, "name": { "type": "string", "description": "Intended Cayman name" }, "officers": { "type": "array", "items": {}, "description": "Directors or partners" }, "operations_outside_islands": { "type": "boolean", "description": "Company: director's declaration that operations will be mainly outside the Islands (s.201)" }, "contingency_reason": { "type": "string", "description": "Why a provisional registration is wanted" }, "assets_and_liabilities_date": { "type": "string", "format": "date", "description": "Date of the statement in the declaration" } }, "required": [ "entity_type", "foreign_entity_name", "foreign_jurisdiction", "foreign_registration_number", "name", "officers", "assets_and_liabilities_date" ], "description": "Contingency redomiciliation: a foreign body corporate (Companies Act s.201-) or foreign LLP (LLP Act s.39-) is placed on a provisional Cayman register without yet leaving its home register, so it can complete the move quickly if needed. It." }, "Create_ky_provisional_registration_apply": { "type": "object", "properties": { "type": { "const": "ky.provisional_registration.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_provisional_registration_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Provisionally register a foreign company or LLP by way of continuation", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "foreign_certificate_of_incorporation", "title": "Certified certificate of incorporation or registration", "source": "uploaded", "required": true }, { "key": "foreign_good_standing", "title": "Certificate of good standing dated within one month", "source": "uploaded", "required": true }, { "key": "foreign_constitutional_documents", "title": "Certified charter documents or partnership agreement", "source": "uploaded", "required": true }, { "key": "provisional_declaration", "title": "Declaration or affidavit: no winding-up, receiver or creditor scheme, able to pay debts, with.", "source": "generated", "required": true }, { "key": "operations_declaration", "title": "Director's declaration: operations mainly outside the Islands", "source": "generated", "required": false }, { "key": "application", "title": "Application and registered office notice", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_provisional_registration", "title": "Certificate of provisional registration (s.202; LLP s.39)", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "provisional_declaration", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "operations_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for provisional registration: Companies Act s.201", "channel": "online", "government_fee": { "amount": 1500, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "insolvency_proceedings_pending", "type": null, "when": "Winding-up, receiver or creditor scheme in any jurisdiction" }, { "code": "foreign_law_does_not_permit_transfer", "type": null, "when": "The foreign jurisdiction does not permit the transfer" }, { "code": "due_diligence_incomplete", "type": null, "when": "" } ] } }, "Params_ky_provisional_registration_complete": { "type": "object", "properties": { "final_name": { "type": "string", "description": "Name for full registration; company may undertake to change within 60 days" }, "authorised_capital": { "$ref": "#/components/schemas/Money", "description": "Company: sets the registration fee band" }, "foreign_exit_date": { "type": "string", "format": "date", "description": "Date the entity ceases to exist in its old jurisdiction (s.201; LLP s.39)" }, "licence_obtained": { "type": "boolean", "description": "Any Cayman licence needed has been obtained (s.201)" }, "assets_and_liabilities_date": { "type": "string", "format": "date", "description": "Date of the refreshed statement in the declaration" }, "express": { "type": "boolean", "description": "Express registry service" } }, "required": [ "final_name", "foreign_exit_date", "assets_and_liabilities_date" ], "description": "Moves a provisionally registered company (Companies Act s.201) or LLP (LLP Act s.39) to full registration once the remaining conditions are met: acceptable name, fee, bona fides, creditor notice, consents, approval under the charter." }, "Create_ky_provisional_registration_complete": { "type": "object", "properties": { "type": { "const": "ky.provisional_registration.complete" }, "params": { "$ref": "#/components/schemas/Params_ky_provisional_registration_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Complete a provisional registration into full continuation", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the action", "source": "generated", "required": true }, { "key": "completion_declaration", "title": "Declaration or affidavit with statement of assets and liabilities (s.201,; LLP s.39,)", "source": "generated", "required": true }, { "key": "secured_creditor_undertaking", "title": "Undertaking that secured creditors are or will be notified within 21 days", "source": "generated", "required": true }, { "key": "consents_and_approvals", "title": "Contract consents and the approval under the charter documents", "source": "uploaded", "required": true }, { "key": "foreign_law_compliance", "title": "Evidence the foreign law on transfer is complied with", "source": "uploaded", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "certificate_of_continuation", "title": "Certificate of registration by way of continuation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "completion_declaration", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "secured_creditor_undertaking", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Application for full registration: Companies Act s.201", "channel": "online", "government_fee": { "amount": 700, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_exit_not_evidenced", "type": null, "when": "No evidence the entity will cease to exist in its old jurisdiction" }, { "code": "licence_missing", "type": null, "when": "A required Cayman licence is not held" }, { "code": "not_provisionally_registered", "type": null, "when": "Provisional status has lapsed" } ] } }, "Params_ky_provisional_registration_renew": { "type": "object", "properties": { "filing_year": { "type": "integer", "description": "Calendar year of the January filing" }, "no_change_confirmation": { "type": "boolean", "description": "Nothing has changed since the last declaration" }, "changes": { "type": "object", "description": "Changes to charter documents or registered office since provisional registration" } }, "required": [ "filing_year", "no_change_confirmation" ], "description": "Each January after provisional registration the company (Companies Act s.201) or LLP (LLP Act s.39) files a declaration or affidavit and pays the annual fee. Without both by 30 June the provisional registration ends, though it can be." }, "Create_ky_provisional_registration_renew": { "type": "object", "properties": { "type": { "const": "ky.provisional_registration.renew" }, "params": { "$ref": "#/components/schemas/Params_ky_provisional_registration_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the January declaration and fee for a provisional registration", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_declaration", "title": "Annual declaration or affidavit", "source": "generated", "required": true }, { "key": "registry_application", "title": "Filing package", "source": "generated", "required": true }, { "key": "receipt", "title": "Registry receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "annual_declaration", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registry_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Annual declaration and fee: Companies Act s.201", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "declaration_missing", "type": null, "when": "The annual declaration has not been signed" }, { "code": "filed_after_30_june", "type": null, "when": "The 30 June cut-off has passed; provisional status has ended" } ] } }, "Params_ky_restructuring_officer_appoint": { "type": "object", "properties": { "inability_to_pay": { "type": "string", "enum": [ "currently_unable", "likely_to_become_unable" ], "description": "Ground under s.91B: unable to pay debts within s.93 now, or likely to become so." }, "grounds_summary": { "type": "string", "description": "Facts supporting the inability to pay." }, "intended_compromise": { "type": "string", "enum": [ "cayman_scheme", "foreign_law_scheme", "consensual_restructuring" ], "description": "What the company intends to propose to creditors (s.91B)." }, "restructuring_proposal_summary": { "type": "string", "description": "The proposal and its prospects: the Court needs credible evidence of a rational proposal with reasonable prospects." }, "creditor_engagement_summary": { "type": "string", "description": "Creditors consulted and their support; the Court expects engagement with unconnected creditors." }, "proposed_restructuring_officers": { "type": "array", "items": {}, "description": "Each {name, firm, qualification: qualified_insolvency_practitioner|foreign_practitioner, jurisdiction}." }, "include_interim_application": { "type": "boolean", "description": "Also apply ex parte for an interim officer pending the petition hearing." }, "regulated_business": { "type": "boolean", "description": "If true the directors must serve notice on CIMA immediately after presenting the petition or application; failure is an offence, CI$10,000 (s.91B-, s.91C-)." }, "winding_up_petition_pending": { "type": "boolean", "description": "Whether a winding-up petition or foreign proceeding is pending; relevant to the s.91G stay." }, "authorising_directors": { "type": "array", "items": {}, "description": "Directors who resolve to petition, each {person} (s.91B)." }, "deponent": { "type": "string", "pattern": "^per_", "description": "Director or officer who swears the supporting affidavit." }, "cayman_counsel": { "type": "object", "description": "{firm, lead_attorney, email}." } }, "required": [ "inability_to_pay", "grounds_summary", "intended_compromise", "restructuring_proposal_summary", "creditor_engagement_summary", "proposed_restructuring_officers", "include_interim_application", "regulated_business", "winding_up_petition_pending", "authorising_directors", "deponent", "cayman_counsel" ], "description": "Coordinates a Grand Court petition by the directors for a restructuring officer where the company is or may become unable to pay its debts and intends a compromise. No members' resolution is needed and the petition stays proceedings." }, "Create_ky_restructuring_officer_appoint": { "type": "object", "properties": { "type": { "const": "ky.restructuring_officer.appoint" }, "params": { "$ref": "#/components/schemas/Params_ky_restructuring_officer_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Petition for the appointment of a restructuring officer", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution authorising the petition", "source": "generated", "required": true }, { "key": "petition", "title": "Petition under s.91B", "source": "uploaded", "required": true }, { "key": "interim_application", "title": "Ex parte application for an interim officer", "source": "uploaded", "required": false }, { "key": "supporting_affidavit", "title": "Affidavit in support, sworn by a director or officer", "source": "generated", "required": true }, { "key": "restructuring_proposal", "title": "Restructuring proposal or term sheet", "source": "uploaded", "required": true }, { "key": "creditor_list", "title": "Creditor list: amounts, security, connections to management, support", "source": "uploaded", "required": true }, { "key": "financial_statements", "title": "Recent financial statements or management accounts", "source": "uploaded", "required": true }, { "key": "ro_consent_to_act", "title": "Proposed officer's consent to act", "source": "generated", "required": true }, { "key": "ro_qualification_evidence", "title": "Evidence the officer is a qualified insolvency practitioner", "source": "uploaded", "required": true }, { "key": "cima_notice", "title": "Notice of the petition to CIMA", "source": "generated", "required": false }, { "key": "appointment_order", "title": "Grand Court order appointing the officer", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "ro_consent_to_act", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "petition", "signer_role": "lawyer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "cima_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Grand Court of the Cayman Islands", "form": "Petition under Companies Act s.91B", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cayman_counsel_required", "type": null, "when": "cayman_counsel is missing. [requirement_error]" }, { "code": "no_qualified_insolvency_practitioner", "type": null, "when": "No proposed officer is a qualified insolvency practitioner, or a foreign practitioner is sole. [requirement_error]" }, { "code": "proposal_evidence_insufficient", "type": null, "when": "No credible proposal or creditor engagement evidenced. [requirement_error]" } ] } }, "Params_ky_scheme_of_arrangement_apply": { "type": "object", "properties": { "scheme_purpose": { "type": "string", "enum": [ "compromise_or_arrangement", "reconstruction", "amalgamation", "share_capital_reorganisation" ], "description": "compromise_or_arrangement, reconstruction or amalgamation with a transfer of undertaking, or share-capital reorganisation (an arrangement under s.86)." }, "applicant_capacity": { "type": "string", "enum": [ "company", "restructuring_officer", "liquidator" ], "description": "Who applies. s.86 also allows a creditor or member; LLC s.42 has no restructuring officer." }, "scheme_summary": { "type": "string", "description": "Plain description of the compromise or arrangement." }, "classes": { "type": "array", "items": {}, "description": "Per class {kind: creditor|member, name, description, estimated_value: money, count}." }, "transfers_undertaking_or_property": { "type": "boolean", "description": "True if property or liabilities move to a transferee: the order falls under s.87 or LLC s.43 and must reach the Registrar within seven days." }, "transferee": { "type": "object", "description": "{name, jurisdiction, registration_number}; may be foreign (s.87)." }, "cayman_counsel": { "type": "object", "description": "{firm, lead_attorney, email}." }, "listed_securities": { "type": "boolean", "description": "True if shares or debt are listed; the Court then needs listing-rule evidence." } }, "required": [ "scheme_purpose", "applicant_capacity", "scheme_summary", "classes", "transfers_undertaking_or_property", "cayman_counsel", "listed_securities" ], "description": "Coordinates a Grand Court application, through Cayman attorneys, to convene class meetings and sanction a compromise, arrangement or reconstruction. Creditors need a majority in number and 75% in value per class; members 75% in value." }, "Create_ky_scheme_of_arrangement_apply": { "type": "object", "properties": { "type": { "const": "ky.scheme_of_arrangement.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_scheme_of_arrangement_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Court-sanctioned scheme of arrangement or reconstruction", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution authorising the application", "source": "generated", "required": true }, { "key": "scheme_document", "title": "Scheme of arrangement", "source": "uploaded", "required": true }, { "key": "explanatory_statement", "title": "Explanatory statement and meeting notices", "source": "uploaded", "required": true }, { "key": "class_analysis", "title": "Creditor and member list with proposed classes", "source": "uploaded", "required": true }, { "key": "petition_and_summons", "title": "Petition and summons to convene the meetings", "source": "uploaded", "required": true }, { "key": "supporting_affidavit", "title": "Affidavit in support, sworn by a director or officer", "source": "generated", "required": true }, { "key": "chairman_affidavit", "title": "Chairman's affidavit on the meetings", "source": "uploaded", "required": false }, { "key": "sanction_order", "title": "Grand Court sanction order", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "petition_and_summons", "signer_role": "lawyer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "chairman_affidavit", "signer_role": "officer", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" } ], "filing": { "registry": "Grand Court of the Cayman Islands", "form": "Petition to sanction a scheme with an interlocutory summons to convene the meetings", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "cayman_counsel_required", "type": null, "when": "cayman_counsel is missing. [requirement_error]" }, { "code": "class_composition_missing", "type": null, "when": "classes empty or without class evidence. [requirement_error]" }, { "code": "applicant_not_supported", "type": null, "when": "restructuring_officer chosen for an LLC. [jurisdiction_error]" } ] } }, "Params_ky_scheme_order_file": { "type": "object", "properties": { "order_basis": { "type": "string", "enum": [ "companies_act_s86", "companies_act_s87", "companies_act_s91I", "companies_act_s91J", "llc_act_s42", "llc_act_s43" ], "description": "Provision the order was made under." }, "order_date": { "type": "string", "format": "date", "description": "Date the Court made the order; the seven days for s.87, s.91J and LLC s.43 run from it." }, "court_cause_number": { "type": "string", "description": "Grand Court cause number.", "examples": [ "FSD 214 of 2026" ] }, "scheme_action_id": { "type": "string", "description": "The ky.scheme_of_arrangement.apply action this order belongs to." }, "authenticating_officer": { "type": "string", "pattern": "^per_", "description": "Director, secretary or manager who authenticates the delivery." }, "filing_speed": { "type": "string", "enum": [ "standard", "express" ], "description": "standard or express." } }, "required": [ "order_basis", "order_date", "court_cause_number", "authenticating_officer" ], "description": "Delivers a Grand Court scheme order to the Registrar. The order has no effect until delivered, and a reconstruction or amalgamation order must be delivered within seven days." }, "Create_ky_scheme_order_file": { "type": "object", "properties": { "type": { "const": "ky.scheme_order.file" }, "params": { "$ref": "#/components/schemas/Params_ky_scheme_order_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deliver a scheme sanction order to the Registrar", "x-entiva": { "jurisdiction": "ky", "stage": "restructuring", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "sealed_order_copy", "title": "Sealed or certified copy of the order", "source": "uploaded", "required": true }, { "key": "delivery_cover_note", "title": "Cover note delivering the order for registration", "source": "generated", "required": true }, { "key": "registered_order_confirmation", "title": "Registry confirmation of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "delivery_cover_note", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "delivery_cover_note", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Filing of any other document: copy of the Court order", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "filing_deadline_passed", "type": null, "when": "More than seven days since an s.87, s.91J or LLC s.43 order; default penalties apply. [requirement_error]" }, { "code": "order_not_sealed", "type": null, "when": "Uploaded copy is not sealed or certified. [requirement_error]" }, { "code": "order_basis_mismatch", "type": null, "when": "order_basis does not fit the entity type. [invalid_request_error]" } ] } }, "Params_ky_cooperative_society_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cooperative_society" ], "description": "Entity type." }, "is_credit_union": { "type": "boolean", "description": "Must be false." }, "registration_number": { "type": "string", "description": "The society's registration number with the Registrar of Cooperative Societies.", "examples": [ "CS-1187" ] }, "total_members": { "type": "integer", "description": "Number of members on the register at the application date.", "examples": [ "12" ] }, "applicant_members": { "type": "array", "items": {}, "description": "person_ref ids of the members joining the application." }, "reasons": { "type": "string", "description": "Why the society should be dissolved." }, "general_meeting_date": { "type": "string", "format": "date", "description": "Date of any general meeting that endorsed the application." }, "proposed_liquidators": { "type": "array", "items": {}, "description": "person_ref ids of people the members suggest as liquidator." }, "books_and_records_location": { "$ref": "#/components/schemas/Address", "description": "Where the society's books and documents are kept." }, "rules_surplus_purpose": { "type": "string", "description": "The purpose the society's rules give for any surplus." }, "known_liabilities": { "$ref": "#/components/schemas/Money", "description": "Total of known liabilities in KYD, from the statement of assets and liabilities." } }, "required": [ "entity_type", "is_credit_union", "registration_number", "total_members", "applicant_members", "reasons" ], "description": "Members holding 75% of the membership apply to the Registrar of Cooperative Societies to cancel the society's registration. If the Registrar orders cancellation, the Cabinet gazettes it, members have two months to appeal, and the Registrar." }, "Create_ky_cooperative_society_dissolve": { "type": "object", "properties": { "type": { "const": "ky.cooperative_society.dissolve" }, "params": { "$ref": "#/components/schemas/Params_ky_cooperative_society_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a co-operative society", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "member_application", "title": "Members' application to cancel the registration", "source": "generated", "required": true }, { "key": "register_of_members", "title": "Register of members", "source": "uploaded", "required": true }, { "key": "society_rules", "title": "Registered rules of the society", "source": "uploaded", "required": true }, { "key": "latest_accounts", "title": "Latest accounts", "source": "uploaded", "required": true }, { "key": "assets_liabilities_statement", "title": "Statement of assets and liabilities", "source": "generated", "required": true }, { "key": "committee_resolution", "title": "Committee resolution", "source": "generated", "required": false }, { "key": "general_meeting_minutes", "title": "Minutes of the general meeting", "source": "uploaded", "required": false }, { "key": "registrar_order", "title": "Registrar's order cancelling the registration", "source": "registry_issued", "required": true }, { "key": "gazette_notice", "title": "Official Gazette notice", "source": "registry_issued", "required": true }, { "key": "liquidator_appointment", "title": "Registrar's appointment of liquidator", "source": "registry_issued", "required": false } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "member_application", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "assets_liabilities_statement", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "committee_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Cooperative Societies", "form": "Application", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not a co-operative society." }, { "code": "credit_union_not_supported", "type": null, "when": "jurisdiction_error: is_credit_union is true." }, { "code": "threshold_not_met", "type": null, "when": "requirement_error: applicant_members is below 75% of total_members." }, { "code": "membership_below_ten", "type": null, "when": "requirement_error: the register shows fewer than ten members." }, { "code": "register_mismatch", "type": null, "when": "requirement_error: total_members or an applicant does not match the uploaded register of members." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to sign the application on a member's behalf." }, { "code": "registrar_declined", "type": null, "when": "registry_error: the Registrar is not of the opinion that the society ought to be dissolved, or asks for an inquiry or inspection first." }, { "code": "appeal_lodged", "type": null, "when": "registry_error: a member appealed within two months." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_cooperative_society_dissolve_low_membership": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "cooperative_society" ], "description": "Entity type." }, "is_credit_union": { "type": "boolean", "description": "Must be false." }, "registration_number": { "type": "string", "description": "The society's registration number.", "examples": [ "CS-0934" ] }, "member_count": { "type": "integer", "description": "Current number of members.", "examples": [ "8" ] }, "member_count_date": { "type": "string", "format": "date", "description": "Date the count was taken." }, "fell_below_ten_on": { "type": "string", "format": "date", "description": "Date membership first fell below ten, if known." }, "has_registered_society_member": { "type": "boolean", "description": "Must be false." }, "explanation": { "type": "string", "description": "How membership fell and why the society will not recover it." }, "proposed_liquidators": { "type": "array", "items": {}, "description": "person_ref ids of people suggested as liquidator." }, "books_and_records_location": { "$ref": "#/components/schemas/Address", "description": "Where the books and documents are kept." }, "rules_surplus_purpose": { "type": "string", "description": "The purpose the rules give for any surplus (s.57)." } }, "required": [ "entity_type", "is_credit_union", "registration_number", "member_count", "member_count_date", "has_registered_society_member", "explanation" ], "description": "The society's officers report to the Registrar of Cooperative Societies that membership has fallen below ten and ask for the registration to be cancelled. Under Cooperative Societies Law s.50 the Registrar may cancel by written order." }, "Create_ky_cooperative_society_dissolve_low_membership": { "type": "object", "properties": { "type": { "const": "ky.cooperative_society.dissolve_low_membership" }, "params": { "$ref": "#/components/schemas/Params_ky_cooperative_society_dissolve_low_membership" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a co-operative society whose membership has fallen below ten", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "cooperative_society" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "officers_statement", "title": "Officers' statement and request for cancellation", "source": "generated", "required": true }, { "key": "register_of_members", "title": "Register of members", "source": "uploaded", "required": true }, { "key": "society_rules", "title": "Registered rules of the society", "source": "uploaded", "required": true }, { "key": "latest_accounts", "title": "Latest accounts", "source": "uploaded", "required": true }, { "key": "assets_liabilities_statement", "title": "Statement of assets and liabilities", "source": "generated", "required": true }, { "key": "registrar_order", "title": "Registrar's order cancelling the registration", "source": "registry_issued", "required": true }, { "key": "liquidator_appointment", "title": "Registrar's appointment of liquidator", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "officers_statement", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "assets_liabilities_statement", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry, Registrar of Cooperative Societies", "form": "Written report and request to cancel under Cooperative Societies Law", "channel": "paper", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not a co-operative society." }, { "code": "credit_union_not_supported", "type": null, "when": "jurisdiction_error: is_credit_union is true." }, { "code": "membership_not_below_ten", "type": null, "when": "requirement_error: member_count is ten or more." }, { "code": "society_has_registered_society_member", "type": null, "when": "requirement_error: has_registered_society_member is true, so s.50 is unavailable." }, { "code": "register_mismatch", "type": null, "when": "requirement_error: member_count does not match the uploaded register." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to sign the officers' statement." }, { "code": "registrar_declined", "type": null, "when": "registry_error: the Registrar does not make an order, or asks for more proof of the membership count." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_dormancy_assess": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp" ], "description": "Entity type key; must match the entity record." }, "inactive_since": { "type": "string", "format": "date", "description": "Date trading or operations stopped.", "examples": [ "2025-06-30" ] }, "has_assets": { "type": "boolean", "description": "True if the entity holds any asset." }, "has_liabilities": { "type": "boolean", "description": "True if it owes anything, including contingent liabilities and fees to providers." }, "cima_registered": { "type": "boolean", "description": "True if it holds a CIMA registration or licence; CIMA closure runs first and has its own 31 December cut-off." }, "intended_outcome": { "type": "string", "enum": [ "undecided", "keep_in_good_standing", "close_via_strike_off", "close_via_voluntary_liquidation" ], "description": "What the owners expect; undecided asks Entiva to recommend." }, "target_closure_date": { "type": "string", "format": "date", "description": "Date by which it should be off the register, normally 31 December to avoid the next January's fee.", "examples": [ "2026-12-31" ] }, "declarant": { "type": "string", "pattern": "^per_", "description": "The director, manager or general partner who confirms the facts.", "examples": [ "per_01K5N9B7C3XQ8R2M4T6V0DEHZY" ] } }, "required": [ "entity_type", "inactive_since", "has_assets", "has_liabilities", "cima_registered" ], "description": "Cayman has no dormant status: an inactive entity keeps its annual return, annual fee, economic substance and beneficial ownership duties until struck off or dissolved. This action files nothing." }, "Create_ky_dormancy_assess": { "type": "object", "properties": { "type": { "const": "ky.dormancy.assess" }, "params": { "$ref": "#/components/schemas/Params_ky_dormancy_assess" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Assess a dormant Cayman entity and plan its exit", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "dormancy_plan", "title": "Dormancy plan", "source": "generated", "required": true }, { "key": "inactivity_confirmation", "title": "Click-through confirmation record", "source": "generated", "required": true }, { "key": "evidence_of_no_assets_or_liabilities", "title": "Evidence of no assets or liabilities", "source": "uploaded", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "inactivity_confirmation", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dormancy_plan", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None. Cayman has no dormant status", "form": "None. Output is Entiva's dormancy plan", "channel": "none", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "inactivity_not_confirmed", "type": "requirement_error", "when": "The declarant answered false or did not confirm; the plan can still issue with liquidation as the route." }, { "code": "entity_in_liquidation", "type": "jurisdiction_error", "when": "Already in winding up; use ky.liquidation_annual_meeting.hold or ky.voluntary_liquidation.complete." }, { "code": "registrar_strike_off_pending", "type": "jurisdiction_error", "when": "The Registry lists the entity as pending strike-off; only full compliance cures it, and closure waits." }, { "code": "cima_registration_active", "type": "requirement_error", "when": "cima_registered is true; the plan starts with ky.fund.deregister." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_exempted_trust_deregister": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_trust" ], "description": "Entity type." }, "trustees": { "type": "array", "items": {}, "description": "person_ref ids of every current trustee.", "examples": [ "[\"per_4Tq9xLw2Bn\", \"per_7Hs3mZc8Ka\"]" ] }, "termination_reason": { "type": "string", "enum": [ "fully_distributed", "term_or_event_ended", "revoked_or_collapsed", "assets_transferred_out", "other" ], "description": "Why no property remains subject to the trust." }, "termination_reason_detail": { "type": "string", "description": "Plain-language detail." }, "final_distribution_date": { "type": "string", "format": "date", "description": "Date the last trust property was distributed or transferred out.", "examples": [ "2026-09-30" ] }, "no_property_remains": { "type": "boolean", "description": "Must be true." }, "last_annual_fee_year": { "type": "integer", "description": "Last year for which the s.78 annual fee was paid.", "examples": [ "2026" ] }, "trust_registration_ref": { "type": "string", "description": "Registrar of Trusts reference printed on the s.75 certificate." }, "protector_consent_required": { "type": "boolean", "description": "True when the trust instrument needs a protector's or other person's consent to wind up the trust." }, "consenting_persons": { "type": "array", "items": {}, "description": "person_ref ids of the people whose consent the trust instrument requires." }, "request_certificate": { "type": "boolean", "description": "Ask the Registry for its written s.85 certification." }, "express": { "type": "boolean", "description": "Use the Registry's express service for the filing and certificate." } }, "required": [ "entity_type", "trustees", "termination_reason", "final_distribution_date", "no_property_remains", "last_annual_fee_year" ], "description": "The trustees ask the Registrar of Trusts to certify under Trusts Act s.85 that no property remains subject to the trust. On certification Part VI of the Act stops applying to the trust and its former trustees, and the Registry destroys its." }, "Create_ky_exempted_trust_deregister": { "type": "object", "properties": { "type": { "const": "ky.exempted_trust.deregister" }, "params": { "$ref": "#/components/schemas/Params_ky_exempted_trust_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Close an exempted trust's registration", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustees_resolution", "title": "Trustees' resolution to close the registration", "source": "generated", "required": true }, { "key": "no_property_declaration", "title": "Trustees' declaration that no property remains", "source": "generated", "required": true }, { "key": "final_trust_accounts", "title": "Final trust accounts", "source": "uploaded", "required": true }, { "key": "distribution_evidence", "title": "Evidence of final distribution or transfer", "source": "uploaded", "required": true }, { "key": "protector_consent", "title": "Protector or other consent", "source": "uploaded", "required": false }, { "key": "trust_instrument", "title": "Trust instrument and amendments", "source": "uploaded", "required": false }, { "key": "registrar_certificate", "title": "Registrar of Trusts certification under s.85", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry fee receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trustees_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "no_property_declaration", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "protector_consent", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "General Registry, Registrar of Trusts", "form": "No prescribed form. A written request with the trustees' declaration and supporting eviden", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not an exempted trust." }, { "code": "trust_not_registered", "type": null, "when": "jurisdiction_error: the entity record shows no Part VI registration with the Registrar of Trusts, so there is nothing to close." }, { "code": "property_remains", "type": null, "when": "requirement_error: no_property_remains is false, or the final accounts show a balance." }, { "code": "trustees_incomplete", "type": null, "when": "requirement_error: a current trustee on the entity record is not in trustees, or has not signed." }, { "code": "protector_consent_missing", "type": null, "when": "requirement_error: protector_consent_required is true and no consent has been uploaded or signed." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to sign the resolution, the declaration or a consent." }, { "code": "registrar_not_satisfied", "type": null, "when": "registry_error: the Registrar declines to certify or asks for more accounts, minutes or information." }, { "code": "annual_fee_arrears", "type": null, "when": "registry_error: the Registry reports unpaid s.78 annual fees." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_foreign_registration_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_lp", "foreign_company" ], "description": "Entity type key; must match the entity record." }, "ceased_on": { "type": "string", "format": "date", "description": "Date it ceased to be general partner of its last ELP, or ceased business in the Islands.", "examples": [ "2026-10-01" ] }, "reason": { "type": "string", "enum": [ "replaced_as_general_partner", "removed_by_partners", "withdrew", "elp_dissolved_or_deregistered", "closed_cayman_place_of_business", "foreign_company_dissolved_or_merged", "other" ], "description": "Why it ceased." }, "no_remaining_presence": { "type": "boolean", "description": "Must be true: a foreign LP is general partner of no other ELP; a foreign company has no office, staff, licence or proceeding left in the Islands." }, "elps_ceased": { "type": "array", "items": {}, "description": "Foreign LP only: entity ids of the ELPs it ceased to act for.", "examples": [ "[\"ent_01K5N8F5D2X9R4M7T1V3WBQ6HC\"]" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "The general partner, director or officer who signs.", "examples": [ "per_01K5N9B7C3XQ8R2M4T6V0DEHZY" ] } }, "required": [ "entity_type", "ceased_on", "reason", "no_remaining_presence" ], "description": "A foreign limited partnership registers only to act as general partner of an ELP and must file a notice and fee as soon as reasonably practicable once it stops; a foreign company registered under Part 9 must give notice 'forthwith' when it." }, "Create_ky_foreign_registration_cease": { "type": "object", "properties": { "type": { "const": "ky.foreign_registration.cease" }, "params": { "$ref": "#/components/schemas/Params_ky_foreign_registration_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the Registrar that a foreign limited partnership or foreign company has ceased in Cayman (ELP Act s.42.", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "foreign_lp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "cessation_notice", "title": "Notice of cessation to the Registrar", "source": "generated", "required": true }, { "key": "evidence_of_cessation", "title": "Evidence of cessation", "source": "uploaded", "required": true }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement or certificate of removal", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "cessation_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "cessation_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of cessation with the prescribed fee: ELP Act s.42", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "still_active_in_cayman", "type": "requirement_error", "when": "no_remaining_presence is false, or the foreign LP still acts as general partner of another ELP." }, { "code": "elp_change_statement_missing", "type": "requirement_error", "when": "The ELP register still lists the foreign LP as general partner; file the ELP's s.10 statement first." }, { "code": "annual_fee_outstanding", "type": "requirement_error", "when": "An annual fee or penalty is unpaid; clear it before the file is closed." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_fund_deregister": { "type": "object", "properties": { "fund_type": { "type": "string", "enum": [ "mutual_fund", "private_fund", "sub_fund" ], "description": "mutual_fund and private_fund use TMF-147-22 v2; sub_fund uses TRS-142-99 v2 and has no separate surrender fee." }, "basis_for_deregistration": { "type": "string", "enum": [ "ceasing_to_carry_on_business", "voluntary_liquidation", "court_supervised_or_official_liquidation", "transferred_to_another_jurisdiction", "never_carried_on_business", "other_counsel_review" ], "description": "Basis under section 7 of CIMA's Cancellation Procedures, which sets the documents." }, "effective_date": { "type": "string", "format": "date", "description": "Date the fund ceases or ceased business: the resolution date, or the liquidator's appointment.", "examples": [ "2026-11-20" ] }, "post_deregistration_intention": { "type": "string", "enum": [ "continue_as_legal_entity", "seek_strike_off", "dissolve_through_the_liquidation" ], "description": "What the operator's affidavit says the entity will do next." }, "original_certificate_issued": { "type": "boolean", "description": "True if CIMA issued a physical certificate: return it, or give a lost-certificate affidavit." }, "audit_status": { "type": "string", "enum": [ "all_filed", "waiver_to_be_requested", "outstanding" ], "description": "all_filed, waiver_to_be_requested or outstanding." }, "operators": { "type": "array", "items": {}, "description": "Operators who sign: directors, general partner or LLC managers.", "examples": [ "[\"per_01K5N9B7C3XQ8R2M4T6V0DEHZY\"]" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Third-party voluntary liquidator for voluntary_liquidation; not the operator or an engaged service provider.", "examples": [ "per_01K5N9D9K4YB7Q2S8U1W3XCFNP" ] } }, "required": [ "fund_type", "basis_for_deregistration", "effective_date", "post_deregistration_intention", "original_certificate_issued", "audit_status", "operators" ], "description": "Surrenders a fund's CIMA registration so it stops owing CIMA annual fees. The fund must be in good standing; the operators supply a certified resolution, an affidavit sworn in person, and the documents for the chosen basis." }, "Create_ky_fund_deregister": { "type": "object", "properties": { "type": { "const": "ky.fund.deregister" }, "params": { "$ref": "#/components/schemas/Params_ky_fund_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a CIMA mutual fund or private fund registration", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_spc", "llc", "elp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "operator_resolution", "title": "Certified resolution of operators or investors", "source": "generated", "required": true }, { "key": "operator_affidavit", "title": "Operator's affidavit", "source": "generated", "required": false }, { "key": "liquidator_affidavit", "title": "Liquidator's affidavit", "source": "generated", "required": false }, { "key": "stamped_cwr_forms", "title": "Registry-stamped CWR Forms 19 and 20", "source": "uploaded", "required": false }, { "key": "final_audited_accounts", "title": "Final audited accounts or waiver", "source": "uploaded", "required": false }, { "key": "operator_authority_letter", "title": "Operator's authorisation for the provider to file", "source": "generated", "required": true }, { "key": "reefs_application", "title": "REEFS form TMF-147-22 v2 as submitted", "source": "generated", "required": true }, { "key": "cima_approval_letter", "title": "CIMA de-registration letter", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "operator_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "operator_affidavit", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "liquidator_affidavit", "signer_role": "liquidator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "operator_authority_letter", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reefs_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Cayman Islands Monetary Authority", "form": "REEFS TMF-147-22 v2, Termination of Mutual and Private Fund Application", "channel": "online", "government_fee": { "amount": 750, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fund_not_in_good_standing", "type": "requirement_error", "when": "REEFS shows outstanding fees or filings; submission is blocked." }, { "code": "audited_accounts_outstanding", "type": "requirement_error", "when": "Audited accounts or fund returns are unfiled and no waiver is sought." }, { "code": "umbrella_sub_funds_active", "type": "requirement_error", "when": "An SPC or umbrella's sub-funds are not de-registered or de-registering together." }, { "code": "third_party_liquidator_required", "type": "requirement_error", "when": "The liquidator is the operator or an engaged service provider." }, { "code": "liquidation_forms_not_stamped", "type": "requirement_error", "when": "Stamped CWR Forms 19 and 20 are not on file." }, { "code": "notification_window_missed", "type": "requirement_error", "when": "Over 21 days since cessation; proceeds and flags the administrative fine risk." }, { "code": "basis_needs_counsel", "type": "jurisdiction_error", "when": "other_counsel_review: merger, re-registration, master fund, single investor or conversion." } ] } }, "Params_ky_general_partnership_dissolve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "general_partnership" ], "description": "Entity type." }, "dissolution_ground": { "type": "string", "enum": [ "term_expired", "undertaking_completed", "partner_notice", "partner_death", "partner_bankruptcy", "partner_share_charged", "illegality", "agreement_of_all_partners" ], "description": "How the partnership is dissolved. term_expired and undertaking_completed are s.32-; partner_notice is s.32 and applies only to a partnership of undefined." }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of dissolution." }, "notice_given_on": { "type": "string", "format": "date", "description": "Date the notice reached the other partners." }, "notifying_partner": { "type": "string", "pattern": "^per_", "description": "The partner giving notice." }, "partners": { "type": "array", "items": {}, "description": "person_ref ids of every partner at the dissolution date, including a partner who has died or become bankrupt." }, "outgoing_partner_representative": { "type": "string", "pattern": "^per_", "description": "Personal representative of a deceased partner, or trustee in bankruptcy of a bankrupt partner." }, "agreement_provides_continuation": { "type": "boolean", "description": "Must be false." }, "winding_up_partners": { "type": "array", "items": {}, "description": "person_ref ids of the partners who will wind up the affairs." }, "settlement_basis": { "type": "string", "enum": [ "statutory_order_s44", "partnership_agreement", "agreed_by_all_partners" ], "description": "How final accounts are settled." }, "publish_gazette_notice": { "type": "boolean", "description": "Publish a notice of dissolution in the Cayman Gazette." }, "notify_counterparties": { "type": "boolean", "description": "Send written notice to known customers and suppliers." }, "known_counterparties": { "type": "array", "items": {}, "description": "Objects with name, email and address of the firm's customers and suppliers to notify." }, "tbl_licence_number": { "type": "string", "description": "Trade and Business Licence number of the partnership, if it held one." }, "cancel_tbl": { "type": "boolean", "description": "Send the Department of Commerce and Investment the letter ceasing the licence." } }, "required": [ "entity_type", "dissolution_ground", "dissolution_date", "partners", "agreement_provides_continuation", "settlement_basis" ], "description": "Records the dissolution of an unregistered Cayman general partnership under Partnership Act ss.32-34, prepares the notice of dissolution and the final settlement of accounts, publishes an optional Gazette notice and closes the Trade and." }, "Create_ky_general_partnership_dissolve": { "type": "object", "properties": { "type": { "const": "ky.general_partnership.dissolve" }, "params": { "$ref": "#/components/schemas/Params_ky_general_partnership_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a general partnership", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "dissolution_notice", "title": "Notice of dissolution to the other partners", "source": "generated", "required": false }, { "key": "dissolution_agreement", "title": "Agreement to dissolve", "source": "generated", "required": false }, { "key": "ground_evidence", "title": "Evidence of the dissolving event", "source": "uploaded", "required": false }, { "key": "final_accounts", "title": "Final accounts and distribution schedule", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of dissolution", "source": "generated", "required": false }, { "key": "gazette_proof", "title": "Gazette publication proof", "source": "registry_issued", "required": false }, { "key": "tbl_cessation_letter", "title": "Letter ceasing the Trade and Business Licence", "source": "generated", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "dissolution_notice", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dissolution_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "final_accounts", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gazette_notice", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "tbl_cessation_letter", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None for the dissolution itself", "form": "No prescribed form. Notice of dissolution", "channel": "online", "government_fee": { "amount": 0, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not a general partnership." }, { "code": "partnership_continues", "type": null, "when": "requirement_error: agreement_provides_continuation is true, so the event does not dissolve the firm." }, { "code": "ground_not_available", "type": null, "when": "requirement_error: partner_notice was chosen for a fixed-term or single-undertaking partnership, or the evidence for the ground is missing." }, { "code": "partners_incomplete", "type": null, "when": "requirement_error: partners does not match the partners on the entity record." }, { "code": "accounts_not_approved", "type": null, "when": "requirement_error: a partner has not approved the final accounts." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to sign the notice of dissolution." }, { "code": "gazette_rejected", "type": null, "when": "registry_error: the Gazette Office rejects the notice or its deadline has passed." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_general_partnership_dissolve_by_court": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "general_partnership" ], "description": "Entity type." }, "applicant_partner": { "type": "string", "pattern": "^per_", "description": "The partner applying." }, "respondent_partners": { "type": "array", "items": {}, "description": "person_ref ids of the other partners, to be named and served." }, "grounds": { "type": "array", "items": {}, "description": "One or more s.35 grounds: partner_incapacity (35), prejudicial_conduct (35), persistent_breach (35), business_at_a_loss (35), just_and_equitable (35).", "examples": [ "[\"persistent_breach\", \"prejudicial_conduct\"]" ] }, "ground_particulars": { "type": "string", "description": "Facts for each ground, with dates." }, "relief": { "type": "array", "items": {}, "description": "Orders sought: dissolution_decree, winding_up_of_firm_affairs, premium_repayment.", "examples": [ "[\"dissolution_decree\", \"winding_up_of_firm_affairs\"]" ] }, "mutual_fund_business": { "type": "boolean", "description": "True if the partnership carries on business as a mutual fund." }, "urgent_interim_relief": { "type": "boolean", "description": "True if counsel should also seek interim protection of firm assets." }, "partnership_agreement_dispute_terms": { "type": "string", "description": "Any arbitration, valuation or exit terms in the agreement that affect the application." } }, "required": [ "entity_type", "applicant_partner", "respondent_partners", "grounds", "ground_particulars", "relief", "mutual_fund_business" ], "description": "A partner applies to the Grand Court to decree dissolution of a general partnership on one of the s.35 grounds, and may ask the court to wind up the firm's business and affairs. Cayman counsel files; the applicant swears an affidavit." }, "Create_ky_general_partnership_dissolve_by_court": { "type": "object", "properties": { "type": { "const": "ky.general_partnership.dissolve_by_court" }, "params": { "$ref": "#/components/schemas/Params_ky_general_partnership_dissolve_by_court" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a general partnership by Grand Court order", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Engagement of Cayman counsel", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "evidence_bundle", "title": "Evidence supporting the grounds", "source": "uploaded", "required": true }, { "key": "supporting_affidavit", "title": "Applicant's supporting affidavit", "source": "uploaded", "required": true }, { "key": "originating_process", "title": "Writ or originating summons", "source": "generated", "required": true }, { "key": "court_order", "title": "Grand Court order", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "originating_process", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Grand Court of the Cayman Islands, Civil Division", "form": "Writ or originating summons chosen", "channel": "online", "government_fee": { "amount": 200, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not a general partnership." }, { "code": "ground_not_supported", "type": null, "when": "requirement_error: grounds is empty or has a value outside s.35-." }, { "code": "applicant_is_subject_of_ground", "type": null, "when": "requirement_error: a ground under s.35, or is pleaded against the applicant instead of another partner." }, { "code": "conflict_check_failed", "type": null, "when": "requirement_error: counsel cannot act for the applicant." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to swear or sign the affidavit or the engagement letter." }, { "code": "counsel_not_instructed", "type": null, "when": "requirement_error: no Cayman attorney has accepted the instruction." }, { "code": "application_refused", "type": null, "when": "registry_error: the court dismisses the application or adjourns it." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_liquidation_annual_meeting_hold": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type key; must match the entity record." }, "anniversary_number": { "type": "integer", "description": "Which anniversary of commencement the meeting follows.", "examples": [ "1" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Within three months of the anniversary (s.126); Entiva schedules it after the anniversary so the report covers the full year.", "examples": [ "2027-12-10" ] }, "notice_days": { "type": "integer", "description": "Notice to members; the articles govern, default five days.", "examples": [ "14" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The serving voluntary liquidator.", "examples": [ "per_01K5N9D9K4YB7Q2S8U1W3XCFNP" ] } }, "required": [ "entity_type", "anniversary_number", "meeting_date", "liquidator" ], "description": "When a voluntary winding up runs past a year, the liquidator must call a general meeting at the end of each year, within three months of each anniversary of commencement, and lay a report and account of the year before it. Failure is an." }, "Create_ky_liquidation_annual_meeting_hold": { "type": "object", "properties": { "type": { "const": "ky.liquidation_annual_meeting.hold" }, "params": { "$ref": "#/components/schemas/Params_ky_liquidation_annual_meeting_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Hold the year-end general meeting of a company or LLC in voluntary liquidation", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidator_report_and_account", "title": "Liquidator's report and account for the year", "source": "uploaded", "required": true }, { "key": "meeting_notice", "title": "Notice of general meeting", "source": "generated", "required": true }, { "key": "meeting_minutes", "title": "Minutes of the meeting", "source": "generated", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "liquidator_report_and_account", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "liquidator_report_and_account", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. s.126 requires the meeting and report but no Registry filing", "form": "None", "channel": "none", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "meeting_window_missed", "type": "requirement_error", "when": "meeting_date is over three months after the anniversary; proceeds late and flags the s.126 offence." }, { "code": "liquidation_not_in_progress", "type": "jurisdiction_error", "when": "Not in voluntary winding up, or under a year since commencement." }, { "code": "liquidator_report_missing", "type": "requirement_error", "when": "No report and account uploaded before the meeting." }, { "code": "court_supervised_liquidation", "type": "jurisdiction_error", "when": "A supervision order exists; reporting follows the Court's directions, route to counsel." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_llc_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "llc" ], "description": "Entity type." }, "applicant_type": { "type": "string", "enum": [ "llc", "member", "creditor" ], "description": "Who applies." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The member or creditor applying, or the manager signing for the LLC when applicant_type is llc." }, "struck_off_date": { "type": "string", "format": "date", "description": "Date the LLC was struck off, from the Gazette notice." }, "strike_off_reason": { "type": "string", "enum": [ "unpaid_fees_or_returns", "not_carrying_on_business", "unpaid_bota_fine", "liquidation_no_liquidator", "voluntary_request", "unknown" ], "description": "Why the LLC was struck off." }, "carrying_on_business_at_strike_off": { "type": "boolean", "description": "Whether the LLC was carrying on business or in operation when struck off." }, "grounds_for_restoration": { "type": "string", "description": "Why restoration is just, with the facts counsel will put in the affidavit." }, "cabinet_allowance_reference": { "type": "string", "description": "Reference for the Cabinet's allowance to apply after 2 years and within 10 (s.159)." }, "llc_registration_number": { "type": "string", "description": "Registry number." }, "original_registration_fee": { "$ref": "#/components/schemas/Money", "description": "Fee paid at original registration, in KYD." }, "managers_after_restoration": { "type": "array", "items": {}, "description": "person_ref ids of the managers who will act once the LLC is restored." }, "use_entiva_registered_office": { "type": "boolean", "description": "Appoint Entiva's Entiva as registered office on restoration." }, "create_catch_up_actions": { "type": "boolean", "description": "Create draft actions for missed annual returns, economic substance notifications and beneficial ownership filings." }, "vested_property_note": { "type": "string", "description": "Known property that vested in the Financial Secretary on strike-off, for counsel to ask the court to deal with under s.159." }, "express": { "type": "boolean", "description": "Use the Registry's express service for the certificate." } }, "required": [ "entity_type", "applicant_type", "applicant", "struck_off_date", "strike_off_reason", "carrying_on_business_at_strike_off", "grounds_for_restoration", "managers_after_restoration" ], "description": "The LLC, a member or a creditor applies to the Grand Court under Companies Act s.159, applied to LLCs by LLC Act s.40, to restore a struck-off LLC. If the court orders restoration and the Registry's fees and arrears are paid, the LLC is." }, "Create_ky_llc_restore": { "type": "object", "properties": { "type": { "const": "ky.llc.restore" }, "params": { "$ref": "#/components/schemas/Params_ky_llc_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off LLC to the register", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Engagement of Cayman counsel", "source": "generated", "required": true }, { "key": "llc_agreement", "title": "LLC agreement and registration documents", "source": "uploaded", "required": true }, { "key": "strike_off_notice", "title": "Gazette strike-off notice", "source": "uploaded", "required": true }, { "key": "evidence_of_operation", "title": "Evidence the LLC was operating when struck off", "source": "uploaded", "required": true }, { "key": "cabinet_allowance", "title": "Cabinet allowance", "source": "uploaded", "required": false }, { "key": "supporting_affidavit", "title": "Applicant's supporting affidavit", "source": "uploaded", "required": true }, { "key": "originating_application", "title": "Originating summons", "source": "generated", "required": true }, { "key": "manager_consent", "title": "Manager's consent to act", "source": "generated", "required": true }, { "key": "court_order", "title": "Grand Court restoration order", "source": "registry_issued", "required": true }, { "key": "restoration_certificate", "title": "Registry certificate of restoration", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "originating_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "manager_consent", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Grand Court of the Cayman Islands", "form": "Originating summons to the Grand Court under Companies Act", "channel": "online", "government_fee": { "amount": 1800, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not an LLC." }, { "code": "entity_not_struck_off", "type": null, "when": "jurisdiction_error: the entity record is not struck off, so there is nothing to restore." }, { "code": "limit_expired", "type": null, "when": "requirement_error: more than 10 years have passed since struck_off_date, or more than 2 years and no Cabinet allowance reference is given." }, { "code": "not_aggrieved_party", "type": null, "when": "requirement_error: the applicant is not the LLC, a member or a creditor." }, { "code": "evidence_missing", "type": null, "when": "requirement_error: nothing shows the LLC was carrying on business or in operation at the strike-off date." }, { "code": "name_conflict", "type": null, "when": "registry_error: another entity now holds the LLC's name." }, { "code": "arrears_outstanding", "type": null, "when": "registry_error: the Registry will not restore until all fees, penalties and filings are cleared." }, { "code": "conflict_check_failed", "type": null, "when": "requirement_error: counsel cannot act for the applicant." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to swear the affidavit, sign the engagement letter or accept office for a manager." }, { "code": "application_refused", "type": null, "when": "registry_error: the court dismisses the application." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_lp_dissolution_file": { "type": "object", "properties": { "dissolution_basis": { "type": "string", "enum": [ "term_expired", "partners_agreement", "event_in_agreement" ], "description": "term_expired, partners_agreement or event_in_agreement." }, "dissolution_date": { "type": "string", "format": "date", "description": "Intended effective date; dissolution is effective only once the notice is filed and published.", "examples": [ "2026-12-31" ] }, "dissolving_before_term_end": { "type": "boolean", "description": "True if the registered term has not ended; the change of term needs a declaration by all general partners in seven days (s.51)." }, "creditors_paid": { "type": "boolean", "description": "True if every creditor is paid or reserved for; limited partners claim nothing until others are paid (s.52)." }, "general_partners": { "type": "array", "items": {}, "description": "Every general partner; all sign.", "examples": [ "[\"per_01K5N9B7C3XQ8R2M4T6V0DEHZY\",\"per_01K5N9C4H8WZ2N6P1R3T5VBDMA\"]" ] } }, "required": [ "dissolution_basis", "dissolution_date", "dissolving_before_term_end", "creditors_paid", "general_partners" ], "description": "A local limited partnership is not dissolved by its partners' act until a notice of dissolution has been filed with the Registrar and published in the Gazette, and not before its stated term ends unless that is changed. The general." }, "Create_ky_lp_dissolution_file": { "type": "object", "properties": { "type": { "const": "ky.lp_dissolution.file" }, "params": { "$ref": "#/components/schemas/Params_ky_lp_dissolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a Partnership Act limited partnership by filing a notice of dissolution (Partnership Act s.52)", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "lp_notice_of_dissolution", "title": "Notice of dissolution", "source": "generated", "required": true }, { "key": "lp_change_declaration", "title": "Declaration of change of term", "source": "generated", "required": false }, { "key": "partners_agreement_to_dissolve", "title": "Partners' agreement to dissolve", "source": "generated", "required": false }, { "key": "gazette_notice", "title": "Gazette notice of dissolution", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "lp_notice_of_dissolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lp_change_declaration", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "partners_agreement_to_dissolve", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp_notice_of_dissolution", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of dissolution filed and published", "channel": "online", "government_fee": { "amount": 100, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "creditors_not_paid", "type": "requirement_error", "when": "creditors_paid is false (s.52)." }, { "code": "term_not_changed", "type": "requirement_error", "when": "Dissolving early and the term-change declaration is not made." }, { "code": "general_partner_missing", "type": "requirement_error", "when": "A general partner has not signed." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_official_liquidation_petition": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type being wound up." }, "petitioner_type": { "type": "string", "enum": [ "company", "contributory", "creditor" ], "description": "Who presents the petition." }, "petitioner": { "type": "string", "pattern": "^per_", "description": "The contributory or creditor presenting." }, "authority_to_present": { "type": "string", "enum": [ "special_resolution_of_members", "directors_under_s94_2a", "directors_under_articles_s94_2", "llc_agreement_s37_2" ], "description": "Required when petitioner_type is company. special_resolution_of_members: a special resolution that the company be wound up by the Court (s.92).." }, "authorising_directors": { "type": "array", "items": {}, "description": "person_ref ids of the directors or managers who authorise a company petition." }, "special_resolution_date": { "type": "string", "format": "date", "description": "Date the special resolution was passed." }, "grounds": { "type": "array", "items": {}, "description": "One or more grounds from s.92: special_resolution, business_not_commenced_or_suspended, duration_expired_or_event, unable_to_pay_debts, just_and_equitable.", "examples": [ "[\"unable_to_pay_debts\"]" ] }, "ground_particulars": { "type": "string", "description": "Concise statement of the grounds, as the petition must contain (CWR O.3 r.2)." }, "business_description": { "type": "string", "description": "Description of the company's business, as the petition must contain (O.3 r.2)." }, "countries_of_business": { "type": "array", "items": {}, "description": "ISO 3166 country codes where the company carries on business.", "examples": [ "[\"KY\", \"SG\"]" ] }, "regulated_business": { "type": "boolean", "description": "True if the company carries on regulated business." }, "restructuring_officer_status": { "type": "string", "enum": [ "none", "petition_pending", "officer_appointed" ], "description": "Whether a restructuring officer petition is pending or an officer is in place." }, "leave_order_reference": { "type": "string", "description": "Reference of the order granting leave under s.91G." }, "debt": { "type": "object", "description": "Required for a creditor petition on the unable_to_pay_debts ground: amount, due_date, nature, statutory_demand_served_on, and basis." }, "nominated_official_liquidator": { "type": "string", "pattern": "^per_", "description": "The qualified insolvency practitioner the petitioner nominates (O.3 r.2)." }, "foreign_practitioner": { "type": "string", "pattern": "^per_", "description": "A foreign practitioner to act jointly with the qualified insolvency practitioner (s.108)." }, "contributory_basis": { "type": "string", "enum": [ "partly_paid_shares", "held_six_months_before_petition", "devolved_on_death" ], "description": "Required for a contributory petition. s.94: partly_paid_shares, held_six_months_before_petition, or devolved_on_death." } }, "required": [ "entity_type", "petitioner_type", "grounds", "ground_particulars", "business_description", "countries_of_business", "restructuring_officer_status", "nominated_official_liquidator" ], "description": "The company, a contributory or a creditor presents a winding up petition under Companies Act ss.92-95. Cayman counsel files in the Financial Services Division with a verifying affidavit and the affidavit of the qualified insolvency." }, "Create_ky_official_liquidation_petition": { "type": "object", "properties": { "type": { "const": "ky.official_liquidation.petition" }, "params": { "$ref": "#/components/schemas/Params_ky_official_liquidation_petition" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Petition the Grand Court to wind up a company or LLC", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "engagement_letter", "title": "Engagement of Cayman counsel", "source": "generated", "required": true }, { "key": "constitutional_documents", "title": "Memorandum and articles, or LLC agreement", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board resolution to present a petition", "source": "generated", "required": false }, { "key": "special_resolution", "title": "Special resolution that the company be wound up by the Court", "source": "generated", "required": false }, { "key": "llc_member_consent", "title": "LLC member vote or written consent", "source": "generated", "required": false }, { "key": "winding_up_petition", "title": "Winding up petition", "source": "generated", "required": true }, { "key": "verifying_affidavit", "title": "Affidavit verifying the petition", "source": "uploaded", "required": true }, { "key": "official_liquidator_affidavit", "title": "Nominated official liquidator's affidavit", "source": "uploaded", "required": true }, { "key": "foreign_practitioner_affidavit", "title": "Foreign practitioner's affidavit", "source": "uploaded", "required": false }, { "key": "contributory_evidence", "title": "Evidence of contributory standing", "source": "uploaded", "required": false }, { "key": "statutory_demand", "title": "Statutory demand", "source": "uploaded", "required": false }, { "key": "statutory_demand_service_proof", "title": "Proof of service of the statutory demand", "source": "uploaded", "required": false }, { "key": "debt_evidence", "title": "Evidence of the debt", "source": "uploaded", "required": false }, { "key": "affidavit_of_service", "title": "Affidavit of service", "source": "generated", "required": false }, { "key": "advertisement_proof", "title": "Newspaper advertisement", "source": "uploaded", "required": true }, { "key": "winding_up_order", "title": "Winding up order", "source": "registry_issued", "required": true }, { "key": "registrar_filing_confirmation", "title": "Order filed with the Registrar of Companies", "source": "registry_issued", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of the winding up", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "llc_member_consent", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "verifying_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "official_liquidator_affidavit", "signer_role": "liquidator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "foreign_practitioner_affidavit", "signer_role": "liquidator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "winding_up_petition", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Grand Court of the Cayman Islands, Financial Services Division", "form": "Winding up petition in CWR Form No 2, verified", "channel": "online", "government_fee": { "amount": 5000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not a company or LLC of a listed type." }, { "code": "petitioner_type_not_supported", "type": null, "when": "jurisdiction_error: the petitioner is the Monetary Authority or a person this API does not act for." }, { "code": "authority_to_present_missing", "type": null, "when": "requirement_error: a company petition has no valid authority." }, { "code": "leave_required_s91g", "type": null, "when": "requirement_error: a restructuring officer petition is pending or an officer is in place and no order granting leave is given (s.91G)." }, { "code": "already_in_liquidation", "type": null, "when": "requirement_error: the entity is already in voluntary liquidation." }, { "code": "official_liquidator_not_qualified", "type": null, "when": "requirement_error: the nominee is not a qualified insolvency practitioner, or the r.4 affidavit lacks the residency, independence or insurance statements." }, { "code": "contributory_standing_missing", "type": null, "when": "requirement_error: a contributory petition does not meet s.94." }, { "code": "statutory_demand_missing", "type": null, "when": "requirement_error: a creditor relies on s.93 and has not uploaded the demand with proof of hand delivery to the registered office." }, { "code": "conflict_check_failed", "type": null, "when": "requirement_error: counsel cannot act for the petitioner." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to swear an affidavit, sign the engagement letter or sign the board resolution." }, { "code": "hearing_date_unavailable", "type": null, "when": "registry_error: the Registrar cannot fix a hearing date, so the petition cannot be filed." }, { "code": "petition_dismissed", "type": null, "when": "registry_error: the court dismisses the petition or adjourns it (s.95)." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_partnership_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp", "llp" ], "description": "Entity type." }, "applicant_type": { "type": "string", "enum": [ "general_partner", "limited_partner", "partner", "creditor" ], "description": "Who applies." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The person applying." }, "struck_off_date": { "type": "string", "format": "date", "description": "Date the partnership was struck off, from the Gazette notice." }, "strike_off_reason": { "type": "string", "enum": [ "unpaid_fees_or_returns", "not_carrying_on_business", "unpaid_bota_fine", "liquidation_no_liquidator", "voluntary_request", "unknown" ], "description": "Why the partnership was struck off." }, "carrying_on_business_at_strike_off": { "type": "boolean", "description": "Whether the partnership was carrying on business or in operation when struck off." }, "grounds_for_restoration": { "type": "string", "description": "Why restoration is justified, with facts for the affidavit." }, "cabinet_allowance_reference": { "type": "string", "description": "Cabinet allowance reference, required when struck_off_date is more than 2 years before the application (ELP s.37; LLP s.31)." }, "registration_number": { "type": "string", "description": "Registry number." }, "general_partners_after_restoration": { "type": "array", "items": {}, "description": "ELP only: person_ref ids of the general partners who will act." }, "partners_after_restoration": { "type": "array", "items": {}, "description": "LLP only: person_ref ids of the partners who will act." }, "use_entiva_registered_office": { "type": "boolean", "description": "Appoint Entiva's Entiva as registered office on restoration." }, "create_catch_up_actions": { "type": "boolean", "description": "Create draft actions for missed annual returns, economic substance notifications and beneficial ownership filings." }, "vested_property_note": { "type": "string", "description": "LLP only: known property that vested in the Financial Secretary on strike-off (LLP Act s.31), for counsel to raise with the court." }, "express": { "type": "boolean", "description": "Use the Registry's express service for the certificate." } }, "required": [ "entity_type", "applicant_type", "applicant", "struck_off_date", "strike_off_reason", "carrying_on_business_at_strike_off", "grounds_for_restoration" ], "description": "A partner or creditor applies to the Grand Court to restore a struck-off exempted limited partnership (ELP Act s.37-) or limited liability partnership (LLP Act s.31). The court may restore if satisfied the partnership was carrying on." }, "Create_ky_partnership_restore": { "type": "object", "properties": { "type": { "const": "ky.partnership.restore" }, "params": { "$ref": "#/components/schemas/Params_ky_partnership_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off ELP or LLP to the register", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Engagement of Cayman counsel", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement and registration statement", "source": "uploaded", "required": true }, { "key": "strike_off_notice", "title": "Gazette strike-off notice", "source": "uploaded", "required": true }, { "key": "evidence_of_operation", "title": "Evidence the partnership was operating when struck off", "source": "uploaded", "required": true }, { "key": "cabinet_allowance", "title": "Cabinet allowance", "source": "uploaded", "required": false }, { "key": "supporting_affidavit", "title": "Applicant's supporting affidavit", "source": "uploaded", "required": true }, { "key": "originating_application", "title": "Court application", "source": "generated", "required": true }, { "key": "gp_consent", "title": "General partner's or partner's consent to act", "source": "generated", "required": true }, { "key": "court_order", "title": "Grand Court restoration order", "source": "registry_issued", "required": true }, { "key": "restoration_certificate", "title": "Registry certificate of restoration", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "originating_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "gp_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Grand Court of the Cayman Islands", "form": "Application to the court under Exempted Limited Partnership Act", "channel": "online", "government_fee": { "amount": 1000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not an ELP or an LLP." }, { "code": "entity_not_struck_off", "type": null, "when": "jurisdiction_error: the entity record is not struck off." }, { "code": "limit_expired", "type": null, "when": "requirement_error: more than 10 years have passed since struck_off_date, or more than 2 years and no Cabinet allowance reference is given." }, { "code": "not_aggrieved_party", "type": null, "when": "requirement_error: applicant_type does not fit the entity type, or the applicant is not a partner or creditor." }, { "code": "evidence_missing", "type": null, "when": "requirement_error: nothing shows the partnership was carrying on business or in operation at the strike-off date." }, { "code": "no_qualifying_general_partner", "type": null, "when": "requirement_error: for an ELP, no listed general partner meets the Cayman residence or registration requirement." }, { "code": "name_conflict", "type": null, "when": "registry_error: another entity now holds the partnership's name." }, { "code": "arrears_outstanding", "type": null, "when": "registry_error: the Registry reports unpaid fees or penalties that must be cleared before restoration." }, { "code": "conflict_check_failed", "type": null, "when": "requirement_error: counsel cannot act for the applicant." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to swear the affidavit, sign the engagement letter or accept office." }, { "code": "application_refused", "type": null, "when": "registry_error: the court dismisses the application." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_partnership_dissolution_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp", "llp" ], "description": "Entity type key; must match the entity record." }, "final_distribution_date": { "type": "string", "format": "date", "description": "Date of the last distribution; used for the clawback check.", "examples": [ "2026-12-15" ] }, "all_creditors_paid": { "type": "boolean", "description": "True if every creditor is paid or reserved for; an ELP's general partner stays liable for any shortfall." }, "clawback_position": { "type": "string", "enum": [ "six_months_elapsed", "partners_accept_risk", "not_applicable" ], "description": "six_months_elapsed; partners_accept_risk; not_applicable." }, "signer": { "type": "string", "enum": [ "general_partner", "liquidator" ], "description": "general_partner or liquidator (ELP s.36); an LLP's voluntary liquidator signs." }, "order_certificate_of_dissolution": { "type": "boolean", "description": "ELP certificate CI$150; the LLP schedule lists none." } }, "required": [ "entity_type", "final_distribution_date", "all_creditors_paid", "clawback_position", "signer" ], "description": "Dissolves a wound-up ELP or LLP. Neither Act lets the partners dissolve it by their own act: it is dissolved only when a notice signed by a general partner or liquidator or the voluntary liquidator is filed with the Registrar and the fee." }, "Create_ky_partnership_dissolution_file": { "type": "object", "properties": { "type": { "const": "ky.partnership_dissolution.file" }, "params": { "$ref": "#/components/schemas/Params_ky_partnership_dissolution_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the notice of dissolution of an ELP or LLP (ELP Act s.36; LLP Act s.25)", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_dissolution", "title": "Notice of dissolution", "source": "generated", "required": true }, { "key": "final_accounts", "title": "Final accounts and distribution schedule", "source": "uploaded", "required": true }, { "key": "cima_cancellation_letter", "title": "CIMA cancellation letter", "source": "uploaded", "required": false }, { "key": "certificate_of_dissolution", "title": "Certificate of dissolution", "source": "registry_issued", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_of_dissolution", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_dissolution", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of dissolution with the prescribed fee", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "winding_up_not_commenced", "type": "jurisdiction_error", "when": "No winding up has started; use ky.partnership_winding_up.commence." }, { "code": "creditors_not_paid", "type": "requirement_error", "when": "all_creditors_paid is false." }, { "code": "general_partner_no_longer_exists", "type": "requirement_error", "when": "A company general partner has been dissolved; a liquidator must sign." }, { "code": "clawback_risk_unacknowledged", "type": "requirement_error", "when": "Under six months since the last distribution and partners_accept_risk not chosen." }, { "code": "cima_registration_active", "type": "requirement_error", "when": "Still CIMA-registered; run ky.fund.deregister first." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_partnership_registration_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp", "llp" ], "description": "Entity type key; must match the entity record." }, "agreement_clause": { "type": "string", "description": "The clause that permits termination of registration.", "examples": [ "Clause 24.2 (Termination of registration)" ] }, "authorisation_route": { "type": "string", "enum": [ "general_partner_alone", "general_partner_with_limited_partner_vote", "all_partners" ], "description": "Who the agreement requires to authorise it." }, "continues_after_termination": { "type": "boolean", "description": "True if the partners will carry on as an unregistered partnership; changes the BO, ES and tax follow-up in the plan." }, "cima_registered": { "type": "boolean", "description": "True if CIMA-registered; run ky.fund.deregister first." } }, "required": [ "entity_type", "agreement_clause", "authorisation_route", "continues_after_termination", "cima_registered" ], "description": "Ends the partnership's registration as an exempted limited partnership or LLP by filing a written notice with written confirmation that the partnership agreement authorises it, and the fee. This is de-registration, not dissolution: the." }, "Create_ky_partnership_registration_remove": { "type": "object", "properties": { "type": { "const": "ky.partnership_registration.remove" }, "params": { "$ref": "#/components/schemas/Params_ky_partnership_registration_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Terminate the registration of an ELP or LLP where the agreement permits", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "termination_notice", "title": "Written notice of termination of registration", "source": "generated", "required": true }, { "key": "agreement_authority_confirmation", "title": "Written confirmation that the agreement authorises the action", "source": "generated", "required": true }, { "key": "partnership_agreement_extract", "title": "Partnership agreement or certified clause", "source": "uploaded", "required": true }, { "key": "owner_approval", "title": "Limited partners' or partners' approval", "source": "generated", "required": false }, { "key": "registry_acknowledgement", "title": "Registry acknowledgement or certificate of termination", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "agreement_authority_confirmation", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "termination_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "termination_notice", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Written notice of termination of registration with written confirmation the agreement auth", "channel": "online", "government_fee": { "amount": 150, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "agreement_does_not_permit_termination", "type": "requirement_error", "when": "No clause permits it or its conditions are unmet; wind up or amend the agreement." }, { "code": "annual_fees_or_penalties_outstanding", "type": "requirement_error", "when": "An annual fee, penalty or change statement is outstanding." }, { "code": "cima_registration_active", "type": "requirement_error", "when": "Still CIMA-registered; run ky.fund.deregister first." }, { "code": "partnership_in_winding_up", "type": "jurisdiction_error", "when": "Winding up has started; file the notice of dissolution instead." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_partnership_winding_up_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "elp", "llp" ], "description": "Entity type key; must match the entity record." }, "winding_up_basis": { "type": "string", "enum": [ "agreement_event", "partners_resolution", "automatic_no_qualifying_gp", "automatic_fewer_than_two_partners" ], "description": "agreement_event; partners_resolution (ELP s.36, LLP s.22); automatic_no_qualifying_gp (ELP, 90 days after an event of withdrawal, s.36-)." }, "commencement_date": { "type": "string", "format": "date", "description": "Earliest of the resolution, automatic wind-up date, end of term, agreed event or petition (ELP s.36; LLP s.26).", "examples": [ "2026-11-20" ] }, "liquidator_source": { "type": "string", "enum": [ "general_partner", "licensed_partner", "customer_nominated", "third_party_professional" ], "description": "general_partner winds up by default (ELP s.36); an LLP needs a voluntary liquidator, who signs its notice of dissolution." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator when not the general partner or Entiva.", "examples": [ "per_01K5N9D9K4YB7Q2S8U1W3XCFNP" ] }, "regulated_business": { "type": "boolean", "description": "True if CIMA-registered: CIMA must be served within 28 days (s.123 as applied) and ky.fund.deregister runs alongside." } }, "required": [ "entity_type", "winding_up_basis", "commencement_date", "liquidator_source", "regulated_business" ], "description": "Starts winding up an ELP or LLP on the agreement's trigger or a resolution of all general partners and two-thirds of limited partners or two-thirds of partners. Within 28 days Entiva's Entiva the notice of winding up, tells the." }, "Create_ky_partnership_winding_up_commence": { "type": "object", "properties": { "type": { "const": "ky.partnership_winding_up.commence" }, "params": { "$ref": "#/components/schemas/Params_ky_partnership_winding_up_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Start the voluntary winding up of an ELP or LLP", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "partners_resolution", "title": "Resolution of general partner and limited partners", "source": "generated", "required": false }, { "key": "notice_of_winding_up", "title": "Notice of winding up to the Registrar", "source": "generated", "required": true }, { "key": "liquidator_notification", "title": "Liquidator's name and business address", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of winding up", "source": "generated", "required": true }, { "key": "cima_winding_up_notice", "title": "Notice to CIMA", "source": "generated", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "special", "percent": 67, "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "special", "percent": 67, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_winding_up", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_winding_up", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Notice of winding up, liquidator notification, Gazette and CIMA notices. The consent to ac", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "majority_not_reached", "type": "requirement_error", "when": "Not all general partners, or under two-thirds of limited partners or partners, have signed." }, { "code": "automatic_window_not_elapsed", "type": "requirement_error", "when": "automatic_no_qualifying_gp chosen but 90 days have not passed or a replacement is being elected (s.36,)." }, { "code": "statutory_window_expired", "type": "requirement_error", "when": "Past 28 days; files late and flags the offence." }, { "code": "insolvent_winding_up_not_supported", "type": "jurisdiction_error", "when": "The partnership cannot pay its debts; a court winding up (s.36) goes to counsel." }, { "code": "cima_deregistration_not_started", "type": "requirement_error", "when": "regulated_business is true but no ky.fund.deregister is open." }, { "code": "partnership_already_in_winding_up", "type": "jurisdiction_error", "when": "Use ky.partnership_dissolution.file." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_restoration_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "description": "Entity type key; must match the struck-off record." }, "struck_off_date": { "type": "string", "format": "date", "description": "Date struck off; sets the two-year and ten-year limits.", "examples": [ "2025-03-31" ] }, "strike_off_route": { "type": "string", "enum": [ "voluntary_request", "registrar_non_compliance", "no_liquidator_acting", "unpaid_bota_fine" ], "description": "voluntary_request (s.156); registrar_non_compliance; no_liquidator_acting; unpaid_bota_fine." }, "applicant_capacity": { "type": "string", "enum": [ "company", "member", "creditor" ], "description": "The company, a member or a creditor who is aggrieved (s.159)." }, "applicant": { "type": "string", "pattern": "^per_", "description": "The applicant; swears the affidavit unless another deponent is named.", "examples": [ "per_01K5N9B7C3XQ8R2M4T6V0DEHZY" ] }, "grounds": { "type": "string", "description": "Why the Court should restore: the company was carrying on business or in operation, or otherwise, and restoration is just (s.159).", "examples": [ "Held shares in an operating subsidiary; in operation when struck off." ] }, "cabinet_allowance_reference": { "type": "string", "description": "Required if over two years since strike-off: Cabinet's allowance (s.159).", "examples": [ "CAB-2026-114" ] }, "proposed_directors": { "type": "array", "items": {}, "description": "Directors to be appointed on restoration, verified and consenting.", "examples": [ "[\"per_01K5N9F6P3AD9S4U7W2Y5ZEHRT\"]" ] }, "use_entiva_registered_office": { "type": "boolean", "description": "Default true; an exempted or non-resident company needs a CIMA licensee (s.50)." } }, "required": [ "entity_type", "struck_off_date", "strike_off_route", "applicant_capacity", "applicant", "grounds", "proposed_directors" ], "description": "The Grand Court can restore a struck-off company on the application of the company, a member or a creditor who feels aggrieved, within two years of strike-off or up to ten with Cabinet's allowance. The Court must be satisfied the company." }, "Create_ky_restoration_apply": { "type": "object", "properties": { "type": { "const": "ky.restoration.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_restoration_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off company to the register", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "counsel_engagement_letter", "title": "Engagement letter with Cayman counsel", "source": "generated", "required": true }, { "key": "affidavit_in_support", "title": "Affidavit in support", "source": "generated", "required": true }, { "key": "registrar_statement_of_fees", "title": "Registrar's statement of outstanding fees and reinstatement fee", "source": "registry_issued", "required": true }, { "key": "cabinet_allowance", "title": "Cabinet's allowance", "source": "uploaded", "required": false }, { "key": "director_consent_to_act", "title": "Proposed directors' consents to act", "source": "generated", "required": true }, { "key": "court_order", "title": "Grand Court restoration order", "source": "uploaded", "required": false }, { "key": "certificate_of_restoration", "title": "Certificate of restoration", "source": "registry_issued", "required": false } ], "people": [ { "role": "declarant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "counsel_engagement_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "affidavit_in_support", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "director_consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "certificate_of_restoration", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Grand Court", "form": "Application under s.159 with affidavit and draft order", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_out_of_time", "type": "invalid_request_error", "when": "Over ten years since strike-off, or over two with no Cabinet allowance (s.159)." }, { "code": "entity_not_struck_off", "type": "jurisdiction_error", "when": "The company is on the register, or was dissolved after a liquidation and is not restorable under s.159." }, { "code": "cabinet_allowance_required", "type": "requirement_error", "when": "Over two years since strike-off and no allowance reference." }, { "code": "no_cayman_counsel", "type": "requirement_error", "when": "No Cayman attorney is engaged; only counsel can file." }, { "code": "registered_office_not_accepted", "type": "requirement_error", "when": "Entiva did not accept the company after CDD." }, { "code": "court_refused", "type": "registry_error", "when": "The Court declined or wants more evidence; the action returns to requirements_pending." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_ky_strike_off_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "description": "Entity type key; must match the entity record." }, "target_strike_date": { "type": "string", "format": "date", "description": "Voluntary strike date. 2026: 31 Mar, 30 Jun, 30 Sep, 31 Dec, with Registry cut-offs 27 Jan, 5 May, 11 Aug, 3 Nov.", "examples": [ "2026-12-31" ] }, "not_in_operation_since": { "type": "string", "format": "date", "description": "Date the entity stopped carrying on business (the s.156 test).", "examples": [ "2025-06-30" ] }, "no_assets_or_liabilities": { "type": "boolean", "description": "Must be true: the Registry's resolution says the entity 'is not in operation and has no assets or liabilities'." }, "no_pending_proceedings": { "type": "boolean", "description": "Must be true: no petition, litigation, creditor claim or inquiry is known." }, "approval_required_beyond_decision_maker": { "type": "boolean", "description": "True if the articles, LLC or partnership agreement need members or limited partners to approve." }, "cima_registered": { "type": "boolean", "description": "True if CIMA-registered; cancel first with ky.fund.deregister." }, "order_certificate_of_strike_off": { "type": "boolean", "description": "Order the certificate of strike-off." } }, "required": [ "entity_type", "not_in_operation_since", "no_assets_or_liabilities", "no_pending_proceedings", "cima_registered" ], "description": "Asks the Registrar to strike an entity that is not in operation and has no assets or liabilities off the register, which dissolves it on the next quarterly strike date. The decision-makers sign a resolution and Entiva's licensed." }, "Create_ky_strike_off_request": { "type": "object", "properties": { "type": { "const": "ky.strike_off.request" }, "params": { "$ref": "#/components/schemas/Params_ky_strike_off_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request voluntary strike-off of a company, LLC, ELP or LLP (Companies Act s.156; LLC Act s.40; ELP Act s.37; LLP Act.", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc", "elp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "strike_off_resolution", "title": "Resolution of directors", "source": "generated", "required": true }, { "key": "registry_cover_letter", "title": "Letter to the Registrar requesting strike-off", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Director's affidavit", "source": "generated", "required": false }, { "key": "approval_of_owners", "title": "Members' or limited partners' approval", "source": "generated", "required": false }, { "key": "evidence_of_no_assets_or_liabilities", "title": "Evidence of no assets or liabilities", "source": "uploaded", "required": false }, { "key": "certificate_of_strike_off", "title": "Certificate of strike-off", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "strike_off_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "approval_of_owners", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "supporting_affidavit", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registry_cover_letter", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "Letter and resolution requesting strike-off with the fee: Companies Act s.156", "channel": "online", "government_fee": { "amount": null, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "assets_or_liabilities_present", "type": "requirement_error", "when": "no_assets_or_liabilities is false or records show an asset or liability; use ky.voluntary_liquidation.commence or the partnership winding up." }, { "code": "annual_fees_or_penalties_outstanding", "type": "requirement_error", "when": "The current year's fee, a penalty or a filing is unpaid; the Registry takes no partial compliance." }, { "code": "economic_substance_notification_missing", "type": "requirement_error", "when": "No current-year ESN; Mourant says it is filed first." }, { "code": "cima_registration_active", "type": "requirement_error", "when": "CIMA registration is live; run ky.fund.deregister first." }, { "code": "strike_off_cutoff_passed", "type": "invalid_request_error", "when": "The cut-off for target_strike_date has passed; the response proposes the next date." }, { "code": "general_partner_of_active_elp", "type": "requirement_error", "when": "The entity is general partner of a live ELP; replace it first (ELP Act s.36)." }, { "code": "entity_in_liquidation", "type": "jurisdiction_error", "when": "Winding up has started; strike-off is for the Registrar if no liquidator acts." } ] } }, "Params_ky_supervision_order_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type in voluntary liquidation." }, "route": { "type": "string", "enum": [ "section_124_no_solvency_declaration", "section_131_discretionary" ], "description": "section_124_no_solvency_declaration: the voluntary liquidator must petition unless all directors delivered a declaration of solvency within 28 days of." }, "petitioner_type": { "type": "string", "enum": [ "voluntary_liquidator", "contributory", "creditor" ], "description": "Who petitions." }, "petitioner": { "type": "string", "pattern": "^per_", "description": "The contributory or creditor presenting." }, "voluntary_liquidator": { "type": "string", "pattern": "^per_", "description": "The company's voluntary liquidator." }, "liquidation_commenced_on": { "type": "string", "format": "date", "description": "Date the voluntary winding up commenced under s.117: the date of the resolution, or the expiry or event under the articles.", "examples": [ "2026-09-28" ] }, "commencement_method": { "type": "string", "enum": [ "duration_expired", "event_occurred", "special_resolution", "ordinary_resolution_inability_to_pay_debts" ], "description": "How the voluntary liquidation began." }, "solvency_declaration_status": { "type": "string", "enum": [ "none_delivered", "delivered_by_all_directors" ], "description": "none_delivered is required for the s.124 route." }, "directors_at_commencement": { "type": "array", "items": {}, "description": "person_ref ids of everyone who was a director on the date the liquidation commenced." }, "section_131_grounds": { "type": "array", "items": {}, "description": "Required for the s.131 route: insolvent_or_likely_insolvent (s.131) or more_effective_economic_or_expeditious (s.131).", "examples": [ "[\"insolvent_or_likely_insolvent\"]" ] }, "ground_particulars": { "type": "string", "description": "Full particulars of the grounds (CWR O.15 r.3) or, for s.124, the fact that no declaration was received in time." }, "liquidator_is_qualified_insolvency_practitioner": { "type": "boolean", "description": "Whether the voluntary liquidator is a qualified insolvency practitioner." }, "liquidator_willing_to_act_as_official_liquidator": { "type": "boolean", "description": "Whether the liquidator consents to be appointed official liquidator." }, "nominated_official_liquidator": { "type": "string", "pattern": "^per_", "description": "Required unless the voluntary liquidator is a qualified insolvency practitioner who is willing and able to act." }, "foreign_practitioner": { "type": "string", "pattern": "^per_", "description": "A foreign practitioner to be appointed alongside (s.132)." }, "regulated_business": { "type": "boolean", "description": "True if the company carries on regulated business." } }, "required": [ "entity_type", "route", "petitioner_type", "voluntary_liquidator", "liquidation_commenced_on", "commencement_method", "solvency_declaration_status", "ground_particulars", "liquidator_is_qualified_insolvency_practitioner" ], "description": "Asks the Grand Court to continue a voluntary liquidation under its supervision, either because the directors did not deliver a declaration of solvency within 28 days or on the court's discretion where the company is or is likely to become." }, "Create_ky_supervision_order_apply": { "type": "object", "properties": { "type": { "const": "ky.supervision_order.apply" }, "params": { "$ref": "#/components/schemas/Params_ky_supervision_order_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a supervision order over a voluntary liquidation", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "engagement_letter", "title": "Engagement of Cayman counsel", "source": "generated", "required": true }, { "key": "commencement_resolution", "title": "Resolution or event that began the liquidation", "source": "uploaded", "required": true }, { "key": "liquidator_consent", "title": "Voluntary liquidator's consent to act", "source": "uploaded", "required": true }, { "key": "supervision_petition", "title": "Supervision petition", "source": "generated", "required": true }, { "key": "verifying_affidavit", "title": "Affidavit verifying the petition", "source": "uploaded", "required": true }, { "key": "official_liquidator_affidavit", "title": "Nominated official liquidator's affidavit", "source": "uploaded", "required": false }, { "key": "notice_to_creditors_and_members", "title": "Notice of the petition", "source": "generated", "required": true }, { "key": "advertisement_proof", "title": "Newspaper advertisement", "source": "uploaded", "required": false }, { "key": "final_report_and_accounts", "title": "Voluntary liquidator's final report and accounts", "source": "uploaded", "required": false }, { "key": "supervision_order", "title": "Supervision order", "source": "registry_issued", "required": true }, { "key": "registrar_filing_confirmation", "title": "Order filed with the Registrar of Companies", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "verifying_affidavit", "signer_role": "liquidator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "official_liquidator_affidavit", "signer_role": "liquidator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "supervision_petition", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "final_report_and_accounts", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Grand Court of the Cayman Islands, Financial Services Division", "form": "Petition under Companies Act", "channel": "online", "government_fee": { "amount": 5000, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "jurisdiction_error: the entity is not a company or LLC of a listed type." }, { "code": "not_in_voluntary_liquidation", "type": null, "when": "requirement_error: the entity record shows no voluntary liquidation, or the commencement date does not match the Registry filing." }, { "code": "route_not_available", "type": null, "when": "requirement_error: section_124 is chosen with a declaration delivered by all directors, a petitioner other than the liquidator, or a liquidation that began before 1 March 2009." }, { "code": "petition_out_of_time", "type": null, "when": "requirement_error: a s.124 petition would be presented more than 35 days after commencement (O.15 r.2)." }, { "code": "official_liquidator_not_qualified", "type": null, "when": "requirement_error: the nominee or the voluntary liquidator cannot give the r.4 statements on qualification, residency, independence and insurance." }, { "code": "conflict_check_failed", "type": null, "when": "requirement_error: counsel cannot act for the petitioner." }, { "code": "human_presence_required", "type": null, "when": "permission_error: an agent tried to swear an affidavit or sign the engagement letter." }, { "code": "petition_dismissed", "type": null, "when": "registry_error: the court refuses the order or adjourns it." }, { "code": "verification_required", "type": null, "when": "requirement_error: a person in this action has no verification at the level their role needs." }, { "code": "screening_hold", "type": null, "when": "requirement_error: an open sanctions or PEP screening alert on a person in this action is being reviewed." } ] } }, "Params_ky_voluntary_liquidation_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type key; must match the entity record." }, "winding_up_basis": { "type": "string", "enum": [ "special_resolution", "term_expired", "specified_event", "llc_member_vote", "founder_notice" ], "description": "special_resolution (s.116); term_expired (s.116); specified_event (s.116); llc_member_vote (LLC Act s.36, two-thirds in number); founder_notice." }, "resolution_date": { "type": "string", "format": "date", "description": "Commencement (s.117): date the resolution is passed (last signature if written, s.60) or the term or event occurs.", "examples": [ "2026-11-20" ] }, "liquidator_source": { "type": "string", "enum": [ "licensed_partner", "customer_nominated", "third_party_professional" ], "description": "licensed_partner, customer_nominated or third_party_professional." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator; not needed for licensed_partner or a liquidator designated in the articles (s.119).", "examples": [ "per_01K5N9D9K4YB7Q2S8U1W3XCFNP" ] }, "will_give_declaration_of_solvency": { "type": "boolean", "description": "True if all directors will sign within 28 days." }, "regulated_business": { "type": "boolean", "description": "True if the company carries on regulated business: CIMA must be served within 28 days (s.123) and ky.fund.deregister runs alongside." }, "avoid_next_annual_fee": { "type": "boolean", "description": "Default true: plan the final meeting before the January fee date; warns if resolution_date is after 1 December." } }, "required": [ "entity_type", "winding_up_basis", "resolution_date", "liquidator_source", "will_give_declaration_of_solvency", "regulated_business" ], "description": "Puts a solvent company or LLC into voluntary winding up. Members pass the special resolution, a liquidator consents to act, the directors sign a declaration of solvency, and within 28 days Entiva's Entiva the notice of winding up." }, "Create_ky_voluntary_liquidation_commence": { "type": "object", "properties": { "type": { "const": "ky.voluntary_liquidation.commence" }, "params": { "$ref": "#/components/schemas/Params_ky_voluntary_liquidation_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Start the voluntary liquidation of a solvent company or LLC and make the 28-day filings", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "members_special_resolution", "title": "Members' special resolution", "source": "generated", "required": true }, { "key": "notice_of_voluntary_winding_up", "title": "Notice of voluntary winding up", "source": "generated", "required": true }, { "key": "liquidator_consent_to_act", "title": "Liquidator's consent to act", "source": "generated", "required": true }, { "key": "declaration_of_solvency", "title": "Declaration of solvency", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of winding up", "source": "generated", "required": true }, { "key": "cima_winding_up_notice", "title": "Notice to CIMA", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "special", "percent": 67, "method": "meeting" } ], "signatures": [ { "document_key": "members_special_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "declaration_of_solvency", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_voluntary_winding_up", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "CWR Forms 19, 20 and 21, CIMA notice if regulated and Gazette notice within 28 days", "channel": "online", "government_fee": { "amount": 200, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "insolvent_liquidation_not_supported", "type": "jurisdiction_error", "when": "Ordinary-resolution basis (s.116) or the company cannot pay in full in 12 months; route to counsel." }, { "code": "declaration_of_solvency_cannot_be_given", "type": "requirement_error", "when": "A director refuses or cannot sign; supervision is then needed (s.124)." }, { "code": "statutory_window_expired", "type": "requirement_error", "when": "Past 28 days; files late and flags the s.123 offence for acknowledgement." }, { "code": "special_resolution_defective", "type": "requirement_error", "when": "Notice, two-thirds majority or written-resolution authority under s.60 not met." }, { "code": "fund_requires_third_party_liquidator", "type": "requirement_error", "when": "A CIMA fund's liquidator is the operator or an engaged service provider." }, { "code": "general_partner_of_active_elp", "type": "requirement_error", "when": "Winding up the general partner is an event of withdrawal for the ELP (s.36); replace it first." }, { "code": "articles_restrict_voluntary_winding_up", "type": "jurisdiction_error", "when": "A foundation company's constitution restricts it." } ] } }, "Params_ky_voluntary_liquidation_complete": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "description": "Entity type key; must match the entity record." }, "final_meeting_date": { "type": "string", "format": "date", "description": "At least 21 days after the Gazette and contributory notice (s.127); law firms use one month.", "examples": [ "2027-01-22" ] }, "all_assets_distributed": { "type": "boolean", "description": "True if property is realised and distributed." }, "all_creditors_paid": { "type": "boolean", "description": "True if every creditor is paid in full, with interest if due." }, "quorum_present": { "type": "boolean", "description": "Provided after the meeting; Form 37 states whether a quorum attended." }, "order_certificate_of_dissolution": { "type": "boolean", "description": "Order the certificate of dissolution." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The serving voluntary liquidator.", "examples": [ "per_01K5N9D9K4YB7Q2S8U1W3XCFNP" ] }, "avoid_next_annual_fee": { "type": "boolean", "description": "Default true: target a final meeting by 29 Jan 2027." } }, "required": [ "entity_type", "final_meeting_date", "all_assets_distributed", "all_creditors_paid", "liquidator" ], "description": "Finishes the winding up. The liquidator gives at least 21 days' notice by Gazette and to each contributory, lays the final report before the final general meeting, and files the final return within 7 days." }, "Create_ky_voluntary_liquidation_complete": { "type": "object", "properties": { "type": { "const": "ky.voluntary_liquidation.complete" }, "params": { "$ref": "#/components/schemas/Params_ky_voluntary_liquidation_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Close a voluntary liquidation: final meeting, final return and dissolution", "x-entiva": { "jurisdiction": "ky", "stage": "closure", "applies_to": [ "exempted_company", "exempted_ldc", "exempted_spc", "sezc", "ordinary_resident_company", "ordinary_nonresident_company", "foundation_company", "llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "final_report_and_account", "title": "Liquidator's final report and account", "source": "uploaded", "required": true }, { "key": "final_meeting_notice", "title": "Notice of final general meeting and Gazette notice", "source": "generated", "required": true }, { "key": "final_meeting_minutes", "title": "Minutes of the final meeting", "source": "generated", "required": true }, { "key": "final_return", "title": "Liquidator's final return", "source": "generated", "required": true }, { "key": "certificate_of_dissolution", "title": "Certificate of dissolution", "source": "registry_issued", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "final_return", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "final_return", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_meeting_minutes", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "General Registry", "form": "CWR Form 37, Voluntary Liquidator's Final Return", "channel": "online", "government_fee": { "amount": 200, "currency": "KYD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "final_meeting_notice_too_short", "type": "invalid_request_error", "when": "final_meeting_date is under 21 days after the notice (s.127)." }, { "code": "return_window_missed", "type": "requirement_error", "when": "Over 7 days since the meeting; files late and flags the s.127 offence." }, { "code": "liquidation_not_in_progress", "type": "jurisdiction_error", "when": "No winding up has commenced or its filings are incomplete." }, { "code": "creditors_not_paid", "type": "requirement_error", "when": "all_creditors_paid or all_assets_distributed is false (s.127)." }, { "code": "year_end_meetings_missed", "type": "requirement_error", "when": "A s.126 meeting was missed; hold it first." }, { "code": "cima_registration_active", "type": "requirement_error", "when": "Still CIMA-registered; run ky.fund.deregister first." }, { "code": "human_presence_required", "type": "permission_error", "when": "An agent tried to give a confirmation, declaration, consent or oath only the person can give; the response carries a sign_url." } ] } }, "Params_vg_authorised_representative_appoint": { "type": "object", "properties": { "appointment_type": { "type": "string", "enum": [ "initial", "replacement" ], "description": "Initial appointment or replacement.", "examples": [ "initial" ] }, "authorised_representative": { "type": "object", "description": "{name, fsc_certificate_number, bvi_address, contact}." }, "previous_representative_ceased_on": { "type": "string", "format": "date", "description": "Required for replacements; the 21-day window runs from this date (s.65)." }, "fund_category": { "type": "string", "enum": [ "private_fund", "professional_fund", "public_fund", "private_investment_fund", "incubator_fund", "approved_fund" ], "description": "Fund type, which decides notification rules.", "examples": [ "professional_fund" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." } }, "required": [ "appointment_type", "authorised_representative", "fund_category", "effective_date" ], "description": "Appoints an authorised representative for a BVI fund. Public, private, professional, private investment and recognised foreign funds must appoint and at all times have an authorised representative certified by the FSC under SIBA s.64." }, "Create_vg_authorised_representative_appoint": { "type": "object", "properties": { "type": { "const": "vg.authorised_representative.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_authorised_representative_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint or replace a fund's FSC-certified authorised representative", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "engagement_agreement", "title": "Authorised representative engagement agreement and consent", "source": "uploaded", "required": true }, { "key": "governing_body_resolution", "title": "Directors' or general partner's resolution appointing the representative", "source": "generated", "required": true }, { "key": "fsc_notice", "title": "Notice of appointment or change of authorised representative to the FSC", "source": "generated", "required": true }, { "key": "certification_evidence", "title": "Evidence of FSC certification", "source": "uploaded", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "governing_body_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "engagement_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fsc_notice", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Notice of appointment or change of authorised representative", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "representative_not_certified", "type": null, "when": "No valid s.64 certification." }, { "code": "replacement_window_exceeded", "type": null, "when": "More than 21 days since the previous representative ceased." } ] } }, "Params_vg_beneficial_ownership_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key of the company.", "examples": [ "bc_ltd_shares" ] }, "trigger": { "type": "string", "enum": [ "incorporation", "continuation_in" ], "description": "Event that starts the 30-day clock: incorporation (s.96A) or continuation into the BVI under s.182 (s.96A).", "examples": [ "incorporation" ] }, "trigger_date": { "type": "string", "format": "date", "description": "Date on the certificate of incorporation or continuation.", "examples": [ "2026-10-14" ] }, "filing_basis": { "type": "string", "enum": [ "full_particulars", "holder_of_information", "exempt" ], "description": "full_particulars files reg 21 particulars for every beneficial owner (s.96A). holder_of_information files only the name and address of the person holding the.", "examples": [ "full_particulars" ] }, "exemption_ground": { "type": "string", "enum": [ "listed_on_recognised_exchange", "subsidiary_of_bo_regulated_entity", "subsidiary_of_fund", "subsidiary_of_listed_company", "government_owned_over_50_percent", "equivalent_disclosure_rules" ], "description": "Required when filing_basis is exempt. listed_on_recognised_exchange: s.96A, exchange in BO Regs Schedule 2. subsidiary_of_bo_regulated_entity: reg 11, parent." }, "holder_basis": { "type": "string", "enum": [ "recognised_or_registered_fund", "incubator_or_approved_fund", "shares_held_by_bvi_licensed_trustee", "shares_held_by_foreign_aml_regulated_trustee" ], "description": "Required when filing_basis is holder_of_information." }, "information_holder": { "type": "object", "description": "Required when filing_basis is holder_of_information: {name, address, capacity: category_6_licensee | authorised_representative | fsc_licensee_with_bvi_presence." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Required when filing_basis is full_particulars." }, "intermediate_entities": { "type": "array", "items": {}, "description": "Legal entities in the ownership chain with the reg 21 particulars: name and alternative names, incorporation number, date of incorporation, principal or." }, "ownership_chart": { "type": "string", "pattern": "^doc_", "description": "Ownership and control chart traced to natural persons through every layer, showing both Entiva look-through tests.", "examples": [ "doc_5Ow2NcC8" ] }, "exemption_evidence": { "type": "array", "items": {}, "description": "document_ref list proving the exemption or holder basis: listing evidence, parent's share register, fund certificate of recognition, trustee licence or AML." } }, "required": [ "entity_type", "trigger", "trigger_date", "filing_basis", "ownership_chart" ], "description": "Files the company's beneficial ownership particulars with the Registrar of Corporate Affairs within 30 days of incorporation or continuation (BCA s.96A; BO Regulations reg 17). A beneficial owner is a natural person who ultimately owns or." }, "Create_vg_beneficial_ownership_file": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership.file" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File initial beneficial ownership information", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "ownership_chart", "title": "Ownership and control structure chart", "source": "uploaded", "required": true }, { "key": "bo_particulars_form", "title": "Beneficial owner particulars and confirmation", "source": "generated", "required": false }, { "key": "sof_sow_pep_declaration", "title": "Source of funds, source of wealth and PEP declaration", "source": "generated", "required": false }, { "key": "kyb_pack", "title": "KYB pack for each intermediate legal entity", "source": "uploaded", "required": false }, { "key": "trust_documents", "title": "Trust deed and amendments", "source": "uploaded", "required": false }, { "key": "exemption_evidence", "title": "Exemption or holder-of-information evidence", "source": "uploaded", "required": false }, { "key": "holder_confirmation", "title": "Information holder's confirmation", "source": "uploaded", "required": false }, { "key": "filing_confirmation", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true }, { "key": "bo_filing_approval", "title": "Bo filing approval", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "nominee", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "bo_particulars_form", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sof_sow_pep_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bo_filing_approval", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "holder_confirmation", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "filing_confirmation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Beneficial ownership information filing", "channel": "online", "government_fee": { "amount": 125, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "bo_chain_unresolved", "type": null, "when": "The ownership chart does not reach a natural person for every 10%-or-more interest or control right." }, { "code": "verification_incomplete", "type": null, "when": "A BO, controller or nominator has not completed enhanced verification; the registered agent cannot file before verifying (s.96A)." }, { "code": "exemption_conditions_not_met", "type": null, "when": "filing_basis is exempt but the evidence does not satisfy reg 11 or reg 11; switch to full_particulars." }, { "code": "holder_not_eligible", "type": null, "when": "The information holder is not a Category 6 licensee, authorised representative, FSC licensee with BVI presence or qualifying trustee." }, { "code": "partner_declined", "type": null, "when": "Entiva team refuses to accept the client or the information." }, { "code": "filing_deadline_passed", "type": null, "when": "Created or approved after the 30-day deadline." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects or queries the filing." } ] } }, "Params_vg_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares" ], "description": "bc_ltd_shares, bc_guarantee_with_shares or bc_unlimited_with_shares (BCA s.5,,)." }, "name": { "type": "string", "description": "Name with its required ending, at most 100 permitted characters, not identical or confusingly similar to a BVI company or reserved name (s.18)." }, "name_reservation": { "type": "string", "description": "act_ id of a completed vg.company_name.reserve for this name, still within 90 days." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.18; US$200), certified translation if the name has another-language meaning." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical BVI address (s.90); omit to use the agent's office, which the memorandum then states." }, "authorised_shares_max": { "type": "integer", "description": "Maximum shares (s.9); required unless authorised_shares_unlimited." }, "authorised_shares_unlimited": { "type": "boolean", "description": "Unlimited shares; counts as over 50,000 for fees." }, "share_classes": { "type": "array", "items": {}, "description": "Item: class_name, par_value, votes_per_share, distribution_rights, redeemable (s.9)." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Each guarantee member's liability on a winding up (s.9); required for bc_guarantee_with_shares." }, "articles_option": { "type": "string", "enum": [ "entiva_standard", "custom_constitution" ], "description": "entiva_standard, or custom_constitution." }, "directors": { "type": "array", "items": {}, "description": "Proposed first directors, at least one (s.109)." }, "initial_members": { "type": "array", "items": {}, "description": "First members; one is needed once the first directors are appointed (s.79)." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of shares or votes, or control." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "name", "share_classes", "articles_option", "directors", "initial_members", "beneficial_owners_and_controllers", "business_profile", "nature_of_business", "countries_of_operation", "members", "shareholders", "beneficial_owners" ], "description": "Forms a BVI company limited by shares, limited by guarantee with shares, or unlimited with shares. The licensed registered agent signs the memorandum and articles as incorporator and files on VIRRGIN." }, "Create_vg_company_incorporate": { "type": "object", "properties": { "type": { "const": "vg.company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a BVI business company that can issue shares", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "director_consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "beneficial_owner_declaration", "title": "Beneficial owner particulars and declarations", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "KYB pack and ownership chart", "source": "uploaded", "required": false }, { "key": "virrgin_incorporation_application", "title": "VIRRGIN incorporation application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "beneficial_owner_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "virrgin_incorporation_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Memorandum and articles signed", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "director_disqualified", "type": null, "when": "requirement_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." }, { "code": "authorised_shares_missing", "type": null, "when": "invalid_request_error." } ] } }, "Params_vg_company_name_reserve": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Company type; it sets the ending: Limited, Ltd, Corp, Inc, S.A. (s.17); Unlimited, Unltd (s.17); Limited or Ltd (s.17); SPC (s.17);." }, "name": { "type": "string", "description": "Name with its required ending, at most 100 permitted characters, not identical or confusingly similar to a BVI company or reserved name (s.18)." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.18; US$200 to apply), certified translation if the name has another-language meaning." } }, "required": [ "entity_type", "name" ], "description": "Asks the Registrar, via the licensed registered agent, to hold a company name for 90 days before incorporation or continuation in. No entity exists yet, so it uses the formations endpoint." }, "Create_vg_company_name_reserve": { "type": "object", "properties": { "type": { "const": "vg.company_name.reserve" }, "params": { "$ref": "#/components/schemas/Params_vg_company_name_reserve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reserve a BVI company name for 90 days", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_request", "title": "Name reservation request", "source": "generated", "required": true }, { "key": "name_support_documents", "title": "Restricted-word consent and name translation", "source": "uploaded", "required": false }, { "key": "name_reservation_confirmation", "title": "Registrar's confirmation of the reservation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Name reservation request in the approved form", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "name_ending_invalid", "type": null, "when": "invalid_request_error." }, { "code": "name_restricted_word_consent_required", "type": null, "when": "requirement_error." }, { "code": "name_contrary_to_public_policy", "type": null, "when": "registry_error." } ] } }, "Params_vg_company_without_shares_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_guarantee_no_shares", "bc_unlimited_no_shares" ], "description": "bc_guarantee_no_shares (s.5) or bc_unlimited_no_shares (s.5)." }, "name": { "type": "string", "description": "Name with its required ending, at most 100 permitted characters, not identical or confusingly similar to a BVI company or reserved name (s.18)." }, "name_reservation": { "type": "string", "description": "act_ id of a completed vg.company_name.reserve for this name, still within 90 days." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.18; US$200), certified translation if the name has another-language meaning." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical BVI address (s.90); omit to use the agent's office, which the memorandum then states." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Each guarantee member's liability on a winding up (s.9); required for bc_guarantee_no_shares." }, "articles_option": { "type": "string", "enum": [ "entiva_standard", "custom_constitution", "none" ], "description": "entiva_standard, custom_constitution, or none (only bc_unlimited_no_shares may file a memorandum without articles, s.6)." }, "directors": { "type": "array", "items": {}, "description": "Proposed first directors, at least one (s.109)." }, "initial_members": { "type": "array", "items": {}, "description": "Item: person, member_type, is_nominee, nominator." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of capital, profits or votes, or control." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." }, "charitable_purpose": { "type": "object", "description": "Charitable or non-commercial purposes: route, wholly_or_partly, segregation_plan, regions." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "name", "articles_option", "directors", "initial_members", "beneficial_owners_and_controllers", "business_profile", "nature_of_business", "countries_of_operation", "members", "beneficial_owners" ], "description": "Forms a BVI company that cannot issue shares: limited by guarantee, or unlimited. The licensed registered agent signs the memorandum, and the articles unless the company is unlimited, as incorporator." }, "Create_vg_company_without_shares_incorporate": { "type": "object", "properties": { "type": { "const": "vg.company_without_shares.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_company_without_shares_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a BVI company without shares", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_guarantee_no_shares", "bc_unlimited_no_shares" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "director_consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "beneficial_owner_declaration", "title": "Beneficial owner particulars and declarations", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "KYB pack and ownership chart", "source": "uploaded", "required": false }, { "key": "charity_name_application", "title": "Charitable or non-commercial name application", "source": "generated", "required": false }, { "key": "virrgin_incorporation_application", "title": "VIRRGIN incorporation application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "beneficial_owner_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "virrgin_incorporation_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Memorandum, and articles unless unlimited without shares, signed", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "director_disqualified", "type": null, "when": "requirement_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." }, { "code": "guarantee_amount_required", "type": null, "when": "invalid_request_error. bc_guarantee_no_shares without guarantee_amount (s.9), or articles_option none for a non-unlimited company (s.6)." }, { "code": "charitable_terms_missing", "type": null, "when": "requirement_error." } ] } }, "Params_vg_director_appoint_first": { "type": "object", "properties": { "basis": { "type": "string", "enum": [ "first_appointment", "replacement_before_first_members" ], "description": "first_appointment: within 15 days of incorporation (s.113). replacement_before_first_members: all first directors resigned or died before any member existed." }, "directors": { "type": "array", "items": {}, "description": "At least one." }, "appointed_on": { "type": "string", "format": "date", "description": "Date of the agent's resolution; defaults to today." } }, "required": [ "directors" ], "description": "The registered agent appoints the first directors within 15 days of incorporation (BCA s.113); each appointee must first consent in writing. Opened automatically when an incorporation completes." }, "Create_vg_director_appoint_first": { "type": "object", "properties": { "type": { "const": "vg.director.appoint_first" }, "params": { "$ref": "#/components/schemas/Params_vg_director_appoint_first" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint the first directors of a new BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "registered_agent_appointment_resolution", "title": "Registered agent's written appointment of the first directors", "source": "generated", "required": true }, { "key": "director_consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "licensed_director_services_agreement", "title": "Director services agreement and licence details", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "nominee_director", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "registered_agent_appointment_resolution", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "director_consent_to_act", "signer_role": "appointee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "licensed_director_services_agreement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None for the appointment itself", "form": "No registry form. Written appointment", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "first_directors_already_appointed", "type": null, "when": "invalid_request_error." }, { "code": "appointment_overdue", "type": null, "when": "requirement_error." }, { "code": "director_consent_missing", "type": null, "when": "requirement_error." }, { "code": "director_disqualified", "type": null, "when": "requirement_error." }, { "code": "licensed_director_details_required", "type": null, "when": "requirement_error." } ] } }, "Params_vg_foreign_company_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Always foreign_company." }, "corporate_name": { "type": "string", "description": "Name in the home jurisdiction (s.186)." }, "alternate_name": { "type": "string", "description": "BVI trading name if the Registrar finds the corporate name undesirable (s.186, s.187); if it demands one, a provide_param requirement appears." }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 code of the place of incorporation, with a subdivision for US states." }, "home_registration_number": { "type": "string", "description": "Number in the home registry." }, "date_of_incorporation": { "type": "string", "format": "date", "description": "Date of incorporation in the home jurisdiction." }, "home_registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office in the country of incorporation (s.186)." }, "directors": { "type": "array", "items": {}, "description": "Directors at the application date." }, "members": { "type": "array", "items": {}, "description": "Members at the application date." }, "business_in_bvi": { "type": "object", "description": "Fields: description, start_date, already_trading." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: certified translation of the name or of any non-English document (s.186; Regs reg 4, reg 29)." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of the foreign company, or control." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." } }, "required": [ "entity_type", "corporate_name", "home_jurisdiction", "home_registration_number", "date_of_incorporation", "home_registered_office", "directors", "members", "business_in_bvi", "beneficial_owners_and_controllers", "business_profile" ], "description": "Registers a company incorporated elsewhere on the BVI Register of Foreign Companies so it can lawfully carry on business in the Virgin Islands. The licensed registered agent files the application with its endorsed appointment." }, "Create_vg_foreign_company_register": { "type": "object", "properties": { "type": { "const": "vg.foreign_company.register" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a foreign company to carry on business in the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "evidence_of_incorporation", "title": "Evidence of incorporation", "source": "uploaded", "required": true }, { "key": "certified_constitution", "title": "Certified copy of the constitution", "source": "uploaded", "required": true }, { "key": "directors_list", "title": "List of directors", "source": "generated", "required": true }, { "key": "members_list", "title": "List of members", "source": "generated", "required": true }, { "key": "registered_agent_notice", "title": "Notice of registered agent, endorsed", "source": "generated", "required": true }, { "key": "certified_translation", "title": "Certified translation", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Board resolution authorising registration", "source": "uploaded", "required": true }, { "key": "director_statement_on_business", "title": "Director's statement on the nature of the business", "source": "generated", "required": true }, { "key": "application_accuracy_declaration", "title": "Declaration that the application is accurate", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "Ownership chart", "source": "uploaded", "required": false }, { "key": "virrgin_foreign_company_application", "title": "VIRRGIN foreign company application", "source": "generated", "required": true }, { "key": "certificate_of_registration_foreign_company", "title": "Certificate of registration as a foreign company", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "registered_agent_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_statement_on_business", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_accuracy_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "virrgin_foreign_company_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Approved-form application with evidence of incorporation, certified constitution, lists of", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "partner_not_approved_for_foreign_companies", "type": null, "when": "requirement_error." }, { "code": "alternate_name_required", "type": null, "when": "registry_error." }, { "code": "translation_required", "type": null, "when": "requirement_error." }, { "code": "already_trading_without_registration", "type": null, "when": "requirement_error. already_trading true with no application pending; the partner warns of the US$75,000 exposure (s.186) before filing." }, { "code": "list_incomplete", "type": null, "when": "invalid_request_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." } ] } }, "Params_vg_fund_recognise": { "type": "object", "properties": { "fund_category": { "type": "string", "enum": [ "private_fund", "professional_fund" ], "description": "Private or professional fund (s.55).", "examples": [ "professional_fund" ] }, "private_fund_basis": { "type": "string", "enum": [ "max_50_investors", "private_offering_only" ], "description": "Required for private funds: the constitutional restriction relied on (s.55)." }, "minimum_initial_investment": { "$ref": "#/components/schemas/Money", "description": "Required for professional funds: at least the sum prescribed in the Mutual Fund Regulations (s.55); exempted investors excepted (s.55)." }, "commenced_business_date": { "type": "string", "format": "date", "description": "Professional funds relying on s.44: the date business started." }, "applicant_capacity": { "type": "string", "enum": [ "fund_company", "partner_of_partnership", "trustee_of_unit_trust", "manager" ], "description": "Who applies (s.55).", "examples": [ "fund_company" ] }, "functionaries": { "type": "array", "items": {}, "description": "Each item: {role: manager | administrator | custodian | investment_advisor | auditor, name, jurisdiction, regulator}." }, "authorised_representative": { "type": "object", "description": "{name, fsc_certificate_number, bvi_address}." }, "constitutional_documents": { "type": "string", "pattern": "^doc_", "description": "Memorandum and articles or partnership agreement containing the s.55 or restrictions." }, "offering_document": { "type": "string", "pattern": "^doc_", "description": "Offering memorandum or term sheet; whether one is mandatory is set by the Mutual Fund Regulations." }, "investment_warning": { "type": "string", "pattern": "^doc_", "description": "Prescribed investment warning that every investor must acknowledge in writing (s.56)." } }, "required": [ "fund_category", "applicant_capacity", "functionaries", "authorised_representative", "constitutional_documents", "investment_warning" ], "description": "Applies to the FSC to recognise a mutual fund as a private fund or a professional fund under the Securities and Investment Business Act. A company, a partnership or a unit trust may not carry on business as a mutual fund in or from within." }, "Create_vg_fund_recognise": { "type": "object", "properties": { "type": { "const": "vg.fund.recognise" }, "params": { "$ref": "#/components/schemas/Params_vg_fund_recognise" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Recognise a BVI private or professional fund", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "recognition_application", "title": "Application for recognition as a private or professional fund", "source": "generated", "required": true }, { "key": "constitutional_documents", "title": "Constitutional documents with investor restrictions", "source": "uploaded", "required": true }, { "key": "offering_document", "title": "Offering document", "source": "uploaded", "required": false }, { "key": "investment_warning", "title": "Investment warning", "source": "generated", "required": true }, { "key": "functionary_agreements", "title": "Functionary agreements", "source": "uploaded", "required": true }, { "key": "authorised_representative_appointment", "title": "Authorised representative appointment", "source": "uploaded", "required": true }, { "key": "auditor_consent", "title": "Auditor's consent", "source": "uploaded", "required": false }, { "key": "governing_body_resolution", "title": "Directors' or general partner's resolution approving the application", "source": "generated", "required": true }, { "key": "certificate_of_recognition", "title": "Certificate of recognition (s.55)", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "officer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "recognition_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "governing_body_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "functionary_agreements", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application for recognition as a private fund or professional fund", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "investor_restriction_missing", "type": null, "when": "The constitutional documents lack the s.55 or restriction." }, { "code": "authorised_representative_missing", "type": null, "when": "No FSC-certified authorised representative." }, { "code": "professional_window_exceeded", "type": null, "when": "A professional fund has been operating more than 21 days, or did not apply within 14 days." }, { "code": "incubator_status_conflict", "type": null, "when": "The fund is currently an incubator or approved fund; it cannot be recognised as private or professional at the same time (Incubator and Approved Funds Regulations reg 2)." }, { "code": "fsc_refused", "type": null, "when": "The FSC refuses recognition." } ] } }, "Params_vg_general_partnership_form": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "general_partnership" ], "description": "Fixed for this action type.", "examples": [ "general_partnership" ] }, "name": { "type": "string", "description": "Partnership name.", "examples": [ "Tortola Marine Services" ] }, "partners": { "type": "array", "items": {}, "description": "At least two.", "examples": [ "[{\"partner\":\"per_3aBc11\",\"kind\":\"individual\",\"capital_contribution\":{\"amount\":20000,\"currency\":\"USD\"},\"profit_share_percentage\":50,\"managing_partner\":true},{\"partner\":\"per_7dEf22\",\"kind\":\"individual\",\"capital_contribution\":{\"amount\":20000,\"currency\":\"USD\"},\"profit_share_percentage\":50,\"managing_partner\":false}]" ] }, "business_purpose": { "type": "string", "description": "Business carried on in common with a view of profit.", "examples": [ "Yacht charter support services" ] }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal place of business.", "examples": [ "{\"line1\":\"12 Waterfront Drive\",\"city\":\"Road Town\",\"region\":\"Tortola\",\"country\":\"VG\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the partnership starts.", "examples": [ "2026-11-01" ] }, "partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "Uploaded agreement; if omitted Entiva generates one from the terms above.", "examples": [ "doc_9Pa2Lq" ] }, "expected_activity": { "type": "object", "description": "Expected turnover, countries and source of funds.", "examples": [ "{\"annual_turnover\":{\"amount\":150000,\"currency\":\"USD\"},\"countries\":[\"VG\"],\"source_of_funds\":\"Partners' savings\"}" ] }, "trade_licence_required": { "type": "boolean", "description": "If true, queues vg.trade_licence.apply once the partnership exists.", "examples": [ "true" ] } }, "required": [ "entity_type", "name", "partners", "business_purpose", "principal_place_of_business", "effective_date", "expected_activity" ], "description": "Records a general partnership formed by agreement under the Partnership Act 1996. Nothing is filed with the Registrar, so no registered agent is involved and the government fee is nil." }, "Create_vg_general_partnership_form": { "type": "object", "properties": { "type": { "const": "vg.general_partnership.form" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partnership_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a BVI general partnership by agreement", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": true }, { "key": "passport", "title": "Photo ID of each partner", "source": "uploaded", "required": false }, { "key": "proof_of_address", "title": "Proof of address of each partner", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Corporate partner's resolution authorising entry into the partnership", "source": "uploaded", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "applicant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No registry form: the partnership agreement is private", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "too_few_partners", "type": null, "when": "Fewer than two partners supplied." }, { "code": "profit_shares_invalid", "type": null, "when": "profit_share_percentage values do not sum to 100." }, { "code": "partner_unverified", "type": null, "when": "A partner has not completed verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open screening alert pauses the action." } ] } }, "Params_vg_incubator_or_approved_fund_apply": { "type": "object", "properties": { "fund_status": { "type": "string", "enum": [ "incubator_fund", "approved_fund" ], "description": "Status applied for.", "examples": [ "incubator_fund" ] }, "investment_strategy": { "type": "string", "description": "Written description of the strategy (reg 3)." }, "expected_investors": { "type": "integer", "description": "No more than 20 at any time (regs 10, 11).", "examples": [ "12" ] }, "expected_net_assets": { "$ref": "#/components/schemas/Money", "description": "Incubator up to US$20,000,000; approved up to US$100,000,000 (regs 10, 11)." }, "directors": { "type": "array", "items": {}, "description": "At least two, one an individual (reg 9); for an LP fund, Entiva applies this to the general partner's board." }, "authorised_representative": { "type": "object", "description": "{name, fsc_certificate_number, bvi_address} (reg 9)." }, "administrator": { "type": "object", "description": "Required for approved funds (reg 9)." }, "safekeeping_arrangements": { "type": "string", "description": "Arrangements for safekeeping and segregation of fund property (reg 9)." }, "valuation_policy": { "type": "string", "pattern": "^doc_", "description": "Valuation policy and procedures, valuation at least annually, independence of valuation." }, "investment_warning": { "type": "string", "pattern": "^doc_", "description": "Written warning in the reg 4 terms, in the offering document or as a separate document." }, "constitutional_documents": { "type": "string", "pattern": "^doc_", "description": "Must state whether the fund intends to be an incubator or approved fund (reg 3)." } }, "required": [ "fund_status", "investment_strategy", "expected_investors", "expected_net_assets", "directors", "authorised_representative", "safekeeping_arrangements", "valuation_policy", "investment_warning", "constitutional_documents" ], "description": "Applies to the FSC for a fund to be approved as an incubator fund or an approved fund under the Securities and Investment Business Regulations. The application in the prescribed form includes constitutional documents stating the intended." }, "Create_vg_incubator_or_approved_fund_apply": { "type": "object", "properties": { "type": { "const": "vg.incubator_or_approved_fund.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_incubator_or_approved_fund_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for incubator fund or approved fund status", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Application for incubator or approved fund status", "source": "generated", "required": true }, { "key": "constitutional_documents", "title": "Constitutional documents stating the intended status", "source": "uploaded", "required": true }, { "key": "investment_strategy", "title": "Investment strategy", "source": "generated", "required": true }, { "key": "investment_warning", "title": "Investment warning", "source": "generated", "required": true }, { "key": "valuation_policy", "title": "Valuation policy", "source": "uploaded", "required": true }, { "key": "authorised_representative_appointment", "title": "Authorised representative appointment", "source": "uploaded", "required": true }, { "key": "administrator_agreement", "title": "Administrator agreement", "source": "uploaded", "required": false }, { "key": "status_certificate", "title": "Certificate evidencing incubator or approved fund status (reg 5)", "source": "registry_issued", "required": true }, { "key": "governing_body_resolution", "title": "Governing body resolution", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "governing_body_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application to be approved as an incubator fund or approved fund", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "director_minimum_not_met", "type": null, "when": "Fewer than two directors or none is an individual (reg 9)." }, { "code": "administrator_missing", "type": null, "when": "Approved fund without an administrator (reg 9)." }, { "code": "limits_exceeded", "type": null, "when": "Expected investors exceed 20 or net assets exceed the cap." }, { "code": "application_abandoned", "type": null, "when": "The FSC's completeness deadline passed (reg 5)." } ] } }, "Params_vg_insurer_spc_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must include 'Segregated Portfolio Company' or 'SPC' before the ending (BCA s.17).", "examples": [ "Tidewater Captive Insurance SPC Ltd" ] }, "restricted_name_consent_action": { "type": "string", "description": "act_ id of vg.restricted_name_consent.apply." }, "licence_category": { "type": "string", "enum": [ "category_c", "other_than_category_c" ], "description": "Whether the insurer will hold a Category C licence; sets FSC fees.", "examples": [ "other_than_category_c" ] }, "insurance_manager": { "type": "object", "description": "{name, licence_number} (reg 3)." }, "initial_portfolios": { "type": "array", "items": {}, "description": "Each item: {name including 'Segregated Portfolio' (BCA s.138), line_of_business, cell_owner}." }, "authorised_shares_band": { "type": "string", "enum": [ "up_to_50000", "over_50000" ], "description": "Sets the Registrar's incorporation fee.", "examples": [ "up_to_50000" ] }, "proposed_directors": { "type": "array", "items": {}, "description": "per_ or ent_ ids." }, "auditor": { "type": "object", "description": "Auditor." }, "business_plan": { "type": "string", "pattern": "^doc_", "description": "Supporting the Insurance Act licence application." }, "target_incorporation_date": { "type": "string", "format": "date", "description": "Sets the initial fee band." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "name", "licence_category", "insurance_manager", "initial_portfolios", "authorised_shares_band", "proposed_directors", "auditor", "business_plan", "nature_of_business", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Obtains the FSC's written approval and then incorporates a new company limited by shares as a segregated portfolio company that will be a licensed BVI insurer (BCA ss.135-137; Segregated Portfolio Companies Regulations regs 3-4). The." }, "Create_vg_insurer_spc_incorporate": { "type": "object", "properties": { "type": { "const": "vg.insurer_spc.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_insurer_spc_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a BVI insurer segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "fsc_spc_application", "title": "Application to incorporate a BVI insurer SPC", "source": "generated", "required": true }, { "key": "insurer_licence_application", "title": "Application for a BVI insurer's licence under the Insurance Act, with its supporting documents", "source": "uploaded", "required": true }, { "key": "proposed_memorandum_and_articles", "title": "Proposed memorandum and articles", "source": "generated", "required": true }, { "key": "insurance_manager_appointment", "title": "Insurance manager appointment (names the portfolios and duties, reg 5)", "source": "uploaded", "required": true }, { "key": "business_plan", "title": "Business plan", "source": "uploaded", "required": true }, { "key": "auditor_consent", "title": "Auditor's consent", "source": "uploaded", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "director_consents", "title": "Directors' written consents", "source": "generated", "required": true }, { "key": "fsc_approval", "title": "FSC written approval", "source": "registry_issued", "required": true }, { "key": "insurer_licence", "title": "Insurer's licence", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "incorporation_filing", "title": "Incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "fsc_spc_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "insurer_licence_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "proposed_memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "director_consents", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "incorporation_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application to incorporate a company as a BVI insurer SPC", "channel": "online", "government_fee": { "amount": 3000, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "spc_name_invalid", "type": null, "when": "Missing 'SPC' designation or 'Segregated Portfolio' in a portfolio name." }, { "code": "insurance_manager_missing", "type": null, "when": "No insurance manager is named (reg 3, reg 5)." }, { "code": "licence_application_missing", "type": null, "when": "The Insurance Act licence application is not attached (reg 3)." }, { "code": "fsc_refused", "type": null, "when": "The FSC refuses approval or the licence." } ] } }, "Params_vg_insurer_spc_register": { "type": "object", "properties": { "licence_category": { "type": "string", "enum": [ "category_c", "other_than_category_c" ], "description": "Sets FSC fees.", "examples": [ "category_c" ] }, "insurer_licence_number": { "type": "string", "description": "Existing Insurance Act licence." }, "name": { "type": "string", "description": "Including 'Segregated Portfolio Company' or 'SPC' (BCA s.17)." }, "insurance_manager": { "type": "object", "description": "{name, licence_number}; serves the company and all portfolios (reg 3)." }, "initial_portfolios": { "type": "array", "items": {}, "description": "Each item: {name with 'Segregated Portfolio', assets_to_allocate, policies_to_allocate}." }, "statement_date": { "type": "string", "format": "date", "description": "No more than 6 months before the application (reg 3)." }, "policyholder_notice_date": { "type": "string", "format": "date", "description": "Date policyholders were notified (reg 3)." }, "amended_memorandum_and_articles": { "type": "string", "pattern": "^doc_", "description": "Proposed SPC memorandum and articles." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "licence_category", "insurer_licence_number", "name", "insurance_manager", "initial_portfolios", "statement_date", "policyholder_notice_date", "amended_memorandum_and_articles", "nature_of_business", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Obtains FSC approval for an existing licensed BVI insurer to be registered as a segregated portfolio company (BCA s.135; SPC Regulations reg 3). The application comes with the memorandum and articles and proposed changes; a director-signed." }, "Create_vg_insurer_spc_register": { "type": "object", "properties": { "type": { "const": "vg.insurer_spc.register" }, "params": { "$ref": "#/components/schemas/Params_vg_insurer_spc_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an existing BVI insurer as a segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "fsc_spc_application", "title": "Application to register an existing BVI insurer as an SPC", "source": "generated", "required": true }, { "key": "current_memorandum_and_articles", "title": "Current memorandum and articles", "source": "uploaded", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Proposed amended memorandum and articles", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities (reg 3)", "source": "generated", "required": true }, { "key": "directors_declaration", "title": "Directors' declaration (reg 3)", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the application", "source": "generated", "required": true }, { "key": "policyholder_notice", "title": "Notice to policyholders", "source": "generated", "required": true }, { "key": "fsc_approval", "title": "FSC written approval", "source": "registry_issued", "required": true }, { "key": "registry_filing", "title": "Registry filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_assets_and_liabilities", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "policyholder_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fsc_spc_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registry_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application to register an existing BVI insurer as a segregated portfolio company", "channel": "online", "government_fee": { "amount": 3000, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_a_licensed_insurer", "type": null, "when": "The company holds no Insurance Act licence." }, { "code": "statement_too_old", "type": null, "when": "The statement is more than 6 months old." }, { "code": "policyholders_not_notified", "type": null, "when": "No notice to policyholders is recorded." }, { "code": "fsc_refused", "type": null, "when": "The FSC refuses approval." } ] } }, "Params_vg_insurer_spc_approval_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "insurer_spc" ], "description": "Fixed for this action type.", "examples": [ "insurer_spc" ] }, "route": { "type": "string", "enum": [ "new_incorporation", "register_existing_insurer" ], "description": "New incorporation or registration of an existing insurer.", "examples": [ "new_incorporation" ] }, "name": { "type": "string", "description": "Proposed SPC name.", "examples": [ "Reef Captive Insurance SPC" ] }, "insurer_category": { "type": "string", "enum": [ "category_c", "non_category_c" ], "description": "Determines the fee: non-Category C US$3,000 plus US$750 per portfolio; Category C US$7,500 plus US$1,000 per portfolio.", "examples": [ "non_category_c" ] }, "initial_portfolios": { "type": "array", "items": {}, "description": "Each item: name, class_of_business.", "examples": [ "[{\"name\":\"Marine Cell\",\"class_of_business\":\"Marine liability\"}]" ] }, "insurance_licence_status": { "type": "string", "enum": [ "held", "applied", "to_apply" ], "examples": [ "to_apply" ] }, "existing_insurer": { "type": "object", "description": "For register_existing_insurer: current entity_ref or foreign registration details and licence reference.", "examples": [ "{\"licence_reference\":\"INS-0001\"}" ] }, "constitution": { "type": "string", "pattern": "^doc_", "description": "Draft memorandum and articles with SPC provisions.", "examples": [ "doc_2Ma7Kd" ] }, "directors": { "type": "array", "items": {}, "description": "Proposed directors.", "examples": [ "[\"per_4Dd09\"]" ] }, "business_plan": { "type": "string", "pattern": "^doc_", "description": "Business plan and projections supporting the insurer application.", "examples": [ "doc_8Bp2Qw" ] } }, "required": [ "entity_type", "route", "name", "insurer_category", "initial_portfolios", "insurance_licence_status", "constitution", "directors", "business_plan" ], "description": "Applies to the FSC for approval to incorporate a new BVI insurer segregated portfolio company, or to register an existing insurer as one, before the SPC is incorporated or registered. The Insurance Act licence is a separate licence that." }, "Create_vg_insurer_spc_approval_apply": { "type": "object", "properties": { "type": { "const": "vg.insurer_spc_approval.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_insurer_spc_approval_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for FSC approval of an insurer SPC", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "fsc_spc_application", "title": "FSC application form for insurer SPC approval", "source": "generated", "required": true }, { "key": "constitution", "title": "Draft memorandum and articles", "source": "uploaded", "required": true }, { "key": "business_plan", "title": "Business plan", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Promoter ownership chart", "source": "uploaded", "required": false }, { "key": "fsc_approval", "title": "FSC approval letter", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "fsc_spc_application", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Financial Services Commission", "form": "Application in the FSC approved form with incorporation documents", "channel": "online", "government_fee": { "amount": 3000, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "insurance_licence_missing", "type": null, "when": "insurance_licence_status is to_apply and no licence application has been started." }, { "code": "category_unconfirmed", "type": null, "when": "The insurer category cannot be confirmed from the business plan." }, { "code": "existing_insurer_details_missing", "type": null, "when": "route is register_existing_insurer without existing_insurer." }, { "code": "fsc_declined", "type": null, "when": "The FSC declines the application." } ] } }, "Params_vg_limited_partnership_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "limited_partnership has legal personality (LPA s.5). lp_without_legal_personality records the general partners' election not to (s.8); it cannot be undone." }, "confirm_irrevocable_election": { "type": "boolean", "description": "Must be true for lp_without_legal_personality: each general partner approves the irrevocable election before an agent may sign." }, "name": { "type": "string", "description": "Ends Limited Partnership, L.P. or LP (s.11); at most 100 permitted characters." }, "name_reservation": { "type": "string", "description": "act_ id of a completed vg.limited_partnership_name.reserve for this name." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.13), certified translation if the name has another-language meaning (LP Regs reg 4)." }, "term_type": { "type": "string", "enum": [ "unlimited", "fixed" ], "description": "unlimited, or fixed with term_end_date (s.8)." }, "term_end_date": { "type": "string", "format": "date", "description": "Required when term_type is fixed." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical BVI address (s.18); omit to use the agent's office, which the statement then states." }, "general_partners": { "type": "array", "items": {}, "description": "At least one, individual or body corporate (s.6)." }, "limited_partners": { "type": "array", "items": {}, "description": "At least one (s.6)." }, "partnership_agreement_option": { "type": "string", "enum": [ "model_agreement", "entiva_standard", "custom_agreement" ], "description": "model_agreement (LP Regs Sch. 2; deemed adopted if no signed agreement says otherwise, s.7), entiva_standard, or custom_agreement." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of capital, profits or votes, or control; a general partner is a controller." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "name", "term_type", "general_partners", "limited_partners", "partnership_agreement_option", "beneficial_owners_and_controllers", "business_profile", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Registers a limited partnership under the Limited Partnership Act 2017, with or without legal personality. The licensed registered agent files a statement signed by or on behalf of each general partner, an optional irrevocable." }, "Create_vg_limited_partnership_register": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "lp_registration_statement", "title": "Registration statement of the general partners", "source": "generated", "required": true }, { "key": "no_legal_personality_declaration", "title": "Declaration electing no legal personality", "source": "generated", "required": false }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "partner_consent", "title": "Written consent of each partner", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Limited partnership agreement", "source": "generated", "required": false }, { "key": "beneficial_owner_declaration", "title": "Beneficial owner particulars and declarations", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "KYB pack and ownership chart", "source": "uploaded", "required": false }, { "key": "virrgin_lp_filing", "title": "VIRRGIN LP registration application", "source": "generated", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "lp_registration_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "no_legal_personality_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "partner_consent", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "limited_partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "beneficial_owner_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "virrgin_lp_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Statement signed", "channel": "online", "government_fee": { "amount": 750, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "partner_missing", "type": null, "when": "invalid_request_error." }, { "code": "legal_personality_election_unconfirmed", "type": null, "when": "requirement_error. lp_without_legal_personality without confirm_irrevocable_election (s.8)." }, { "code": "beneficial_owner_unresolved", "type": null, "when": "requirement_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." } ] } }, "Params_vg_limited_partnership_name_reserve": { "type": "object", "properties": { "name": { "type": "string", "description": "Ends Limited Partnership, L.P. or LP (LPA s.11); at most 100 permitted characters." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.13; US$200 to apply; Notice 2021), certified translation if the name has another-language meaning (LP Regs reg." } }, "required": [ "name" ], "description": "Asks the Registrar, via the licensed registered agent, to hold a limited partnership name for 90 days before registration. No entity exists yet, so it uses the formations endpoint." }, "Create_vg_limited_partnership_name_reserve": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership_name.reserve" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_name_reserve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reserve a BVI limited partnership name for 90 days", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_request", "title": "Name reservation request", "source": "generated", "required": true }, { "key": "name_support_documents", "title": "Restricted-word consent and name translation", "source": "uploaded", "required": false }, { "key": "name_reservation_confirmation", "title": "Registrar's confirmation of the reservation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Name reservation request on VIRRGIN", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "name_ending_invalid", "type": null, "when": "invalid_request_error." }, { "code": "name_restricted_word_consent_required", "type": null, "when": "requirement_error." }, { "code": "name_contrary_to_public_policy", "type": null, "when": "registry_error." } ] } }, "Params_vg_lp_beneficial_ownership_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP entity type key.", "examples": [ "lp" ] }, "trigger": { "type": "string", "enum": [ "registration", "continuation_in" ], "description": "Registration (s.53B) or continuation under s.68 (s.53B).", "examples": [ "registration" ] }, "trigger_date": { "type": "string", "format": "date", "description": "Date of the certificate of registration or continuation.", "examples": [ "2026-10-15" ] }, "filing_basis": { "type": "string", "enum": [ "full_particulars", "holder_of_information", "exempt" ], "description": "full_particulars (s.53B); holder_of_information (s.53B); exempt (reg 11, or).", "examples": [ "full_particulars" ] }, "exemption_ground": { "type": "string", "enum": [ "subsidiary_of_bo_regulated_entity", "equivalent_disclosure_rules", "subsidiary_of_fund" ], "description": "Required when exempt. subsidiary_of_bo_regulated_entity (reg 11); equivalent_disclosure_rules (reg 11); subsidiary_of_fund (reg 11)." }, "information_holder": { "type": "object", "description": "Required for holder_of_information: {name, address, capacity: category_6_licensee | authorised_representative | fsc_licensee_with_bvi_presence, licence_number}." }, "fund_status": { "type": "string", "enum": [ "private_fund", "professional_fund", "public_fund", "private_investment_fund", "incubator_fund", "approved_fund" ], "description": "Fund category supporting holder_of_information (s.53B)." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Required for full_particulars." }, "intermediate_entities": { "type": "array", "items": {}, "description": "Legal entities in the chain with reg 21 particulars, including a corporate general partner." }, "ownership_chart": { "type": "string", "pattern": "^doc_", "description": "Chart through every layer to natural persons." } }, "required": [ "entity_type", "trigger", "trigger_date", "filing_basis", "ownership_chart" ], "description": "Files the limited partnership's beneficial ownership particulars with the Registrar within 30 days of registration or continuation (Limited Partnership Act s.53B; BO Regulations reg 17). For an LP, a beneficial owner is a natural person." }, "Create_vg_lp_beneficial_ownership_file": { "type": "object", "properties": { "type": { "const": "vg.lp_beneficial_ownership.file" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_beneficial_ownership_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File initial beneficial ownership information", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": true }, { "key": "bo_particulars_form", "title": "Beneficial owner particulars and confirmation", "source": "generated", "required": false }, { "key": "sof_sow_pep_declaration", "title": "Source of funds, source of wealth and PEP declaration", "source": "generated", "required": false }, { "key": "partnership_agreement", "title": "Limited partnership agreement", "source": "uploaded", "required": true }, { "key": "kyb_pack", "title": "KYB pack for corporate partners and intermediate entities", "source": "uploaded", "required": false }, { "key": "holder_confirmation", "title": "Information holder's confirmation", "source": "uploaded", "required": false }, { "key": "filing_confirmation", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true }, { "key": "bo_filing_approval", "title": "Bo filing approval", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "trustee", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "bo_particulars_form", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "sof_sow_pep_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bo_filing_approval", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "filing_confirmation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Beneficial ownership information", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "bo_chain_unresolved", "type": null, "when": "No natural person is identified for a 10%-or-more interest or for control of the general partner." }, { "code": "verification_incomplete", "type": null, "when": "A BO or GP has not completed enhanced verification (s.53B)." }, { "code": "exemption_conditions_not_met", "type": null, "when": "The claimed exemption or holder basis is not proven." }, { "code": "partner_declined", "type": null, "when": "Entiva refuses the client or the information." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects or queries the filing." } ] } }, "Params_vg_lp_without_legal_personality_register": { "type": "object", "properties": { "name": { "type": "string", "description": "Must end with 'Limited Partnership', 'L.P.' or 'LP' (s.11); at most 100 permitted characters.", "examples": [ "Coral Bay Co-Invest LP" ] }, "foreign_character_name": { "type": "string", "description": "Optional foreign character name (s.8, s.14)." }, "name_reservation_action": { "type": "string", "description": "act_ id of a 90-day LP name reservation, if any." }, "restricted_name_consent_action": { "type": "string", "description": "act_ id of a completed vg.restricted_name_consent.apply, required if the name has a restricted word." }, "name_translation": { "type": "string", "pattern": "^doc_", "description": "Certified translation where the name has a meaning in a language other than English." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Defaults to Entiva BVI office (s.8; s.18)." }, "term": { "type": "object", "description": "{type: fixed | unlimited, end_date} (s.8).", "examples": [ "{\"type\":\"fixed\",\"end_date\":\"2036-12-31\"}" ] }, "general_partners": { "type": "array", "items": {}, "description": "At least one (s.6)." }, "limited_partners": { "type": "array", "items": {}, "description": "At least one (s.6)." }, "no_legal_personality_election": { "type": "boolean", "description": "Must be true for this action type.", "examples": [ "true" ] }, "election_acknowledged_by": { "type": "array", "items": {}, "description": "per_ ids of the individuals who approve the irrevocable election for each general partner." }, "partnership_agreement": { "type": "object", "description": "{source: entiva_template | customer_upload | statutory_model_only, document: doc_ id}." }, "fund_status": { "type": "string", "enum": [ "not_a_fund", "private_fund", "professional_fund", "public_fund", "private_investment_fund", "incubator_fund", "approved_fund" ], "description": "Whether the LP will be a SIBA fund or incubator or approved fund.", "examples": [ "not_a_fund" ] }, "business_purpose": { "type": "string", "description": "Purpose and intended nature of the business (AML/TF Code s.19)." }, "expected_activity": { "type": "object", "description": "{countries[], expected_assets, expected_investors}." }, "source_of_funds": { "type": "string", "description": "Source of the partners' capital (Code s.19)." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "name", "term", "general_partners", "limited_partners", "no_legal_personality_election", "election_acknowledged_by", "partnership_agreement", "fund_status", "business_purpose", "expected_activity", "source_of_funds", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Registers a Limited Partnership Act 2017 limited partnership whose general partners elect that it will not have legal personality. Without that election a new BVI LP has legal personality by default (s.5); the election can only be made at." }, "Create_vg_lp_without_legal_personality_register": { "type": "object", "properties": { "type": { "const": "vg.lp_without_legal_personality.register" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_without_legal_personality_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a limited partnership without legal personality", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "lp_statement", "title": "Statement of the general partners (s.8)", "source": "generated", "required": true }, { "key": "no_legal_personality_declaration", "title": "Declaration that the LP will not have legal personality (s.8)", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act (s.8)", "source": "generated", "required": true }, { "key": "partner_consents", "title": "Written consent of each general and limited partner (s.6)", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Limited partnership agreement", "source": "generated", "required": true }, { "key": "corporate_partner_kyb_pack", "title": "KYB pack for each corporate partner", "source": "uploaded", "required": false }, { "key": "corporate_gp_resolution", "title": "Board resolution of each corporate general partner", "source": "generated", "required": false }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration stating no legal personality (s.9)", "source": "registry_issued", "required": true }, { "key": "election_approval", "title": "Election approval", "source": "generated", "required": true }, { "key": "registration_filing", "title": "Registration filing", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "election_approval", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lp_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "no_legal_personality_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "partner_consents", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "limited_partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registration_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Application for registration of a limited partnership", "channel": "online", "government_fee": { "amount": 750, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_ending_invalid", "type": null, "when": "The name does not end with 'Limited Partnership', 'L.P.' or 'LP' (s.11)." }, { "code": "name_unavailable", "type": null, "when": "Identical or confusingly similar to an existing LP or BVI company (s.13)." }, { "code": "restricted_word_without_consent", "type": null, "when": "The name has a restricted word and no FSC consent is attached (s.13)." }, { "code": "election_not_confirmed", "type": null, "when": "A general partner has not approved the irrevocable election." }, { "code": "partner_minimum_not_met", "type": null, "when": "Fewer than one general partner and one limited partner (s.6)." }, { "code": "partner_declined", "type": null, "when": "Entiva refuses the client." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses registration." } ] } }, "Params_vg_mutual_fund_spc_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must include 'Segregated Portfolio Company' or 'SPC' before a BCA s.17 ending (s.17). 'Fund' and 'Portfolio' are restricted words needing FSC consent.", "examples": [ "Meridian Global Fund SPC Ltd" ] }, "restricted_name_consent_action": { "type": "string", "description": "act_ id of vg.restricted_name_consent.apply." }, "fund_regime": { "type": "string", "enum": [ "private_fund", "professional_fund", "public_fund", "incubator_fund", "approved_fund" ], "description": "Regime the SPC will be under; decides which application accompanies (reg 3-).", "examples": [ "professional_fund" ] }, "authorised_shares_band": { "type": "string", "enum": [ "up_to_50000", "over_50000" ], "description": "Sets the Registrar's incorporation fee (s.7-).", "examples": [ "over_50000" ] }, "share_classes": { "type": "array", "items": {}, "description": "General shares and segregated portfolio shares by portfolio, with par value, currency and rights." }, "administrator": { "type": "object", "description": "{name, jurisdiction, licence_or_regulator} (reg 3); cannot be exempted (reg 5)." }, "initial_portfolios": { "type": "array", "items": {}, "description": "Each item: {name (must include 'Segregated Portfolio', BCA s.138), functionaries: {manager, administrator, custodian, investment_advisor}, offering_document." }, "auditor": { "type": "object", "description": "Required for private, professional and public funds (reg 6)." }, "authorised_representative": { "type": "object", "description": "{name, fsc_certificate_number, bvi_address}." }, "proposed_directors": { "type": "array", "items": {}, "description": "per_ or ent_ ids." }, "memorandum_and_articles": { "type": "string", "pattern": "^doc_", "description": "Customer draft; otherwise Entiva's SPC template with segregation and e-signature clauses." }, "target_incorporation_date": { "type": "string", "format": "date", "description": "On or before 30 June the FSC initial fee is US$1,500 plus US$300 per portfolio; from 1 July US$750 plus US$150." }, "business_purpose": { "type": "string", "description": "Investment strategy and intended investors (Code s.19)." }, "source_of_funds": { "type": "string", "description": "Source of seed capital and management share subscription." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "name", "fund_regime", "authorised_shares_band", "share_classes", "administrator", "initial_portfolios", "authorised_representative", "proposed_directors", "business_purpose", "source_of_funds", "nature_of_business", "countries_of_operation", "directors", "shareholders", "beneficial_owners" ], "description": "Obtains the FSC's written approval and then incorporates a new BVI company limited by shares as a segregated portfolio company that is a mutual fund (BCA ss.135-137; Segregated Portfolio Companies Regulations regs 3-4). The Registrar will." }, "Create_vg_mutual_fund_spc_incorporate": { "type": "object", "properties": { "type": { "const": "vg.mutual_fund_spc.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_mutual_fund_spc_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a mutual fund segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "mutual_fund_spc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "fsc_spc_application", "title": "Application to incorporate a mutual fund SPC", "source": "generated", "required": true }, { "key": "fund_application", "title": "SIBA recognition or registration application, or Incubator and Approved Funds application", "source": "generated", "required": true }, { "key": "proposed_memorandum_and_articles", "title": "Proposed memorandum and articles", "source": "generated", "required": true }, { "key": "offering_documents", "title": "Offering document for each initial portfolio", "source": "uploaded", "required": true }, { "key": "functionary_appointments", "title": "Functionary appointment instruments", "source": "uploaded", "required": true }, { "key": "authorised_representative_engagement", "title": "Authorised representative engagement and consent", "source": "uploaded", "required": true }, { "key": "auditor_consent", "title": "Auditor's consent to act", "source": "uploaded", "required": false }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act (BCA s.6)", "source": "generated", "required": true }, { "key": "director_consents", "title": "Written consent of each proposed director", "source": "generated", "required": true }, { "key": "fsc_approval", "title": "FSC written approval (BCA s.135)", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true }, { "key": "fund_certificate", "title": "Certificate of recognition, registration or incubator or approved fund status", "source": "registry_issued", "required": true }, { "key": "incorporation_filing", "title": "Incorporation filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "officer", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fsc_spc_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "proposed_memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_consents", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "functionary_appointments", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "incorporation_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application to incorporate a company as a mutual fund SPC", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "spc_name_invalid", "type": null, "when": "The name lacks 'Segregated Portfolio Company' or 'SPC' before the ending (s.17), or a portfolio name lacks 'Segregated Portfolio' (s.138)." }, { "code": "restricted_word_without_consent", "type": null, "when": "The name uses 'Fund', 'Portfolio' or another restricted word without FSC consent." }, { "code": "administrator_missing", "type": null, "when": "No administrator is named (reg 3; reg 5)." }, { "code": "offering_document_missing", "type": null, "when": "An initial portfolio has no offering document or investment warning (reg 3)." }, { "code": "authorised_representative_not_certified", "type": null, "when": "The authorised representative is not FSC-certified." }, { "code": "fsc_refused", "type": null, "when": "The FSC refuses approval or recognition." } ] } }, "Params_vg_mutual_fund_spc_register": { "type": "object", "properties": { "current_fund_regime": { "type": "string", "enum": [ "private_fund", "professional_fund", "public_fund", "incubator_fund", "approved_fund" ], "description": "The company's current SIBA or incubator or approved fund status.", "examples": [ "professional_fund" ] }, "name": { "type": "string", "description": "Name including 'Segregated Portfolio Company' or 'SPC' before the ending (BCA s.17); a name change follows if needed.", "examples": [ "Northstar Opportunities SPC Ltd" ] }, "administrator": { "type": "object", "description": "{name, jurisdiction, licence_or_regulator} (reg 3)." }, "initial_portfolios": { "type": "array", "items": {}, "description": "Each item: {name with 'Segregated Portfolio', functionaries, offering_document or investment_warning, assets_to_allocate}." }, "statement_date": { "type": "string", "format": "date", "description": "Date of the statement of assets and liabilities; no more than 6 months before the application (reg 3)." }, "general_assets_description": { "type": "string", "description": "Assets that will remain general assets and how liabilities will be satisfied (reg 3-)." }, "members_notice_date": { "type": "string", "format": "date", "description": "Date notice of the intended registration was given to members (reg 3)." }, "amended_memorandum_and_articles": { "type": "string", "pattern": "^doc_", "description": "Proposed SPC memorandum and articles." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "current_fund_regime", "name", "administrator", "initial_portfolios", "statement_date", "general_assets_description", "members_notice_date", "amended_memorandum_and_articles", "nature_of_business", "countries_of_operation", "directors", "shareholders", "share_classes", "beneficial_owners" ], "description": "Obtains FSC approval and has the Registrar register an existing BVI company limited by shares that is a mutual fund as a segregated portfolio company (BCA s.135; SPC Regulations reg 3,). The application, in the approved form, comes with." }, "Create_vg_mutual_fund_spc_register": { "type": "object", "properties": { "type": { "const": "vg.mutual_fund_spc.register" }, "params": { "$ref": "#/components/schemas/Params_vg_mutual_fund_spc_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an existing BVI mutual fund as a segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "mutual_fund_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "fsc_spc_application", "title": "Application to register an existing mutual fund as an SPC", "source": "generated", "required": true }, { "key": "current_memorandum_and_articles", "title": "Current memorandum and articles", "source": "uploaded", "required": true }, { "key": "amended_memorandum_and_articles", "title": "Proposed amended memorandum and articles", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities and allocation (reg 3)", "source": "generated", "required": true }, { "key": "directors_declaration", "title": "Directors' declaration of resolutions, solvency and notice to members (reg 3)", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the registration", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution amending the memorandum and articles", "source": "generated", "required": false }, { "key": "notice_to_members", "title": "Notice to members of the intended registration", "source": "generated", "required": true }, { "key": "offering_documents", "title": "Offering document per initial portfolio", "source": "uploaded", "required": true }, { "key": "fsc_approval", "title": "FSC written approval", "source": "registry_issued", "required": true }, { "key": "registration_certificate", "title": "Registrar's record of registration as an SPC", "source": "registry_issued", "required": true }, { "key": "registry_filing", "title": "Registry filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "statement_of_assets_and_liabilities", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_members", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fsc_spc_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registry_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application to register an existing mutual fund as a segregated portfolio company", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_limited_by_shares", "type": null, "when": "Only a company limited by shares may become an SPC (s.135)." }, { "code": "statement_too_old", "type": null, "when": "The statement of assets and liabilities is more than 6 months old." }, { "code": "members_not_notified", "type": null, "when": "No notice to members is recorded." }, { "code": "insolvency_risk", "type": null, "when": "A director will not sign the solvency declaration." }, { "code": "fsc_refused", "type": null, "when": "The FSC refuses approval." } ] } }, "Params_vg_mutual_fund_spc_approval_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "mutual_fund_spc" ], "description": "Fixed for this action type.", "examples": [ "mutual_fund_spc" ] }, "route": { "type": "string", "enum": [ "new_incorporation", "register_existing_mutual_fund" ], "description": "The registration of an existing fund costs US$1,500 flat.", "examples": [ "new_incorporation" ] }, "name": { "type": "string", "description": "Proposed SPC name; the name must include the SPC designation required by the Regulations.", "examples": [ "Lagoon Opportunities SPC" ] }, "administrator": { "type": "object", "description": "Fund administrator: name, FSC licence reference, address.", "examples": [ "{\"name\":\"Example Fund Services Ltd\",\"fsc_licence\":\"FSC-ADM-0001\"}" ] }, "initial_portfolios": { "type": "array", "items": {}, "description": "Portfolios in the application.", "examples": [ "[{\"name\":\"Global Equity Portfolio\",\"investment_strategy\":\"Long-only global equities\"}]" ] }, "existing_fund": { "type": "object", "description": "For register_existing_mutual_fund: current entity_ref or foreign registration details, and the fund's FSC reference.", "examples": [ "{\"fsc_reference\":\"MF-0001\"}" ] }, "constitution": { "type": "string", "pattern": "^doc_", "description": "Draft memorandum and articles with SPC provisions.", "examples": [ "doc_2Ma7Kd" ] }, "directors": { "type": "array", "items": {}, "description": "Proposed directors; also verified for the later incorporation.", "examples": [ "[\"per_4Dd09\",\"per_5Ee10\"]" ] }, "name_consent": { "type": "string", "pattern": "^doc_", "description": "Restricted-name consent where applicable.", "examples": [ "doc_7Nc3Ee" ] } }, "required": [ "entity_type", "route", "name", "administrator", "initial_portfolios", "constitution", "directors" ], "description": "Applies to the FSC for approval to incorporate a new mutual fund segregated portfolio company, or to register an existing mutual fund as one, before the SPC is incorporated or registered. Run it first, then." }, "Create_vg_mutual_fund_spc_approval_apply": { "type": "object", "properties": { "type": { "const": "vg.mutual_fund_spc_approval.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_mutual_fund_spc_approval_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for FSC approval of a mutual fund SPC", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "mutual_fund_spc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "fsc_spc_application", "title": "FSC application form for mutual fund SPC approval", "source": "generated", "required": true }, { "key": "constitution", "title": "Draft memorandum and articles", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Promoter ownership chart", "source": "uploaded", "required": false }, { "key": "fsc_approval", "title": "FSC approval letter", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "liquidator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "fsc_spc_application", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Financial Services Commission", "form": "Application in the FSC approved form with incorporation documents", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "administrator_unlicensed", "type": null, "when": "The administrator's FSC licence cannot be confirmed." }, { "code": "portfolios_missing", "type": null, "when": "No initial portfolio supplied." }, { "code": "existing_fund_details_missing", "type": null, "when": "route is register_existing_mutual_fund without existing_fund." }, { "code": "fsc_declined", "type": null, "when": "The FSC declines the application." } ] } }, "Params_vg_npo_register": { "type": "object", "properties": { "organisation_name": { "type": "string", "description": "Name as in the constitutional documents.", "examples": [ "Tortola Youth Sailing Association Ltd" ] }, "physical_address": { "$ref": "#/components/schemas/Address", "description": "Physical address, if any." }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address, if any." }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Contact person with position or title." }, "established_date": { "type": "string", "format": "date", "description": "Date the organisation was established (Form A 2)." }, "existed_before_2013": { "type": "boolean", "description": "Organisations operating before 1 January 2013 pay US$50; later ones US$100.", "examples": [ "false" ] }, "subsidiaries_or_branches": { "type": "array", "items": {}, "description": "Names of subsidiary or branch organisations." }, "purpose": { "type": "string", "description": "Full description of the purpose (Form A 2)." }, "activities": { "type": "string", "description": "Full description of the activities (Form A 2)." }, "npo_category": { "type": "string", "enum": [ "church_or_religious", "youth", "service_club_or_association", "sporting", "performing_arts", "community", "foundation", "national_or_country_association", "other" ], "description": "Schedule 5 category the Board considers when deciding if the body qualifies (s.14).", "examples": [ "youth" ] }, "anticipated_annual_revenue": { "$ref": "#/components/schemas/Money", "description": "Form A 2." }, "foreign_parent": { "type": "object", "description": "{exists: boolean, location}." }, "cross_border_funds": { "type": "boolean", "description": "Whether the organisation intends to receive funds from, or remit funds to, organisations outside the BVI (Form A 2)." }, "financial_year_end": { "type": "string", "format": "date", "description": "Form A 2, as MM-DD.", "examples": [ "12-31" ] }, "total_members": { "type": "integer", "description": "Including the executive body." }, "employees": { "type": "integer", "description": "Number of employees." }, "executive_body": { "type": "array", "items": {}, "description": "Each item: {person: per_ id, position, date_appointed}." }, "constitution_compliant": { "type": "boolean", "description": "Confirms the constitution has every s.12 term." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "organisation_name", "contact_person", "established_date", "existed_before_2013", "purpose", "activities", "npo_category", "anticipated_annual_revenue", "cross_border_funds", "financial_year_end", "total_members", "employees", "executive_body", "constitution_compliant", "name", "nature_of_business", "countries_of_operation", "directors", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers the entity as a non-profit organisation under the Non-Profit Organisations Act 2012 as amended in 2022. An NPO is a body of persons, incorporated or not, established solely or primarily for charitable, religious, cultural." }, "Create_vg_npo_register": { "type": "object", "properties": { "type": { "const": "vg.npo.register" }, "params": { "$ref": "#/components/schemas/Params_vg_npo_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a non-profit organisation with the NPO Registration Board", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_a", "title": "Form A: Application for Registration", "source": "generated", "required": true }, { "key": "constitution", "title": "Constitutional documents", "source": "generated", "required": true }, { "key": "statement_of_purpose", "title": "Statement of purposes, objectives and activities", "source": "generated", "required": true }, { "key": "s12_4_declaration", "title": "Declaration that an amended constitution will follow within 30 days (s.12)", "source": "generated", "required": false }, { "key": "supplemental_form", "title": "Supplemental form for an organisation with a foreign parent (s.12)", "source": "generated", "required": false }, { "key": "certificate_of_registration", "title": "NPO certificate of registration", "source": "registry_issued", "required": true }, { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_a", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "s12_4_declaration", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Non-Profit Organisation Registration Board", "form": "Form A, Non-Profit Organisation Application for Registration", "channel": "paper", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "constitution_missing_required_terms", "type": null, "when": "The constitution lacks a s.12 term and no s.12 declaration is given." }, { "code": "not_an_npo", "type": null, "when": "The purposes are not within the s.2 definition or a Schedule 5 category." }, { "code": "board_refused", "type": null, "when": "The Board refuses; an appeal to the Minister lies within 21 days of notice (s.14)." } ] } }, "Params_vg_private_investment_fund_recognise": { "type": "object", "properties": { "pif_basis": { "type": "string", "enum": [ "max_50_investors", "private_offering_only", "professional_investors_with_minimum" ], "description": "Constitutional restriction relied on (s.63F-).", "examples": [ "max_50_investors" ] }, "minimum_initial_investment": { "$ref": "#/components/schemas/Money", "description": "Required for professional_investors_with_minimum; sum prescribed in the Private Investment Funds Regulations." }, "commenced_business_date": { "type": "string", "format": "date", "description": "If relying on s.63E: application due within 14 days; at most 21 days of business before applying." }, "applicant_capacity": { "type": "string", "enum": [ "fund_company", "partner_of_partnership", "trustee_of_unit_trust", "manager" ], "description": "s.63F.", "examples": [ "partner_of_partnership" ] }, "functionaries_and_appointed_persons": { "type": "array", "items": {}, "description": "Manager, administrator, custodian, valuer, auditor and any person the Private Investment Funds Regulations require; requirements not retrieved." }, "authorised_representative": { "type": "object", "description": "{name, fsc_certificate_number, bvi_address}." }, "constitutional_documents": { "type": "string", "pattern": "^doc_", "description": "With the s.63F restriction." }, "offering_document": { "type": "string", "pattern": "^doc_", "description": "Offering or term document." } }, "required": [ "pif_basis", "applicant_capacity", "functionaries_and_appointed_persons", "authorised_representative", "constitutional_documents" ], "description": "Applies to the FSC to recognise a closed-ended or similar private investment fund under SIBA Part IIIA. The fund's constitutional documents must limit it to 50 investors, to private offers, or to professional investors with the prescribed." }, "Create_vg_private_investment_fund_recognise": { "type": "object", "properties": { "type": { "const": "vg.private_investment_fund.recognise" }, "params": { "$ref": "#/components/schemas/Params_vg_private_investment_fund_recognise" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Recognise a BVI private investment fund", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "recognition_application", "title": "Application for recognition as a private investment fund", "source": "generated", "required": true }, { "key": "constitutional_documents", "title": "Constitutional documents with the investor restriction", "source": "uploaded", "required": true }, { "key": "offering_document", "title": "Offering or term document", "source": "uploaded", "required": false }, { "key": "valuation_and_custody_policies", "title": "Valuation, custody and safekeeping policies", "source": "uploaded", "required": false }, { "key": "authorised_representative_appointment", "title": "Authorised representative appointment", "source": "uploaded", "required": true }, { "key": "governing_body_resolution", "title": "Directors' or general partner's resolution", "source": "generated", "required": true }, { "key": "certificate_of_recognition", "title": "Certificate of recognition as a private investment fund", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "officer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "recognition_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "governing_body_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application for recognition of a private investment fund", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "investor_restriction_missing", "type": null, "when": "No s.63F restriction in the constitutional documents." }, { "code": "authorised_representative_missing", "type": null, "when": "No certified authorised representative." }, { "code": "pif_window_exceeded", "type": null, "when": "Business started more than 14 days ago without an application, or more than 21 days ago." }, { "code": "fsc_refused", "type": null, "when": "The FSC refuses recognition." } ] } }, "Params_vg_private_trust_company_incorporate": { "type": "object", "properties": { "underlying_company_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_guarantee_no_shares" ], "description": "A PTC must be a limited company, so unlimited types are out." }, "name": { "type": "string", "description": "Must carry immediately before the ending; at most 100 permitted characters; not confusingly similar to a BVI company or reserved name (s.18)." }, "name_reservation": { "type": "string", "description": "act_ id of a completed vg.company_name.reserve for this name, still within 90 days." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.18; US$200), certified translation if the name has another-language meaning." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical BVI address (s.90); omit to use the agent's office, which the memorandum then states." }, "authorised_shares_max": { "type": "integer", "description": "Maximum shares for share-issuing types, unless authorised_shares_unlimited." }, "authorised_shares_unlimited": { "type": "boolean", "description": "Unlimited shares; counts as over 50,000 for fees." }, "share_classes": { "type": "array", "items": {}, "description": "Item: class_name, par_value, votes_per_share, distribution_rights, redeemable (s.9)." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "Required for the two guarantee types (s.9)." }, "ptc_trust_business_basis": { "type": "string", "enum": [ "unremunerated_trust_business", "related_trust_business" ], "description": "Licensing exemption relied on: unremunerated trust business, or related trust business for qualifying trusts." }, "trusts_served": { "type": "array", "items": {}, "description": "Item: trust_name, settlor, qualifying_trust." }, "articles_option": { "type": "string", "enum": [ "entiva_standard", "custom_constitution" ], "description": "entiva_standard, or custom_constitution." }, "directors": { "type": "array", "items": {}, "description": "Proposed first directors, at least one (s.109)." }, "initial_members": { "type": "array", "items": {}, "description": "First members; one is needed once the first directors are appointed (s.79)." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of shares or votes, or control." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." } }, "required": [ "underlying_company_type", "name", "ptc_trust_business_basis", "articles_option", "directors", "initial_members", "beneficial_owners_and_controllers", "business_profile" ], "description": "Forms a BVI limited company whose memorandum states it is a private trust company, so it can act as trustee of family trusts without a trust licence if its trust business is unremunerated or related. The registered agent must hold an FSC." }, "Create_vg_private_trust_company_incorporate": { "type": "object", "properties": { "type": { "const": "vg.private_trust_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_private_trust_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a BVI private trust company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "director_consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "beneficial_owner_declaration", "title": "Beneficial owner particulars and declarations", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "KYB pack and ownership chart", "source": "uploaded", "required": false }, { "key": "trust_deed", "title": "Trust deed or settlement for each trust served", "source": "uploaded", "required": false }, { "key": "ptc_business_declaration", "title": "Directors' declaration on PTC trust business", "source": "generated", "required": true }, { "key": "virrgin_incorporation_application", "title": "VIRRGIN incorporation application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "settlor", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "beneficial_owner_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "ptc_business_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "virrgin_incorporation_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Memorandum stating PTC status with a", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "director_disqualified", "type": null, "when": "requirement_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." }, { "code": "partner_not_licensed_for_ptc", "type": null, "when": "requirement_error." }, { "code": "ptc_not_qualifying", "type": null, "when": "requirement_error." } ] } }, "Params_vg_register_of_directors_file": { "type": "object", "properties": { "filing_type": { "type": "string", "enum": [ "initial", "change" ], "description": "initial: the first copy (s.118B). change: a copy showing a change, including catch-up filings (s.118B); director actions open these themselves." }, "trigger_event": { "type": "string", "enum": [ "first_directors_appointed", "continuation", "director_appointed", "director_ceased", "particulars_changed", "catch_up" ], "description": "What started the clock." }, "event_date": { "type": "string", "format": "date", "description": "Date of the event; the deadline is 15 days after it for an initial filing, 30 days for a change." }, "licensed_director_disclosure": { "type": "array", "items": {}, "description": "Required when an FSC licensee provides a director (s.118, s.118A)." } }, "required": [ "filing_type", "trigger_event", "event_date" ], "description": "Files a copy of the register of directors, privately, on VIRRGIN, including any FSC-licensed director services provider. Initial filing: within 15 days of the first directors' appointment or of a continuation." }, "Create_vg_register_of_directors_file": { "type": "object", "properties": { "type": { "const": "vg.register_of_directors.file" }, "params": { "$ref": "#/components/schemas/Params_vg_register_of_directors_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the register of directors with the BVI Registrar", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "register_of_directors_particulars", "title": "Register of directors particulars", "source": "generated", "required": true }, { "key": "director_accuracy_confirmation", "title": "Director's confirmation that the register is accurate", "source": "generated", "required": true }, { "key": "virrgin_register_of_directors_filing", "title": "VIRRGIN register of directors filing", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "register_of_directors_particulars", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "director_accuracy_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "virrgin_register_of_directors_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Copy of the register of directors with the s.118A particulars and any licensed-director di", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_particulars_missing", "type": null, "when": "requirement_error." }, { "code": "licensed_director_disclosure_missing", "type": null, "when": "requirement_error." }, { "code": "filing_state_conflict", "type": null, "when": "invalid_request_error. filing_type change with no change since the last filing, initial with an initial copy already on file, or a restored company that need not file (s.118B)." }, { "code": "late_filing_penalty_accruing", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." } ] } }, "Params_vg_register_of_members_file": { "type": "object", "properties": { "filing_type": { "type": "string", "enum": [ "initial", "change" ], "description": "initial: the first copy (s.43A). change: a copy showing changes, including catch-up filings (s.43A); share issues and transfers open these themselves." }, "trigger_event": { "type": "string", "enum": [ "incorporation", "continuation", "shares_issued", "shares_transferred", "member_added_or_ceased", "nominee_change", "catch_up" ], "description": "What started the clock." }, "event_date": { "type": "string", "format": "date", "description": "Date of the event; the deadline is 30 days after it." }, "make_register_public": { "type": "boolean", "description": "Default false: shown only to the company, its agent, competent authorities and law enforcement (s.43A)." }, "nominator_details": { "type": "array", "items": {}, "description": "Required for a nominee shareholder (s.41)." } }, "required": [ "filing_type", "trigger_event", "event_date" ], "description": "Files a copy of the register of members, privately, on VIRRGIN, with nominee shareholder and nominator details (s.41). Initial filing: within 30 days of incorporation or continuation." }, "Create_vg_register_of_members_file": { "type": "object", "properties": { "type": { "const": "vg.register_of_members.file" }, "params": { "$ref": "#/components/schemas/Params_vg_register_of_members_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the register of members with the BVI Registrar", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "register_of_members_particulars", "title": "Register of members particulars", "source": "generated", "required": true }, { "key": "nominator_particulars", "title": "Nominee shareholder and nominator particulars", "source": "generated", "required": false }, { "key": "initial_membership_instrument", "title": "Directors' resolution issuing the first shares, or instrument admitting the first members", "source": "generated", "required": false }, { "key": "member_accuracy_confirmation", "title": "Director's confirmation that the register is accurate", "source": "generated", "required": true }, { "key": "virrgin_register_of_members_filing", "title": "VIRRGIN register of members filing", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "initial_membership_instrument", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_of_members_particulars", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "member_accuracy_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "virrgin_register_of_members_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Copy of the register of members with the s.41 particulars and nominator details", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "filing_exempt", "type": null, "when": "invalid_request_error." }, { "code": "no_members_recorded", "type": null, "when": "requirement_error." }, { "code": "nominator_details_missing", "type": null, "when": "requirement_error." }, { "code": "filing_state_conflict", "type": null, "when": "invalid_request_error. filing_type change with no change since the last filing, or initial with an initial copy already on file." }, { "code": "late_filing_penalty_accruing", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." } ] } }, "Params_vg_register_of_partners_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP entity type key.", "examples": [ "lp" ] }, "trigger": { "type": "string", "enum": [ "registration", "continuation_in" ], "description": "Registration (s.53A) or continuation under s.68 (s.53A).", "examples": [ "registration" ] }, "trigger_date": { "type": "string", "format": "date", "description": "Date of the certificate of registration or continuation; the deadline is 30 days later.", "examples": [ "2026-10-15" ] }, "fund_status": { "type": "string", "enum": [ "not_a_fund", "private_fund", "professional_fund", "public_fund", "private_investment_fund", "incubator_fund", "approved_fund" ], "description": "If the LP is a recognised or registered SIBA fund, or an incubator or approved fund, only the register of general partners is filed (s.53A).", "examples": [ "not_a_fund" ] }, "general_partners": { "type": "array", "items": {}, "description": "At least one." }, "limited_partners": { "type": "array", "items": {}, "description": "Required unless fund_status limits the filing to general partners." } }, "required": [ "entity_type", "trigger", "trigger_date", "fund_status", "general_partners" ], "description": "Files copies of the limited partnership's register of general partners and register of limited partners with the Registrar within 30 days of registration or continuation (Limited Partnership Act 2017 s.53A). The registers hold the s.53." }, "Create_vg_register_of_partners_file": { "type": "object", "properties": { "type": { "const": "vg.register_of_partners.file" }, "params": { "$ref": "#/components/schemas/Params_vg_register_of_partners_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File initial registers of general and limited partners", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "register_of_general_partners", "title": "Register of general partners (s.53)", "source": "generated", "required": true }, { "key": "register_of_limited_partners", "title": "Register of limited partners (s.53)", "source": "generated", "required": false }, { "key": "fund_status_evidence", "title": "Fund recognition or approval certificate", "source": "uploaded", "required": false }, { "key": "filing_confirmation", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true }, { "key": "register_confirmation", "title": "Register confirmation", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "register_confirmation", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "filing_confirmation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of general partners and register of limited partners", "channel": "online", "government_fee": { "amount": 125, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "missing_partner_particulars", "type": null, "when": "A partner record lacks a s.53 particular." }, { "code": "no_limited_partner", "type": null, "when": "The LP has no limited partner; s.6 requires at least one general and one limited partner." }, { "code": "fund_status_unproven", "type": null, "when": "fund_status claims GP-only filing without recognition or approval evidence." }, { "code": "filing_deadline_passed", "type": null, "when": "Not blocking; late penalties are added to the quote." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects or queries the filing." } ] } }, "Params_vg_restricted_name_consent_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type that will use the name.", "examples": [ "mutual_fund_spc" ] }, "name": { "type": "string", "description": "Full proposed name with its ending.", "examples": [ "Meridian Global Fund SPC Ltd" ] }, "restricted_terms": { "type": "array", "items": {}, "description": "Restricted words, phrases or abbreviations used, as listed in the BVI Business Companies Notice or the Limited Partnership Notice 2021.", "examples": [ "[\"Fund\"]" ] }, "justification": { "type": "string", "description": "Why the term is accurate and not misleading, for example that the company will be a recognised fund or a licensed insurer." }, "regulatory_status": { "type": "string", "enum": [ "will_apply_for_bvi_licence_or_recognition", "licensed_in_bvi", "group_licensed_abroad", "not_regulated_descriptive_use" ], "description": "Regulatory position supporting the use of the term.", "examples": [ "will_apply_for_bvi_licence_or_recognition" ] }, "licence_details": { "type": "object", "description": "{regulator, licence_type, licence_number, holder} where a licence supports the term." }, "formation_action": { "type": "string", "description": "act_ id of the incorporation or registration draft that will use the name; the consent becomes its requirement." }, "name_reservation_action": { "type": "string", "description": "act_ id of a 90-day name reservation." } }, "required": [ "entity_type", "name", "restricted_terms", "justification", "regulatory_status" ], "description": "Obtains the Financial Services Commission's prior written consent to a name containing a restricted word, phrase or abbreviation. The Registrar will not register a company or a limited partnership under such a name without it (BCA s.18." }, "Create_vg_restricted_name_consent_apply": { "type": "object", "properties": { "type": { "const": "vg.restricted_name_consent.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_restricted_name_consent_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain FSC consent to use a restricted word in a name", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "consent_application", "title": "Application for consent to use a restricted word, phrase or abbreviation", "source": "generated", "required": true }, { "key": "justification_letter", "title": "Letter explaining the use of the term", "source": "generated", "required": true }, { "key": "licence_evidence", "title": "Licence, recognition or regulatory evidence", "source": "uploaded", "required": false }, { "key": "group_authorisation_letter", "title": "Authorisation from a group company that owns the name or licence", "source": "uploaded", "required": false }, { "key": "fsc_consent", "title": "FSC written consent", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "justification_letter", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Application for consent to use a restricted word, phrase or abbreviation", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "term_not_restricted", "type": null, "when": "None of the terms is on the restricted lists; the action is cancelled with no fee." }, { "code": "licence_evidence_required", "type": null, "when": "The FSC asks for proof that the regulated activity will be licensed or recognised." }, { "code": "name_otherwise_unavailable", "type": null, "when": "The name is identical or too similar to an existing or reserved name, or is offensive (BCA s.18,,; LPA s.13,)." }, { "code": "consent_refused", "type": null, "when": "The FSC refuses consent." } ] } }, "Params_vg_restricted_name_consent_request": { "type": "object", "properties": { "name": { "type": "string", "description": "Full proposed name including the restricted word.", "examples": [ "Anchor Capital Management Limited" ] }, "restricted_word": { "type": "string", "description": "The restricted word or phrase for which consent is sought.", "examples": [ "Capital Management" ] }, "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type the name is for.", "examples": [ "bc_ltd_shares" ] }, "intended_use": { "type": "string", "enum": [ "incorporation", "continuation", "name_change" ], "description": "When the name will be used.", "examples": [ "incorporation" ] }, "entity": { "type": "string", "pattern": "^ent_", "description": "Required for name_change: the existing entity.", "examples": [ "ent_4Wk2Lp" ] }, "business_description": { "type": "string", "description": "Why the word is appropriate and what the company will do.", "examples": [ "Fund management advisory services for Asian family offices" ] }, "supporting_authority": { "type": "string", "pattern": "^doc_", "description": "Licence, regulator letter or other evidence supporting use of the word where the Regulations require it.", "examples": [ "doc_1Sa5Bb" ] } }, "required": [ "name", "restricted_word", "entity_type", "intended_use", "business_description" ], "description": "Applies, through the registered agent, for the Registrar's consent to use a restricted word or phrase in a proposed BVI company name before incorporation, continuation or a change of name. Runs before the entity exists, so it is created on." }, "Create_vg_restricted_name_consent_request": { "type": "object", "properties": { "type": { "const": "vg.restricted_name_consent.request" }, "params": { "$ref": "#/components/schemas/Params_vg_restricted_name_consent_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request consent to use a restricted word in a BVI company name", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "restricted_name_application", "title": "Application for consent to use a restricted word or phrase", "source": "generated", "required": true }, { "key": "supporting_authority", "title": "Supporting licence or regulator letter", "source": "uploaded", "required": false }, { "key": "name_consent", "title": "Registrar's consent", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "external", "body": "regulator", "threshold": "any_one", "method": "decision" } ], "signatures": [ { "document_key": "restricted_name_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs / FSC via VIRRGIN", "form": "Application for consent to use a restricted word or phrase", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_unavailable", "type": null, "when": "The proposed name is not available or conflicts with an existing name." }, { "code": "supporting_authority_required", "type": null, "when": "The Regulations require a licence or regulator consent for the word and none was supplied." }, { "code": "consent_refused", "type": null, "when": "The Registrar refuses consent." }, { "code": "entity_required", "type": null, "when": "intended_use is name_change and entity is missing." } ] } }, "Params_vg_restricted_purposes_company_incorporate": { "type": "object", "properties": { "name": { "type": "string", "description": "Must end Limited or Ltd (s.17); at most 100 permitted characters; not confusingly similar to a BVI company or reserved name (s.18)." }, "name_reservation": { "type": "string", "description": "act_ id of a completed vg.company_name.reserve for this name, still within 90 days." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.18; US$200), certified translation if the name has another-language meaning." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical BVI address (s.90); omit to use the agent's office, which the memorandum then states." }, "restricted_purposes": { "type": "array", "items": {}, "description": "Purposes as strings, at least one; stated in the memorandum with the restricted-purposes statement (s.10-)." }, "authorised_shares_max": { "type": "integer", "description": "Maximum shares (s.9)." }, "share_classes": { "type": "array", "items": {}, "description": "Item: class_name, par_value, votes_per_share, distribution_rights, redeemable (s.9)." }, "articles_option": { "type": "string", "enum": [ "entiva_standard", "custom_constitution" ], "description": "entiva_standard, or custom_constitution." }, "directors": { "type": "array", "items": {}, "description": "Proposed first directors, at least one (s.109)." }, "initial_members": { "type": "array", "items": {}, "description": "First members; one is needed once the first directors are appointed (s.79)." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of shares or votes, or control." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "name", "restricted_purposes", "authorised_shares_max", "share_classes", "articles_option", "directors", "initial_members", "beneficial_owners_and_controllers", "business_profile", "nature_of_business", "countries_of_operation", "shareholders", "beneficial_owners" ], "description": "Forms a BVI company limited by shares whose memorandum states it is a restricted purposes company and lists its purposes, typically a securitisation or other special purpose vehicle. The status can only be taken on incorporation or." }, "Create_vg_restricted_purposes_company_incorporate": { "type": "object", "properties": { "type": { "const": "vg.restricted_purposes_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_restricted_purposes_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a BVI restricted purposes company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "restricted_purposes_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "director_consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "beneficial_owner_declaration", "title": "Beneficial owner particulars and declarations", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "KYB pack and ownership chart", "source": "uploaded", "required": false }, { "key": "virrgin_incorporation_application", "title": "VIRRGIN incorporation application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "beneficial_owner_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "virrgin_incorporation_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Memorandum stating restricted-purposes status and purposes", "channel": "online", "government_fee": { "amount": 8000, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "director_disqualified", "type": null, "when": "requirement_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." }, { "code": "restricted_purposes_invalid", "type": null, "when": "invalid_request_error. restricted_purposes is empty (s.10) or the name does not end Limited or Ltd (s.17)." } ] } }, "Params_vg_segregated_portfolio_company_incorporate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "segregated_portfolio_company" ], "description": "Always segregated_portfolio_company." }, "spc_regime": { "type": "string", "enum": [ "non_regulated" ], "description": "non_regulated is the only regime covered (SPC Regs 2018)." }, "unregulated_declaration": { "type": "boolean", "description": "Must be true: the company is not and will not be licensed as an investment business company, insurance manager or intermediary, or under the Banks and Trust." }, "name": { "type": "string", "description": "Must include Segregated Portfolio Company or SPC immediately before the ending (s.17); at most 100 permitted characters; not confusingly similar to a BVI." }, "name_reservation": { "type": "string", "description": "act_ id of a completed vg.company_name.reserve for this name, still within 90 days." }, "name_support_documents": { "type": "array", "items": {}, "description": "doc_ ids: FSC consent for a restricted word (s.18; US$200), certified translation if the name has another-language meaning." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Physical BVI address (s.90); omit to use the agent's office, which the memorandum then states." }, "authorised_shares_max": { "type": "integer", "description": "Maximum shares; an SPC is a company limited by shares (s.135)." }, "authorised_shares_unlimited": { "type": "boolean", "description": "Unlimited shares; counts as over 50,000 for fees." }, "share_classes": { "type": "array", "items": {}, "description": "Item: class_name, par_value, votes_per_share, distribution_rights, redeemable (s.9)." }, "initial_portfolios": { "type": "array", "items": {}, "description": "At least one." }, "articles_option": { "type": "string", "enum": [ "entiva_standard", "custom_constitution" ], "description": "entiva_standard, or custom_constitution." }, "directors": { "type": "array", "items": {}, "description": "Proposed first directors, at least one (s.109)." }, "initial_members": { "type": "array", "items": {}, "description": "First members; one is needed once the first directors are appointed (s.79)." }, "beneficial_owners_and_controllers": { "type": "array", "items": {}, "description": "Natural persons with 10%+ of shares or votes, or control." }, "business_profile": { "type": "object", "description": "AML profile (Code s.19,): purpose, expected_countries, expected_annual_turnover, source_of_funds." }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "entity_type", "spc_regime", "unregulated_declaration", "name", "share_classes", "initial_portfolios", "articles_option", "directors", "initial_members", "beneficial_owners_and_controllers", "business_profile", "nature_of_business", "countries_of_operation", "shareholders", "beneficial_owners" ], "description": "Forms a BVI company limited by shares that runs segregated portfolios with ring-fenced assets and liabilities. The FSC must approve in writing first; the Registrar will not incorporate without it (s.135)." }, "Create_vg_segregated_portfolio_company_incorporate": { "type": "object", "properties": { "type": { "const": "vg.segregated_portfolio_company.incorporate" }, "params": { "$ref": "#/components/schemas/Params_vg_segregated_portfolio_company_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a BVI non-regulated segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "segregated_portfolio_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "memorandum_and_articles", "title": "Memorandum and articles of association", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "director_consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "beneficial_owner_declaration", "title": "Beneficial owner particulars and declarations", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "KYB pack and ownership chart", "source": "uploaded", "required": false }, { "key": "spc_portfolio_plan", "title": "Initial portfolio plan", "source": "generated", "required": true }, { "key": "fsc_spc_approval_application", "title": "FSC application for approval of the SPC", "source": "generated", "required": true }, { "key": "fsc_spc_approval", "title": "FSC written approval", "source": "registry_issued", "required": true }, { "key": "virrgin_incorporation_application", "title": "VIRRGIN incorporation application", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "memorandum_and_articles", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "director_consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "beneficial_owner_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "fsc_spc_approval_application", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "virrgin_incorporation_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI FSC", "form": "VIRRGIN transaction 'Application to Incorporate a Non-Regulated Segregated Portfolio Compa", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "name_unavailable", "type": null, "when": "registry_error." }, { "code": "director_disqualified", "type": null, "when": "requirement_error." }, { "code": "client_declined_by_partner", "type": null, "when": "requirement_error." }, { "code": "registry_rejected", "type": null, "when": "registry_error." }, { "code": "spc_not_eligible", "type": null, "when": "requirement_error." }, { "code": "portfolio_invalid", "type": null, "when": "invalid_request_error." }, { "code": "fsc_approval_refused", "type": null, "when": "registry_error." } ] } }, "Params_vg_trade_licence_apply": { "type": "object", "properties": { "application_type": { "type": "string", "enum": [ "first", "additional" ], "description": "First licence or additional licence.", "examples": [ "first" ] }, "number_of_licences": { "type": "integer", "description": "Number of licences requested.", "examples": [ "1" ] }, "business_name": { "type": "string", "description": "Proposed business name.", "examples": [ "Harbourview Consulting" ] }, "physical_location": { "$ref": "#/components/schemas/Address", "description": "Physical location of the business in the BVI." }, "activity_description": { "type": "string", "description": "Description of the business activity." }, "applicant": { "type": "string", "pattern": "^per_", "description": "Person named as applicant.", "examples": [ "per_5MayaR" ] }, "applicant_role": { "type": "string", "enum": [ "owner", "manager", "director", "agent" ], "description": "Applicant's role on the form. 'agent' requires agent_name.", "examples": [ "owner" ] }, "agent_name": { "type": "string", "description": "Full name of the agent where applicant_role is agent." }, "preferred_contact_method": { "type": "string", "enum": [ "home", "work", "mobile", "email" ], "description": "Form field.", "examples": [ "email" ] }, "ownership_status": { "type": "string", "enum": [ "bvi_owned", "non_belonger" ], "description": "bvi_owned requires at least 60% of shareholders and 60% of directors to be BVIslanders; otherwise the non-Belonger document set applies.", "examples": [ "non_belonger" ] }, "source_of_financing": { "type": "string", "enum": [ "personal", "bank", "other" ], "description": "Form field for companies.", "examples": [ "personal" ] }, "expected_employees": { "type": "integer", "description": "Expected number of employees.", "examples": [ "3" ] }, "requires_inspection": { "type": "boolean", "description": "True for businesses such as restaurants and food handlers that need an inspection before issue." }, "changes_building_use": { "type": "boolean", "description": "True if the business significantly changes the building's intended use; planning permission under the Physical Planning Act 2005 is then needed." } }, "required": [ "application_type", "number_of_licences", "business_name", "physical_location", "activity_description", "applicant", "applicant_role", "preferred_contact_method", "ownership_status", "source_of_financing", "expected_employees" ], "description": "Applies to the Department of Trade, Investment Promotion and Consumer Affairs for a general trade licence, which any individual or company needs before operating a business in the BVI. Covers a first licence and an additional licence for." }, "Create_vg_trade_licence_apply": { "type": "object", "properties": { "type": { "const": "vg.trade_licence.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_trade_licence_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for a BVI trade licence", "x-entiva": { "jurisdiction": "vg", "stage": "formation", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "foreign_company", "general_partnership", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "application_form", "title": "Trade Licence Application Form", "source": "generated", "required": true }, { "key": "cover_letter", "title": "Formal cover letter describing the business", "source": "generated", "required": true }, { "key": "passport_photo", "title": "Passport-size photo", "source": "uploaded", "required": true }, { "key": "professional_qualifications", "title": "Professional qualifications", "source": "uploaded", "required": true }, { "key": "belonger_status_proof", "title": "Proof of BVIslander status", "source": "uploaded", "required": false }, { "key": "character_references", "title": "Two personal character references", "source": "uploaded", "required": false }, { "key": "business_reference", "title": "One business reference", "source": "uploaded", "required": false }, { "key": "financial_statement", "title": "Financial statement showing ability to operate the business", "source": "uploaded", "required": false }, { "key": "police_certificate", "title": "Police record or certificate of good character", "source": "uploaded", "required": false }, { "key": "passport", "title": "Copy of passport picture page", "source": "uploaded", "required": false }, { "key": "incorporation_documents", "title": "Certificate of incorporation, memorandum and articles, registers of members and directors, share.", "source": "generated", "required": false }, { "key": "inspection_approval", "title": "Inspection approval", "source": "registry_issued", "required": false }, { "key": "planning_permission", "title": "Planning permission", "source": "registry_issued", "required": false }, { "key": "trade_licence", "title": "Trade licence", "source": "registry_issued", "required": true }, { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "shareholder", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "cover_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "character_references", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Department of Trade, Investment Promotion and Consumer Affairs, Government of the Virgin I", "form": "Trade Licence Application Form", "channel": "paper", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "belonger_threshold_not_met", "type": null, "when": "ownership_status is bvi_owned but fewer than 60% of shareholders or directors are BVIslanders." }, { "code": "missing_non_belonger_documents", "type": null, "when": "A non-Belonger applicant has not uploaded the references, financial statement, police certificate or passport copy." }, { "code": "inspection_required", "type": null, "when": "The activity needs an inspection that has not been passed." }, { "code": "planning_permission_required", "type": null, "when": "changes_building_use is true and no permission is attached." }, { "code": "department_rejected", "type": null, "when": "The Department refuses the application or asks for a new business name." } ] } }, "Params_vg_annual_fee_pay": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Company class, which sets the fee schedule line.", "examples": [ "bc_ltd_shares" ] }, "fee_year": { "type": "integer", "description": "Calendar year in which the fee falls due.", "examples": [ "2026" ] }, "authorised_shares_band": { "type": "string", "enum": [ "up_to_50000", "more_than_50000", "unlimited", "no_shares" ], "description": "Read from the entity record as at the due date, the date on which the band is fixed.", "examples": [ "up_to_50000" ] }, "private_trust_company": { "type": "boolean", "description": "True if the memorandum states that the company is a private trust company.", "examples": [ "false" ] }, "pay_on": { "type": "string", "format": "date", "description": "Date on which the partner should pay.", "examples": [ "2026-11-16" ] }, "include_arrears": { "type": "boolean", "description": "Also pay any earlier annual fees and penalties still owed.", "examples": [ "true" ] }, "include_spc_fsc_fee": { "type": "boolean", "description": "Segregated portfolio companies only.", "examples": [ "true" ] } }, "required": [ "entity_type", "fee_year" ], "description": "Every BVI business company pays an annual fee to the Registrar of Corporate Affairs, and only its registered agent may pay it. The amount depends on the company's class and on how many shares it is authorised to issue on the due date." }, "Create_vg_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual Registry fee for a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_fee_statement", "title": "Entiva statement of the fee class, share band, due date, any penalty and any arrears", "source": "generated", "required": true }, { "key": "registry_payment_confirmation", "title": "VIRRGIN payment confirmation for the annual fee", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "registry_payment_confirmation", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Annual fee payment", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI company." }, { "code": "fee_not_yet_due", "type": null, "when": "fee_year is earlier than the first year a fee is due, which is the year after incorporation or continuation." }, { "code": "already_paid", "type": null, "when": "The fee for fee_year is already recorded as paid." }, { "code": "authorised_shares_mismatch", "type": null, "when": "authorised_shares_band differs from the entity record." }, { "code": "not_registered_agent", "type": null, "when": "Entiva is not the registered agent on the Register, so it cannot pay (s.236)." }, { "code": "entity_struck_off", "type": null, "when": "The company has been struck off and dissolved." }, { "code": "no_fee_after_insolvency_liquidator", "type": null, "when": "An Insolvency Act liquidator has been appointed, and no fees accrue after that appointment." }, { "code": "spending_limit_exceeded", "type": null, "when": "The quote is above the agent mandate's spending limit, so a human must approve it." }, { "code": "payment_failed", "type": null, "when": "Entiva could not collect the government fee from the account's payment method." } ] } }, "Params_vg_annual_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Company type key", "examples": [ "bc_ltd_shares" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "First day of the financial year the return covers.", "examples": [ "2025-07-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the return covers. 'Year' means the calendar year or the company's own financial year (s.98A).", "examples": [ "2026-06-30" ] }, "reporting_currency": { "type": "string", "description": "ISO 4217 code.", "examples": [ "USD" ] }, "basis": { "type": "string", "enum": [ "prescribed_form", "consolidated_group_accounts", "combined_group_filing" ], "description": "prescribed_form: the Order's Schedule form. consolidated_group_accounts: the group's consolidated accounts, if they show this company's accounts (s.98A)..", "examples": [ "prescribed_form" ] }, "group_parent": { "type": "object", "description": "Required when basis is consolidated_group_accounts or combined_group_filing.", "examples": [ "{\"legal_name\": \"Example Group Holdings Ltd\", \"jurisdiction\": \"SG\", \"registration_number\": \"201912345K\"}" ] }, "exemption": { "type": "string", "enum": [ "none", "listed_company", "regulated_files_with_fsc", "tax_return_with_financial_statements", "in_liquidation" ], "description": "Claim an exemption under s.98A.", "examples": [ "none" ] }, "nil_return": { "type": "boolean", "description": "Set to true if the company had no assets, liabilities, income or expenses in the year.", "examples": [ "false" ] }, "balance_sheet": { "type": "object", "description": "Required unless exemption or nil_return is set.", "examples": [ "{\"cash_and_cash_equivalents\": 4210000, \"investments_and_other_financial_assets\": 250000000, \"other_assets\": 150000, \"total_assets\": 254360000, \"accounts_payable\": 820000, \"other_liabilities\": 30000000, \"total_liabilities\": 30820000, \"shareholders_equity\": 223540000}" ] }, "income_statement": { "type": "object", "description": "Required unless exemption or nil_return is set.", "examples": [ "{\"revenue\": 12500000, \"cost_of_sales\": 0, \"gross_profit\": 12500000, \"operating_expenses\": 1840000, \"other_expenses\": 0, \"income_tax_expense\": 0, \"total_expenses\": 1840000, \"net_income\": 10660000}" ] }, "fsc_extension_reference": { "type": "string", "description": "Reference to an FSC Notice or decision that extends the deadline (s.98A-).", "examples": [ "FSC Notice 2026/14" ] }, "records_location": { "type": "object", "description": "Give {address, custodian_name} if the records and underlying documentation are kept away from the agent's office: where they are and who maintains them (s.98).", "examples": [ "{\"address\": {\"line1\": \"8 Marina View\", \"city\": \"Singapore\", \"country\": \"SG\"}, \"custodian_name\": \"Example Group Finance Pte Ltd\"}" ] } }, "required": [ "entity_type", "financial_year_start", "financial_year_end", "reporting_currency" ], "description": "Every BVI company must lodge an annual financial return with its registered agent within 9 months after the end of each financial year. The return is a balance sheet and income statement in the form set by the BVI Business Companies Order." }, "Create_vg_annual_return_file": { "type": "object", "properties": { "type": { "const": "vg.annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_vg_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Lodge a company's annual financial return with the registered agent", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_financial_return", "title": "Annual Financial Return in the form in the Schedule to the BVI Business Companies Order 2023, as.", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Management accounts or financial statements the figures come from.", "source": "uploaded", "required": false }, { "key": "consolidated_accounts", "title": "Group consolidated accounts showing this company's accounts, when basis is.", "source": "uploaded", "required": false }, { "key": "exemption_evidence", "title": "Evidence for an exemption: proof of listing, of FSC financial statement filing, of the Inland.", "source": "uploaded", "required": false }, { "key": "directors_approval", "title": "Directors' resolution approving the return.", "source": "generated", "required": false }, { "key": "lodgement_receipt", "title": "The partner registered agent's dated acknowledgement of receipt, which evidences lodgement within.", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_financial_return", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_approval", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Entiva, as the company's registered agent", "form": "Annual Financial Return", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI company." }, { "code": "financial_year_not_ended", "type": null, "when": "financial_year_end is in the future." }, { "code": "balance_sheet_does_not_balance", "type": null, "when": "total_assets does not equal total_liabilities plus shareholders_equity." }, { "code": "totals_inconsistent", "type": null, "when": "The lines do not add up to their totals: total_assets, total_liabilities, gross_profit, total_expenses, or net_income." }, { "code": "group_parent_required", "type": null, "when": "basis is consolidated_group_accounts or combined_group_filing, but group_parent or consolidated_accounts is missing." }, { "code": "exemption_evidence_required", "type": null, "when": "exemption is set but no exemption_evidence document has been uploaded." }, { "code": "liquidation_exemption_not_available", "type": null, "when": "The company went into liquidation after the return became due." }, { "code": "already_lodged", "type": null, "when": "A return for this financial year is already on file with the agent." }, { "code": "default_already_notified", "type": null, "when": "Returned as a warning when more than 30 days have passed since the deadline, so the agent has notified, or must now notify, the Registrar (s.98A)." } ] } }, "Params_vg_annual_return_extension_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Company type key", "examples": [ "bc_ltd_shares" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the financial year whose return needs more time.", "examples": [ "2026-03-31" ] }, "extension_months": { "type": "integer", "description": "Months of extra time requested, from 1 to 9.", "examples": [ "3" ] }, "previous_extension_months": { "type": "integer", "description": "Months already granted for the same year, whether by a company-specific decision or a general FSC Notice.", "examples": [ "0" ] }, "reason": { "type": "string", "description": "Why more time is needed, for example an unfinished audit or the timing of group consolidation.", "examples": [ "Group consolidated accounts are audited in Singapore and will be signed on 20 February 2027." ] }, "expected_lodgement_date": { "type": "string", "format": "date", "description": "Date by which the company expects to lodge the return.", "examples": [ "2027-03-15" ] } }, "required": [ "entity_type", "financial_year_end", "extension_months", "reason" ], "description": "The FSC can extend the 9-month period for lodging a company's annual financial return, for a single company, a class of companies or all companies. It may act on its own motion or on a written application by the company, and it publishes a." }, "Create_vg_annual_return_extension_apply": { "type": "object", "properties": { "type": { "const": "vg.annual_return_extension.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_annual_return_extension_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the FSC for more time to lodge a company's annual financial return", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_application", "title": "Written application by the company to the FSC for an extension of time (s.98A)", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Supporting evidence, for example an auditor's letter or a group reporting timetable", "source": "uploaded", "required": false }, { "key": "fsc_decision", "title": "The FSC's decision or published Notice granting or refusing the extension", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_application", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Written application for an extension of time to file the annual return", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "extension_exceeds_maximum", "type": null, "when": "extension_months plus previous_extension_months is more than 9 (s.98A)." }, { "code": "general_extension_applies", "type": null, "when": "Returned as information when a published FSC Notice already extends the deadline for this company's class." }, { "code": "not_required_exempt", "type": null, "when": "The company is exempt under s.98A, so there is no return to extend." }, { "code": "reporting_window_passed", "type": null, "when": "Returned as a warning when the 9-month period and the agent's 30-day reporting window have both passed." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is a limited partnership." } ] } }, "Params_vg_beneficial_ownership_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "became_aware_date": { "type": "string", "format": "date", "description": "Date the entity became aware of the change.", "examples": [ "2026-10-12" ] }, "notification_source": { "type": "string", "enum": [ "bo_notice", "entity_opinion", "registered_agent_review", "entiva_transaction" ], "description": "How the change came to light: - bo_notice: the beneficial owner notified within 14 days under reg 23. - entity_opinion: the entity formed the view under reg 24.", "examples": [ "entiva_transaction" ] }, "changes": { "type": "array", "items": {}, "description": "One object per change.", "examples": [ "[{\"kind\": \"new_beneficial_owner\", \"person\": \"per_N3wB0aQ1\", \"effective_date\": \"2026-10-09\", \"interest\": {\"shares_pct\": 30, \"votes_pct\": 30, \"control_types\": [\"ownership\", \"voting\"], \"direct\": true}}]" ] }, "reg24_confirmation": { "type": "object", "description": "For notification_source entity_opinion.", "examples": [ "{\"notice_sent_at\": \"2026-10-01\", \"response\": \"confirmed\", \"responded_at\": \"2026-10-05\"}" ] }, "correction": { "type": "object", "description": "For kind correction (reg 16).", "examples": [ "{\"inaccuracy\": \"Residential address of per_8QfL2cWm out of date\", \"steps\": \"New proof of address requested\", \"expected_by\": \"2026-11-10\"}" ] }, "linked_action": { "type": "string", "description": "id of the action that caused the change, for example a share transfer.", "examples": [ "act_Sh4reTrX9p" ] } }, "required": [ "entity_type", "became_aware_date", "notification_source", "changes" ], "description": "Files a change in a company's or limited partnership's beneficial ownership information with the Registrar within 30 days of the entity becoming aware of it (BCA s.96A; LPA s.53B; BO Regulations reg 22). A beneficial owner is a natural." }, "Create_vg_beneficial_ownership_change": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership.change" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a change in beneficial ownership", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "bo_particulars_form", "title": "Beneficial ownership particulars confirmation", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart after the change", "source": "generated", "required": true }, { "key": "change_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "intermediate_entity_kyb", "title": "KYB pack for each new intermediate legal entity", "source": "uploaded", "required": false }, { "key": "trust_deed", "title": "Trust deed and amendments", "source": "uploaded", "required": false }, { "key": "reg24_notice", "title": "Entity's notice to the beneficial owner of a change", "source": "generated", "required": false }, { "key": "bo_change_filing", "title": "Beneficial ownership change filing", "source": "generated", "required": true }, { "key": "filing_record", "title": "VIRRGIN filing record and fee receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "settlor", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "bo_particulars_form", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "bo_change_filing", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "reg24_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "bo_change_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Change in beneficial ownership information on VIRRGIN", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_exempt_from_bo_filing", "type": null, "when": "The entity is exempt from BO filing." }, { "code": "beneficial_owner_unconfirmed", "type": null, "when": "A new owner has not confirmed their particulars." }, { "code": "verification_incomplete", "type": null, "when": "A new owner or controller has not completed enhanced verification." }, { "code": "sanctions_match", "type": null, "when": "A party matches the UK Sanctions List, the UN list or a BVI designation." }, { "code": "effective_date_invalid", "type": null, "when": "effective_date is in the future or after became_aware_date." }, { "code": "interest_inconsistent", "type": null, "when": "The percentages exceed 100%, or a listed owner is below 10% without any control type." }, { "code": "correction_period_too_long", "type": null, "when": "A correction's expected_by is more than 30 days away and no Registrar extension is recorded (reg 16-)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the filing." } ] } }, "Params_vg_beneficial_ownership_request": { "type": "object", "properties": { "requester_type": { "type": "string", "enum": [ "individual", "legal_person", "obliged_entity" ], "description": "Who makes the request (reg 31C-).", "examples": [ "obliged_entity" ] }, "legitimate_interest_ground": { "type": "string", "enum": [ "aml_cft_cpf_investigation", "connected_to_convicted_or_prosecuted_person", "obliged_entity_cdd" ], "description": "Ground under reg 31A-.", "examples": [ "obliged_entity_cdd" ] }, "target_entity_name": { "type": "string", "description": "Name of the legal entity whose BO entry is requested.", "examples": [ "Harbour Holdings Limited" ] }, "target_entity_number": { "type": "string", "description": "Company or LP number, if known.", "examples": [ "1876543" ] }, "target_register": { "type": "string", "enum": [ "company", "lp" ], "description": "Register the target is on.", "examples": [ "company" ] }, "target_beneficial_owner_name": { "type": "string", "description": "Name of the beneficial owner concerned, if known (reg 31C).", "examples": [ "" ] }, "access_mode": { "type": "string", "enum": [ "inspect", "copy" ], "description": "Inspect the entry, or receive a copy.", "examples": [ "copy" ] }, "purpose_statement": { "type": "string", "description": "Purpose for which the information will be used, with regard to reg 31A.", "examples": [ "To assist the requester in carrying out customer due diligence on Harbour Holdings Limited as a prospective client under the AML/TF Code of Practice." ] }, "use_declaration": { "type": "boolean", "description": "Declaration that the information will be used solely for the stated purpose (reg 31C).", "examples": [ "true" ] }, "requester_details": { "type": "object", "description": "Individual: {name as on passport, address, contact}.", "examples": [ "{\"name\":\"Example Trust Company (BVI) Ltd\",\"address\":\"Road Town, Tortola\",\"responsible_individual\":\"per_9MlroX1a\"}" ] }, "supporting_information": { "type": "array", "items": {}, "description": "document_refs that help the Registrar assess the legitimate interest (reg 31C).", "examples": [ "[\"doc_2LicEv1a\"]" ] } }, "required": [ "requester_type", "legitimate_interest_ground", "target_entity_name", "target_register", "access_mode", "purpose_statement", "use_declaration", "requester_details" ], "description": "Asks the Registrar to let the customer inspect, or receive a copy of, the Register of Beneficial Ownership entry for another BVI company or limited partnership. Three grounds qualify (BO Regulations reg 31A): investigating or preventing." }, "Create_vg_beneficial_ownership_request": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership.request" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request access to another BVI entity's beneficial ownership information on legitimate-interest grounds", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "access_request_form", "title": "Request to inspect or copy an entry in the Register of BO", "source": "generated", "required": true }, { "key": "requester_id_document", "title": "Requester's passport or government ID", "source": "uploaded", "required": false }, { "key": "legitimate_interest_evidence", "title": "Evidence of legitimate interest", "source": "uploaded", "required": false }, { "key": "bo_entry_copy", "title": "Copy of the BO entry, or the inspection record", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "access_request_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission, Registrar of Corporate Affairs", "form": "Request to inspect or obtain a copy of an entry in the Register of Beneficial Ownership", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_legitimate_interest", "type": null, "when": "The Registrar finds that no reg 31A ground is met, or a reg 31C condition is missing (reg 31C)." }, { "code": "declined_public_interest", "type": null, "when": "The Registrar refuses on public-interest grounds (reg 31C)." }, { "code": "objection_upheld", "type": null, "when": "The entity's opposing application succeeds (reg 31E)." }, { "code": "target_exempt", "type": null, "when": "The Registrar has granted an exemption from disclosure." }, { "code": "no_reportable_owners", "type": null, "when": "No beneficial owner holds 25% or more (s.96A), so there is nothing to disclose." }, { "code": "use_declaration_required", "type": null, "when": "use_declaration is not true." }, { "code": "target_not_found", "type": null, "when": "No legal entity matches the target details." } ] } }, "Params_vg_beneficial_ownership_access_decision_appeal": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "opposition_action": { "type": "string", "description": "id of the vg.beneficial_ownership_disclosure_opposition.apply action the decision was made on.", "examples": [ "act_Opp0s1tN9k2R" ] }, "decision_date": { "type": "string", "format": "date", "description": "Date of the Registrar's decision.", "examples": [ "2026-10-28" ] }, "appellant": { "type": "string", "enum": [ "legal_entity", "beneficial_owner" ], "description": "Who appeals: the legal entity, or the affected beneficial owner as a person aggrieved.", "examples": [ "legal_entity" ] }, "grounds_of_appeal": { "type": "string", "description": "Summary grounds.", "examples": [ "The Registrar failed to consider evidence of a continuing extortion risk under reg 31G(6)(a)." ] }, "stage_only": { "type": "string", "enum": [ "full_appeal", "notice_of_intent_only" ], "description": "notice_of_intent_only files just the 3-day notice to keep the stay in place while the customer decides. full_appeal, the default, files both.", "examples": [ "full_appeal" ] } }, "required": [ "entity_type", "opposition_action", "decision_date", "appellant", "grounds_of_appeal" ], "description": "A person aggrieved by the Registrar's decision on an opposed access request may appeal to the Financial Services Appeal Board. The steps are: - file a notice of intent to appeal with the Registrar within 3 days of the decision - appeal to." }, "Create_vg_beneficial_ownership_access_decision_appeal": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_access_decision.appeal" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_access_decision_appeal" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appeal a Registrar decision on beneficial ownership disclosure", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registrar_decision", "title": "Registrar's decision under reg 31E", "source": "registry_issued", "required": true }, { "key": "notice_of_intent_to_appeal", "title": "Notice of intent to appeal (reg 31F)", "source": "generated", "required": true }, { "key": "notice_of_appeal", "title": "Appeal to the Financial Services Appeal Board, with proof of service on the Registrar (reg 31F)", "source": "generated", "required": false }, { "key": "appeal_bundle", "title": "Evidence bundle", "source": "uploaded", "required": false }, { "key": "appeal_board_decision", "title": "Appeal Board decision", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "lawyer", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_of_intent_to_appeal", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_intent_to_appeal", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_appeal", "signer_role": "lawyer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of intent to appeal", "channel": "both", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_of_intent_window_expired", "type": null, "when": "More than 3 days have passed since decision_date, so the reg 31F stay can no longer be obtained." }, { "code": "appeal_window_expired", "type": null, "when": "More than 21 days have passed since decision_date." }, { "code": "appeal_abandoned", "type": null, "when": "A notice of intent was filed but no appeal followed within 21 days." }, { "code": "decision_not_appealable", "type": null, "when": "There is no reg 31E decision on the linked action." } ] } }, "Params_vg_beneficial_ownership_access_objection_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "registrar_notice_reference": { "type": "string", "description": "Reference of the Registrar's notice under reg 31D.", "examples": [ "ROBO-LIA-2026-01873" ] }, "notice_received_at": { "type": "string", "format": "date", "description": "Date the entity received the notice.", "examples": [ "2026-10-15" ] }, "requester": { "type": "object", "description": "As stated in the notice: the individual, or the legal person on whose behalf the request is made, and the stated purpose (reg 31D-).", "examples": [ "{\"name\": \"Example Bank plc\", \"purpose\": \"Customer due diligence on onboarding\"}" ] }, "objection_grounds": { "type": "array", "items": {}, "description": "Grounds the entity expects to rely on: not_proper_purpose, misleading_or_inaccurate_request (reg 31E), or a reg 31G circumstance.", "examples": [ "[\"not_proper_purpose\"]" ] }, "affected_beneficial_owners": { "type": "array", "items": {}, "description": "person_ref ids of the owners whose information is requested.", "examples": [ "[\"per_8QfL2cWm\"]" ] }, "create_opposition": { "type": "boolean", "description": "Default true.", "examples": [ "true" ] } }, "required": [ "entity_type", "registrar_notice_reference", "notice_received_at", "objection_grounds", "affected_beneficial_owners" ], "description": "When someone with a claimed legitimate interest asks to inspect an entity's beneficial ownership entry, the Registrar notifies the entity. The notice states who made the request and its purpose." }, "Create_vg_beneficial_ownership_access_objection_file": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_access_objection.file" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_access_objection_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Object to a legitimate-interest request for beneficial ownership information", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registrar_access_notice", "title": "Registrar's notice of a legitimate-interest request (reg 31D-)", "source": "registry_issued", "required": true }, { "key": "notice_of_objection", "title": "Notice of objection (reg 31D)", "source": "generated", "required": true }, { "key": "filing_record", "title": "VIRRGIN filing record", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_of_objection", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_objection", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of objection under BO Regulations reg 31D", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "objection_window_expired", "type": null, "when": "More than 5 days have passed since notice_received_at." }, { "code": "objection_not_available", "type": null, "when": "The request was made by an obliged entity doing customer due diligence." }, { "code": "notice_not_found", "type": null, "when": "registrar_notice_reference does not match a notice received by the partner." }, { "code": "registry_rejected", "type": null, "when": "The Registrar does not accept the notice." } ] } }, "Params_vg_beneficial_ownership_copy_request": { "type": "object", "properties": { "purpose": { "type": "string", "description": "Why the certified copy is needed, for example bank onboarding." }, "as_at_date": { "type": "string", "format": "date", "description": "Date as of which the entry is certified; default current." }, "include_ceased_entries": { "type": "boolean", "description": "Include ceased entries still on the register." }, "delivery": { "type": "string", "enum": [ "electronic", "paper" ], "description": "Default electronic." }, "recipient": { "type": "string", "description": "Name of the third party who will receive the copy." }, "apostille_required": { "type": "boolean", "description": "Whether the copy will be apostilled for foreign use." } }, "required": [ "purpose" ], "description": "The registered agent requests a certified copy of the company's or LP's own entry on the private Register of Beneficial Ownership. $75." }, "Create_vg_beneficial_ownership_copy_request": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_copy.request" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain a certified copy of an entity's own beneficial ownership entry", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "release_authorisation", "title": "Director's authorisation to release BO information", "source": "generated", "required": true }, { "key": "certified_bo_entry", "title": "Certified copy of BO entry", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "release_authorisation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Request to the Registrar under reg 31B", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_bo_entry", "type": null, "when": "The entity has no filed BO entry." }, { "code": "release_not_authorised", "type": null, "when": "No director authorisation." }, { "code": "bo_filing_pending", "type": null, "when": "A BO change is being filed; wait for it to complete." } ] } }, "Params_vg_beneficial_ownership_disclosure_exemption_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "application_kind": { "type": "string", "enum": [ "new_exemption", "exemption_renewal", "refusal_decision_renewal", "change_of_circumstances_notice" ], "description": "One of: - new_exemption (reg 31G) - exemption_renewal: a time-limited exemption is expiring (reg 31G). - refusal_decision_renewal: renews a Registrar decision.", "examples": [ "new_exemption" ] }, "applicant_type": { "type": "string", "enum": [ "beneficial_owner", "legal_entity" ], "description": "Who applies.", "examples": [ "beneficial_owner" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "Required when applicant_type is beneficial_owner.", "examples": [ "per_8QfL2cWm" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "person_ref ids of the owners whose information the exemption covers, with name and contact details (reg 31G).", "examples": [ "[\"per_8QfL2cWm\"]" ] }, "grounds": { "type": "array", "items": {}, "description": "One or more of serious_risk_of_harm, minor_or_lacks_capacity, special_reasons, national_security and public_interest (reg 31G-).", "examples": [ "[\"serious_risk_of_harm\"]" ] }, "statement_of_reasons": { "type": "string", "description": "Why the ground applies, including the reasons for any belief held (reg 31G,).", "examples": [ "The owner was the target of an extortion attempt in 2025 after a data leak disclosed her shareholdings; police report attached." ] }, "evidence": { "type": "array", "items": {}, "description": "document_ref ids evidencing that the circumstance exists or is likely (reg 31G), for example a police report, court protection order, birth certificate or.", "examples": [ "[\"doc_PolRep2025a\"]" ] }, "scope": { "type": "string", "enum": [ "general", "specific" ], "description": "Whether the exemption sought is general or tied to a specific request.", "examples": [ "general" ] }, "requested_period_months": { "type": "integer", "description": "Period requested.", "examples": [ "36" ] }, "related_entities": { "type": "array", "items": {}, "description": "Other entities, as entity_ref ids, for which the same owner seeks the exemption.", "examples": [ "[\"ent_7YtR2pLmQx\"]" ] }, "prior_decision_reference": { "type": "string", "description": "Registrar reference of the exemption or decision being renewed or updated.", "examples": [ "ROBO-EX-2026-00412" ] } }, "required": [ "entity_type", "application_kind", "applicant_type", "beneficial_owners", "grounds", "statement_of_reasons", "evidence" ], "description": "Applies in advance to the Registrar, in the approved form, for an exemption from disclosing a beneficial owner's information to people with a legitimate interest. Legitimate-interest access has run since 1 April 2026 and covers owners of." }, "Create_vg_beneficial_ownership_disclosure_exemption_apply": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_disclosure_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_disclosure_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for exemption from disclosure of beneficial ownership information", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_application", "title": "Application for exemption from disclosure of BO information", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence of the circumstance relied on", "source": "uploaded", "required": true }, { "key": "national_security_letter", "title": "Official letter from the National Security Council or the equivalent foreign authority", "source": "uploaded", "required": false }, { "key": "guardian_authority", "title": "Evidence of authority to act for a minor or a person lacking capacity", "source": "uploaded", "required": false }, { "key": "registrar_decision", "title": "Registrar's decision on the exemption", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "exemption_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_application", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Application for an exemption from disclosure of beneficial ownership information", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "grounds_missing", "type": null, "when": "No ground under reg 31G is selected, or statement_of_reasons is empty." }, { "code": "evidence_missing", "type": null, "when": "No evidence document is attached (reg 31G)." }, { "code": "owner_below_disclosure_threshold", "type": null, "when": "The owner holds less than 25% and has no other disclosable interest, so legitimate-interest access cannot reach them (s.96A)." }, { "code": "prior_decision_not_found", "type": null, "when": "A renewal or notice names an unknown prior_decision_reference." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses the exemption." } ] } }, "Params_vg_beneficial_ownership_disclosure_opposition_apply": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "objection_action": { "type": "string", "description": "id of the completed vg.beneficial_ownership_access_objection.file action.", "examples": [ "act_0bJcT5nLq8We" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "person_ref ids of the owners the request relates to.", "examples": [ "[\"per_8QfL2cWm\"]" ] }, "grounds": { "type": "array", "items": {}, "description": "Any of not_proper_purpose, misleading_or_inaccurate_request, serious_risk_of_harm, minor_or_lacks_capacity, special_reasons, national_security and.", "examples": [ "[\"not_proper_purpose\", \"serious_risk_of_harm\"]" ] }, "show_cause_statement": { "type": "string", "description": "The entity's reasons for the objection and for any belief held (reg 31E,).", "examples": [ "The requester is not an obliged entity and states a journalistic purpose, which is not one of the reg 31A(2) purposes; the owner also faces a documented extortion risk." ] }, "evidence": { "type": "array", "items": {}, "description": "document_ref ids evidencing that the circumstance exists or is likely (reg 31E).", "examples": [ "[\"doc_PolRep2025a\"]" ] }, "beneficial_owner_statement": { "type": "string", "pattern": "^doc_", "description": "Signed statement from the owner supporting the grounds.", "examples": [ "doc_BoStmt0416" ] } }, "required": [ "entity_type", "objection_action", "beneficial_owners", "grounds", "show_cause_statement", "evidence" ], "description": "After filing a notice of objection, the entity has 5 days to apply to the Registrar, in the approved form, opposing disclosure (BO Regulations regs 31D, 31E). The application: - names the beneficial owner and their contact details - shows." }, "Create_vg_beneficial_ownership_disclosure_opposition_apply": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_disclosure_opposition.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_disclosure_opposition_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the Registrar opposing disclosure of beneficial ownership information", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "opposition_application", "title": "Application opposing disclosure of BO information", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence supporting the grounds", "source": "uploaded", "required": true }, { "key": "beneficial_owner_statement", "title": "Beneficial owner's supporting statement", "source": "uploaded", "required": false }, { "key": "registrar_decision", "title": "Registrar's decision with appeal rights", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "lawyer", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "opposition_application", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "beneficial_owner_statement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "opposition_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Application opposing disclosure of beneficial ownership information", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "objection_not_filed", "type": null, "when": "objection_action is missing or not completed." }, { "code": "opposition_window_expired", "type": null, "when": "More than 5 days have passed since the notice of objection was filed." }, { "code": "evidence_missing", "type": null, "when": "No evidence is attached (reg 31E)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the objection and will give access." } ] } }, "Params_vg_beneficial_ownership_discrepancy_file": { "type": "object", "properties": { "access_request_action_id": { "type": "string", "description": "act_ id of the vg.beneficial_ownership.access_request that produced the entry, if made through Entiva.", "examples": [ "act_7BoAcc26" ] }, "target_entity_name": { "type": "string", "description": "Legal entity whose BO entry differs.", "examples": [ "Harbour Holdings Limited" ] }, "target_entity_number": { "type": "string", "description": "Company or LP number.", "examples": [ "1876543" ] }, "discovery_date": { "type": "string", "format": "date", "description": "Date the discrepancy was discovered.", "examples": [ "2026-10-28" ] }, "beneficial_owner_name": { "type": "string", "description": "Beneficial owner to whom the discrepancy relates.", "examples": [ "A. Example" ] }, "discrepancy_description": { "type": "string", "description": "What differs, for example the nature of interest, nationality, or an owner missing from the Register.", "examples": [ "Register shows 30% direct shareholding; our CDD shows 55% held indirectly through Example Nominees Ltd." ] }, "information_held": { "type": "object", "description": "BO particulars the obliged entity holds, limited to what is needed to explain the discrepancy.", "examples": [ "{\"nature_of_interest\":\"55% indirect\",\"source\":\"Certified register of members dated 2026-09-30\"}" ] }, "responsible_individual": { "type": "string", "pattern": "^per_", "description": "MLRO or compliance officer who signs the notice.", "examples": [ "per_9MlroX1a" ] } }, "required": [ "target_entity_name", "discovery_date", "beneficial_owner_name", "discrepancy_description", "responsible_individual" ], "description": "An obliged entity that inspects or receives a copy of a BVI entity's BO entry must notify the Registrar in writing within 14 days if the entry differs from the beneficial ownership information it holds on the same beneficial owner (BO." }, "Create_vg_beneficial_ownership_discrepancy_file": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_discrepancy.file" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_discrepancy_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report a beneficial ownership discrepancy to the Registrar", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "discrepancy_notice", "title": "Written notice of discrepancy to the Registrar", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Supporting CDD evidence", "source": "uploaded", "required": false }, { "key": "registrar_acknowledgement", "title": "Registrar's acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "other", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "discrepancy_notice", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission, Registrar of Corporate Affairs", "form": "Written notification of a discrepancy under BO Regulations reg 31C", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_passed", "type": null, "when": "More than 14 days have passed since discovery_date." }, { "code": "not_an_obliged_entity", "type": null, "when": "The requesting entity is not recorded as an obliged entity, and reg 31C applies only to obliged entities." } ] } }, "Params_vg_beneficial_ownership_exemption_file": { "type": "object", "properties": { "applicant": { "type": "string", "pattern": "^per_", "description": "Beneficial owner.", "examples": [ "per_6Nb4" ] }, "ground": { "type": "string", "enum": [ "serious_risk_of_fraud_kidnapping_blackmail_extortion_harassment_or_violence", "minor", "lacks_capacity", "special_reasons", "national_security", "public_interest" ], "description": "Ground under reg 31G." }, "ground_statement": { "type": "string", "description": "Facts supporting the ground." }, "entities": { "type": "array", "items": {}, "description": "Other entity refs covered by the same application." }, "supporting_evidence": { "type": "array", "items": {}, "description": "document_ref items such as police reports or court orders." }, "existing_exemption_renewal": { "type": "boolean", "description": "True when renewing; refusals last 3 years and are renewable (reg 31E)." } }, "required": [ "applicant", "ground", "ground_statement" ], "description": "Applies to the Registrar for exemption from legitimate-interest disclosure of beneficial ownership information for one or more entities, on the grounds in BO Regs reg 31G." }, "Create_vg_beneficial_ownership_exemption_file": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_exemption.file" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_exemption_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for exemption from beneficial ownership disclosure", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_application", "title": "Exemption application", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence for the ground", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution authorising the application for the entity", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registrar acknowledgement", "source": "registry_issued", "required": true }, { "key": "exemption_decision", "title": "Registrar decision", "source": "registry_issued", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "exemption_application", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Exemption application in the approved form", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ground_not_supported", "type": null, "when": "The ground is not one listed in reg 31G." }, { "code": "evidence_missing", "type": null, "when": "No evidence is supplied for the stated ground." }, { "code": "applicant_unverified", "type": null, "when": "The applicant has not completed enhanced verification." }, { "code": "entity_not_covered", "type": null, "when": "An entity in entities is not a company or LP in scope." } ] } }, "Params_vg_beneficial_ownership_extract_request": { "type": "object", "properties": { "extract_type": { "type": "string", "enum": [ "registrar_copy", "certified_copy" ], "description": "registrar_copy: a copy of the BO information filed (reg 31B). certified_copy: a certified copy of the entry.", "examples": [ "certified_copy" ] }, "requester_capacity": { "type": "string", "enum": [ "legal_entity", "registered_agent", "insolvent_liquidator" ], "description": "Who asks under reg 31B.", "examples": [ "registered_agent" ] }, "purpose": { "type": "string", "description": "Optional, for example bank KYC or reconciliation.", "examples": [ "Bank KYC refresh" ] }, "apostille": { "type": "boolean", "description": "Apostille the certified copy for use abroad.", "examples": [ "false" ] } }, "required": [ "extract_type", "requester_capacity" ], "description": "Gets the beneficial ownership information that the Registrar holds for the entity itself, in one of two forms. The first is a copy provided on written request by the legal entity, its registered agent or its insolvency liquidator (BO." }, "Create_vg_beneficial_ownership_extract_request": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_extract.request" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_extract_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain the Registrar's copy, or a certified copy, of the entity's own beneficial ownership entry", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "request_letter", "title": "Written request to the Registrar", "source": "generated", "required": true }, { "key": "bo_extract", "title": "Beneficial ownership copy or certified copy", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "request_letter", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission, Registry of Corporate Affairs", "form": "Written request under BO Regulations reg 31B", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_bo_filing", "type": null, "when": "The entity has filed no BO information, for example an exempt fund or listed company (s.96A)." }, { "code": "requester_not_permitted", "type": null, "when": "requester_capacity is not one reg 31B allows." } ] } }, "Params_vg_beneficial_ownership_objection_file": { "type": "object", "properties": { "access_request_reference": { "type": "string", "description": "Registrar's reference for the access request.", "examples": [ "LIA-2026-004417" ] }, "notice_received_date": { "type": "string", "format": "date", "description": "Date of the Registrar's notice.", "examples": [ "2026-10-16" ] }, "objection_grounds": { "type": "string", "description": "Why the request should be refused, for example no legitimate interest." }, "beneficial_owners_affected": { "type": "array", "items": {}, "description": "person_ref items whose information is sought." }, "proceed_to_opposition": { "type": "boolean", "description": "True to open vg.beneficial_ownership_opposition.file immediately after." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director or authorised individual who signs for the entity." } }, "required": [ "access_request_reference", "notice_received_date", "objection_grounds", "authorised_signatory" ], "description": "Files the entity's notice of objection within 5 days of the Registrar's notice of a legitimate-interest access request (BO Regs reg 31D)." }, "Create_vg_beneficial_ownership_objection_file": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_objection.file" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_objection_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Object to a beneficial ownership access request", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "objection_notice", "title": "Notice of objection", "source": "generated", "required": true }, { "key": "registrar_notice", "title": "Registrar's notice of the access request", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution authorising the objection", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "objection_notice", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "objection_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of objection", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "objection_window_closed", "type": null, "when": "More than 5 days since the Registrar's notice." }, { "code": "request_not_found", "type": null, "when": "The access_request_reference does not match a pending request." }, { "code": "authorised_signatory_missing", "type": null, "when": "No verified signatory exists for the entity." } ] } }, "Params_vg_beneficial_ownership_opposition_file": { "type": "object", "properties": { "access_request_reference": { "type": "string", "description": "Registrar's reference for the access request.", "examples": [ "LIA-2026-004417" ] }, "objection_filed_date": { "type": "string", "format": "date", "description": "Date the objection was filed; starts the 5-day clock.", "examples": [ "2026-10-19" ] }, "ground": { "type": "string", "enum": [ "serious_risk_of_fraud_kidnapping_blackmail_extortion_harassment_or_violence", "minor", "lacks_capacity", "special_reasons", "national_security", "public_interest" ], "description": "Ground for opposing disclosure, drawn from reg 31G." }, "ground_statement": { "type": "string", "description": "Facts supporting the ground." }, "supporting_evidence": { "type": "array", "items": {}, "description": "document_ref items." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Director or authorised individual." } }, "required": [ "access_request_reference", "objection_filed_date", "ground", "ground_statement", "authorised_signatory" ], "description": "After an objection, files the application opposing disclosure within 5 more days. A refusal lasts 3 years and is renewable." }, "Create_vg_beneficial_ownership_opposition_file": { "type": "object", "properties": { "type": { "const": "vg.beneficial_ownership_opposition.file" }, "params": { "$ref": "#/components/schemas/Params_vg_beneficial_ownership_opposition_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to oppose disclosure of beneficial ownership information", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "opposition_application", "title": "Application opposing disclosure", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence for the ground", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true }, { "key": "registrar_decision", "title": "Registrar decision", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "opposition_application", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "opposition_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Application opposing disclosure", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "opposition_window_closed", "type": null, "when": "More than 5 days since the objection." }, { "code": "objection_not_found", "type": null, "when": "No objection on file for the request." }, { "code": "evidence_missing", "type": null, "when": "No evidence supports the ground." } ] } }, "Params_vg_bvifars_annual_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Year in which the fee is due.", "examples": [ "2027" ] }, "bvifars_id": { "type": "string", "description": "The entity's BVIFARS identifier.", "examples": [ "VGFI-004512" ] } }, "required": [ "fee_year" ], "description": "Pays the US$185 annual fee that every entity required to be enrolled in BVIFARS owes the International Tax Authority. It is due on or before 1 June each year (MLA Order 2024, SI 22 of 2024, para 3)." }, "Create_vg_bvifars_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.bvifars_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_bvifars_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual BVIFARS fee", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_receipt", "title": "BVIFARS fee receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "payment_receipt", "signer_role": "other", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI International Tax Authority", "form": "Annual BVIFARS fee", "channel": "online", "government_fee": { "amount": 185, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_enrolled", "type": null, "when": "The entity is not enrolled in BVIFARS." }, { "code": "already_paid", "type": null, "when": "The fee for fee_year is already paid." }, { "code": "spending_limit_exceeded", "type": null, "when": "An agent key's mandate does not cover the amount, so a human approval is needed." } ] } }, "Params_vg_bvifars_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Year the fee is due.", "examples": [ "2027" ] }, "late_payment": { "type": "boolean", "description": "True when paying after 1 June; the partner adds the para 5 late fee." }, "payment_reference": { "type": "string", "description": "Customer reference." } }, "required": [ "fee_year" ], "description": "Pays the $185 annual BVIFARS fee, due by 1 June each year (MLA Order 2024, SI 22 of 2024)." }, "Create_vg_bvifars_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.bvifars_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_bvifars_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual BVIFARS fee", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_authorisation", "title": "Payment authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "BVIFARS payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "payment_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "International Tax Authority", "form": "Annual BVIFARS fee payment", "channel": "online", "government_fee": { "amount": 185, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_enrolled", "type": null, "when": "Entity has no BVIFARS enrolment." }, { "code": "fee_already_paid", "type": null, "when": "Fee for fee_year already paid." }, { "code": "mandate_limit_exceeded", "type": null, "when": "Fee exceeds the agent's spending limit." } ] } }, "Params_vg_certified_copy_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "items": { "type": "array", "items": {}, "description": "One object per item.", "examples": [ "[{\"document_kind\": \"certificate_of_incorporation\", \"form\": \"certified\", \"quantity\": 1}, {\"document_kind\": \"memorandum_and_articles\", \"form\": \"certified\", \"quantity\": 1}]" ] }, "apostille": { "type": "boolean", "description": "If true, Entiva creates the BVI apostille action for the certified items once they issue.", "examples": [ "true" ] }, "delivery": { "type": "string", "enum": [ "electronic", "courier" ], "description": "electronic or courier for physical items.", "examples": [ "electronic" ] }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for courier.", "examples": [ "{\"line1\": \"8 Marina View\", \"city\": \"Singapore\", \"postal_code\": \"018960\", \"country\": \"SG\"}" ] }, "purpose": { "type": "string", "description": "Free text.", "examples": [ "KYC pack for a Hong Kong bank" ] } }, "required": [ "entity_type", "items" ], "description": "Orders Registrar-certified or uncertified copies and extracts of an entity's certificates, and copies of filed documents. Certificates include incorporation or registration, restoration, merger, consolidation, arrangement, continuation." }, "Create_vg_certified_copy_request": { "type": "object", "properties": { "type": { "const": "vg.certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_vg_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request certified or uncertified copies from the Registrar", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "copy_request", "title": "Request for copies and extracts", "source": "generated", "required": true }, { "key": "registrar_copies", "title": "Registrar-certified or uncertified copies, extracts or duplicates", "source": "registry_issued", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "copy_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Request for certified or uncertified copies and extracts", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "document_kind_not_available", "type": null, "when": "The requested certificate does not exist for this entity, for example a certificate of merger for an entity that never merged." }, { "code": "filed_document_reference_required", "type": null, "when": "An other_filed_document item has no filed_document_reference." }, { "code": "register_copy_restricted", "type": null, "when": "Copies of the privately filed register of members (s.43A) and register of directors (s.118B) go only to the entity, its registered agent and authorities, unless the company opted." }, { "code": "beneficial_ownership_copy_not_here", "type": null, "when": "A copy of the entity's own beneficial ownership entry was requested." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses or cannot fulfil an item." } ] } }, "Params_vg_company_record_request": { "type": "object", "properties": { "subject_company": { "type": "object", "description": "Company searched: company_number, name, entity_type." }, "scope": { "type": "string", "enum": [ "registers_s230", "single_document", "all_documents" ], "description": "registers_s230 = registers kept under s.230, $50; single_document = one other qualifying document, $100; all_documents = all qualifying documents, $250." }, "document_description": { "type": "string", "description": "Which document, when scope is single_document." }, "delivery": { "type": "string", "enum": [ "electronic", "paper" ], "description": "Default electronic." } }, "required": [ "subject_company", "scope" ], "description": "Requests inspection of a company's registers, a specific filed document, or all qualifying documents under BCA s.233, for any BVI company or registered foreign company. Fee $50, $100 or $250." }, "Create_vg_company_record_request": { "type": "object", "properties": { "type": { "const": "vg.company_record.request" }, "params": { "$ref": "#/components/schemas/Params_vg_company_record_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Search or inspect the BVI Register of Companies and filed documents", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "inspection_copy", "title": "Registry inspection output", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Inspection request", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "company_not_found", "type": null, "when": "No company matches subject_company." }, { "code": "document_description_required", "type": null, "when": "scope is single_document without a description." }, { "code": "document_not_available", "type": null, "when": "Requested document is not a qualifying document." } ] } }, "Params_vg_director_annual_return_file": { "type": "object", "properties": { "return_date": { "type": "string", "format": "date", "description": "Date the return is made up to.", "examples": [ "2026-12-31" ] }, "directors": { "type": "array", "items": {}, "description": "Every person who was a director on the return date, as person_ref items.", "examples": [ "[\"per_8Kd2\",\"per_3Hx9\"]" ] }, "changes_since_last_return": { "type": "boolean", "description": "True when the directors differ from the previous return or the register of directors." }, "certified_by": { "type": "string", "enum": [ "registered_agent", "director" ], "description": "Who certifies the return." }, "certifying_director": { "type": "string", "pattern": "^per_", "description": "Required when certified_by is director." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office as it appears on the return, for a consistency check against the register." } }, "required": [ "return_date", "directors" ], "description": "Files the annual return of directors for a BVI unlimited company not authorised to issue shares, made up to 31 December. The partner registered agent certifies and submits it on VIRRGIN by 31 March." }, "Create_vg_director_annual_return_file": { "type": "object", "properties": { "type": { "const": "vg.director_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_vg_director_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File annual return of directors", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_unlimited_no_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_directors_extract", "title": "Register of directors extract at the return date", "source": "generated", "required": true }, { "key": "annual_return_form", "title": "Annual return of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_return_form", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "annual_return_form", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Annual return of directors, approved form", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": null, "when": "The entity is not an unlimited company without shares." }, { "code": "return_date_not_reached", "type": null, "when": "The return_date is after today and the caller asks to submit immediately." }, { "code": "director_not_on_register", "type": null, "when": "A listed director is not on the register of directors, or a current director is missing." }, { "code": "director_unverified", "type": null, "when": "A director has not completed identity_address verification." }, { "code": "sanctions_alert_open", "type": null, "when": "An open screening alert on a director pauses the filing." } ] } }, "Params_vg_directors_annual_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_unlimited_no_shares" ], "description": "Must be bc_unlimited_no_shares.", "examples": [ "bc_unlimited_no_shares" ] }, "return_year": { "type": "integer", "description": "Calendar year the return covers.", "examples": [ "2026" ] }, "made_up_to_date": { "type": "string", "format": "date", "description": "Defaults to 31 December of return_year.", "examples": [ "2026-12-31" ] }, "directors": { "type": "array", "items": {}, "description": "person_ref ids of the directors in office on the made-up-to date.", "examples": [ "[\"per_8QfL2cWm\", \"per_X1v7TnRb\"]" ] }, "reserve_directors": { "type": "array", "items": {}, "description": "person_ref ids of any reserve directors nominated under s.113 who are on the register on the made-up-to date.", "examples": [ "[]" ] }, "licensed_director_disclosure": { "type": "object", "description": "Required where a director is provided by an FSC licensee (s.118).", "examples": [ "{\"licensee_name\": \"Example Directors Ltd\", \"individual_name\": \"Ana Smith\", \"individual_address\": \"Road Town, Tortola\"}" ] }, "certifier": { "type": "string", "enum": [ "registered_agent", "director" ], "description": "Who certifies the return as correct (s.118C). registered_agent: Entiva certifies in its own capacity, which is the default. director: a named director.", "examples": [ "registered_agent" ] }, "certifying_director": { "type": "string", "pattern": "^per_", "description": "Required when certifier is director.", "examples": [ "per_8QfL2cWm" ] } }, "required": [ "entity_type", "return_year", "certifier" ], "description": "An unlimited company that is not authorised to issue shares must file, by 31 March each year, an annual return of its directors in the approved form, made up to 31 December of the previous year. A director or the registered agent certifies." }, "Create_vg_directors_annual_return_file": { "type": "object", "properties": { "type": { "const": "vg.directors_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_vg_directors_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return of directors", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_unlimited_no_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_annual_return", "title": "Annual return of directors", "source": "generated", "required": true }, { "key": "register_of_directors_extract", "title": "Register of directors as at the made-up-to date", "source": "generated", "required": false }, { "key": "filing_record", "title": "VIRRGIN filing record and fee receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_annual_return", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "directors_annual_return", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_annual_return", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Annual return of directors in the approved form", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an unlimited company without authority to issue shares, so s.118C does not apply." }, { "code": "made_up_to_date_invalid", "type": null, "when": "made_up_to_date is not 31 December, or the action is submitted before that year has ended." }, { "code": "director_particulars_incomplete", "type": null, "when": "A listed director is missing a s.118A particular." }, { "code": "certifying_director_not_in_office", "type": null, "when": "certifier is director, but certifying_director was not a director on the made-up-to date." }, { "code": "register_of_directors_change_outstanding", "type": null, "when": "A director change during the year was not filed under s.118B." }, { "code": "mandate_scope_exceeded", "type": null, "when": "An agent key's mandate does not cover this action type or entity, or the quote exceeds its spending limit." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the filing." } ] } }, "Params_vg_economic_substance_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "existing_lp_partnership_act_1996", "foreign_company" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "financial_period_start": { "type": "string", "format": "date", "description": "Start of the financial period as notified to the ITA.", "examples": [ "2025-07-01" ] }, "financial_period_end": { "type": "string", "format": "date", "description": "End of the financial period.", "examples": [ "2026-06-30" ] }, "declaration_type": { "type": "string", "enum": [ "relevant_activity", "no_relevant_activity", "non_resident_claim", "provisional_treatment" ], "description": "The T601 declaration type: relevant_activity, no_relevant_activity, non_resident_claim, or provisional_treatment.", "examples": [ "relevant_activity" ] }, "relevant_activities": { "type": "array", "items": {}, "description": "Required for relevant_activity.", "examples": [ "[\"holding\"]" ] }, "activity_details": { "type": "array", "items": {}, "description": "One object per relevant activity.", "examples": [ "[{\"activity\": \"holding\", \"gross_income\": {\"amount\": 1250000, \"currency\": \"USD\"}, \"pure_equity_holding\": true, \"total_expenditure\": {\"amount\": 18000, \"currency\": \"USD\"}, \"bvi_expenditure\": {\"amount\": 4200, \"currency\": \"USD\"}}]" ] }, "no_activity_description": { "type": "string", "description": "Required for no_relevant_activity.", "examples": [ "Holds a portfolio of listed bonds; no relevant activity under ES Act s.6." ] }, "tax_residence_jurisdiction": { "type": "string", "description": "Required for non_resident_claim and provisional_treatment.", "examples": [ "SG" ] }, "tax_identification_number": { "type": "string", "description": "The entity's TIN in its claimed tax residence, if any.", "examples": [ "201912345K" ] }, "parent_entities": { "type": "object", "description": "Immediate and ultimate parent, each with name, jurisdiction of formation, registration number and TIN.", "examples": [ "{\"immediate\": {\"name\": \"Harbour Holdings Ltd\", \"jurisdiction\": \"SG\", \"registration_number\": \"201912345K\"}, \"ultimate\": {\"name\": \"Harbour Group plc\", \"jurisdiction\": \"GB\", \"registration_number\": \"01234567\"}}" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "person_ref ids, each with TIN and tax jurisdiction, for non_resident_claim and provisional_treatment declarations.", "examples": [ "[{\"person\": \"per_B0wn3rA1\", \"tin\": \"S1234567A\", \"tax_jurisdiction\": \"SG\"}]" ] }, "listing": { "type": "object", "description": "Stock exchange and listing details, if the entity is listed (BOSS Act s.10, as inserted by the ES Act).", "examples": [ "{\"exchange\": \"NYSE\", \"ticker\": \"HBR\"}" ] }, "filing_mode": { "type": "string", "enum": [ "auto", "bulk", "single" ], "description": "auto uses bulk filing while the ITA keeps single filing disabled, and single filing once it is restored. bulk forces bulk filing.", "examples": [ "auto" ] } }, "required": [ "entity_type", "financial_period_start", "financial_period_end", "declaration_type" ], "description": "Every BVI company, limited partnership and registered foreign company reports its economic substance position for each financial period to the International Tax Authority. Since 2 January 2026 this is done on VIRRGIN form T601, in single." }, "Create_vg_economic_substance_file": { "type": "object", "properties": { "type": { "const": "vg.economic_substance.file" }, "params": { "$ref": "#/components/schemas/Params_vg_economic_substance_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the economic substance declaration", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "existing_lp_partnership_act_1996", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "es_data_confirmation", "title": "Economic substance data sheet for director approval", "source": "generated", "required": true }, { "key": "es_declaration", "title": "T601 economic substance declaration", "source": "generated", "required": true }, { "key": "tax_residence_evidence", "title": "Evidence of tax residence outside the BVI", "source": "uploaded", "required": false }, { "key": "financial_statements", "title": "Financial statements or management accounts for the period", "source": "uploaded", "required": false }, { "key": "board_minutes", "title": "Board minutes evidencing direction and management in the BVI", "source": "uploaded", "required": false }, { "key": "outsourcing_agreement", "title": "Outsourcing or service agreement with a BVI provider", "source": "uploaded", "required": false }, { "key": "ip_rebuttal_evidence", "title": "Evidence rebutting the IP presumption", "source": "uploaded", "required": false }, { "key": "filing_outcome", "title": "VIRRGIN batch outcome or submission record", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "other", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "es_data_confirmation", "signer_role": "general_partner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "es_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "International Tax Authority", "form": "T601 Economic Substance Declaration", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is outside the ES Act, for example a general partnership." }, { "code": "financial_period_mismatch", "type": null, "when": "The period does not match the one on VIRRGIN." }, { "code": "financial_period_not_ended", "type": null, "when": "financial_period_end is in the future." }, { "code": "activity_details_missing", "type": null, "when": "A declared relevant activity lacks its income, expenditure, employees, premises, direction and management or CIGA fields." }, { "code": "non_resident_jurisdiction_ineligible", "type": null, "when": "The claimed tax residence is the BVI or a jurisdiction on Annex 1 of the EU list, so the non-residence claim fails." }, { "code": "tax_residence_evidence_missing", "type": null, "when": "A non_resident_claim has no tax_residence_evidence document." }, { "code": "bulk_row_rejected", "type": null, "when": "VIRRGIN rejects the entity's row in a bulk batch, or lists the entity as not eligible with a reason." }, { "code": "registry_rejected", "type": null, "when": "The ITA rejects the declaration." } ] } }, "Params_vg_economic_substance_financial_period_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "existing_lp_partnership_act_1996", "foreign_company" ], "description": "Entity type key, from the same scope as vg.economic_substance.file.", "examples": [ "bc_ltd_shares" ] }, "reason": { "type": "string", "enum": [ "alter_period", "migration_correction" ], "description": "alter_period: an application under ES Act s.4, for example to align with a new accounting year end. migration_correction: the period on VIRRGIN is wrong after.", "examples": [ "alter_period" ] }, "current_period_start": { "type": "string", "format": "date", "description": "Start of the current financial period as recorded with the ITA.", "examples": [ "2026-01-01" ] }, "current_period_end": { "type": "string", "format": "date", "description": "End of the current financial period as recorded with the ITA.", "examples": [ "2026-12-31" ] }, "period_start": { "type": "string", "format": "date", "description": "Start of the altered period.", "examples": [ "2026-01-01" ] }, "period_end": { "type": "string", "format": "date", "description": "End of the altered period.", "examples": [ "2026-06-30" ] }, "explanation": { "type": "string", "description": "Reasons for the request, used in the request letter and the T602 remarks.", "examples": [ "The group is moving its accounting year end to 30 June to align with its parent." ] }, "file_declaration_after": { "type": "boolean", "description": "If true, Entiva creates vg.economic_substance.file for the altered period once the ITA accepts the change.", "examples": [ "true" ] } }, "required": [ "entity_type", "reason", "current_period_start", "current_period_end", "period_start", "period_end", "explanation" ], "description": "Asks the International Tax Authority to alter the entity's financial period for economic substance reporting. Under ES Act s.4, a period may be shortened, or lengthened only where the existing period is less than 12 months, and no altered." }, "Create_vg_economic_substance_financial_period_change": { "type": "object", "properties": { "type": { "const": "vg.economic_substance_financial_period.change" }, "params": { "$ref": "#/components/schemas/Params_vg_economic_substance_financial_period_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the economic substance financial period", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "existing_lp_partnership_act_1996", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "request_letter", "title": "Request letter to the ITA for a change of financial period", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution changing the financial year end", "source": "generated", "required": false }, { "key": "t602_request", "title": "T602 financial period change request", "source": "generated", "required": true }, { "key": "ita_decision", "title": "ITA acceptance or refusal of the period change", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "request_letter", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "t602_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "International Tax Authority", "form": "T602 Financial Period Change Request", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "period_exceeds_twelve_months", "type": null, "when": "The altered period would be longer than 12 months (s.4)." }, { "code": "lengthening_not_permitted", "type": null, "when": "The request lengthens a period that is already 12 months long (s.4)." }, { "code": "period_already_declared", "type": null, "when": "A T601 has already been filed for the period." }, { "code": "registry_rejected", "type": null, "when": "The ITA refuses the change." } ] } }, "Params_vg_economic_substance_period_change": { "type": "object", "properties": { "current_period_end": { "type": "string", "format": "date", "description": "Current financial year end as registered with the ITA.", "examples": [ "2026-12-31" ] }, "period_end": { "type": "string", "format": "date", "description": "Proposed new financial year end.", "examples": [ "2027-06-30" ] }, "effective_from_period": { "type": "string", "format": "date", "description": "First period to which the change applies." }, "reason": { "type": "string", "description": "Why the period changes, for example alignment with a parent's accounting year.", "examples": [ "Align with group accounting year" ] }, "approver": { "type": "string", "pattern": "^per_", "description": "Director or general partner's authorised individual approving the request." } }, "required": [ "current_period_end", "period_end", "reason", "approver" ], "description": "Asks the ITA, on VIRRGIN form T602, to change the financial period used for the entity's economic substance declarations." }, "Create_vg_economic_substance_period_change": { "type": "object", "properties": { "type": { "const": "vg.economic_substance_period.change" }, "params": { "$ref": "#/components/schemas/Params_vg_economic_substance_period_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request change of financial period for economic substance", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving the change of financial period", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Evidence supporting the change", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN / ITA receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "International Tax Authority via VIRRGIN", "form": "VIRRGIN form T602, request to change financial period", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": null, "when": "The entity is outside the economic substance regime." }, { "code": "declaration_outstanding", "type": null, "when": "A declaration for the current period is overdue; file it first." }, { "code": "period_length_invalid", "type": null, "when": "The new period_end gives a period the ITA does not accept." }, { "code": "ita_rejected", "type": null, "when": "The ITA rejects T602." } ] } }, "Params_vg_fatca_crs_enrol": { "type": "object", "properties": { "regimes": { "type": "string", "enum": [ "fatca", "crs" ], "description": "Regimes to enrol for.", "examples": [ "[\"fatca\",\"crs\"]" ] }, "became_financial_institution_date": { "type": "string", "format": "date", "description": "Date the entity became a BVI financial institution.", "examples": [ "2026-08-01" ] }, "fi_type": { "type": "string", "enum": [ "depository_institution", "custodial_institution", "investment_entity", "specified_insurance_company" ], "description": "Financial institution category under CRS Section VIII and the FATCA IGA.", "examples": [ "investment_entity" ] }, "crs_status": { "type": "string", "enum": [ "reporting_fi", "non_reporting_fi" ], "description": "Whether the institution is a reporting or a non-reporting financial institution under CRS.", "examples": [ "reporting_fi" ] }, "fatca_classification": { "type": "string", "description": "FATCA classification under the BVI-US Model 1 IGA, for example reporting Model 1 FFI, sponsored investment entity or trustee-documented trust.", "examples": [ "reporting_model_1_ffi" ] }, "giin": { "type": "string", "description": "Global Intermediary Identification Number from the IRS FATCA registration, where the institution has one.", "examples": [ "98Q96B.00000.LE.092" ] }, "sponsoring_entity": { "type": "object", "description": "{name, giin} of a sponsoring entity, if any.", "examples": [ "{}" ] }, "trustee_documented_trust": { "type": "boolean", "description": "True if this is a trustee-documented trust, which must also be registered with its trustee identified.", "examples": [ "false" ] }, "primary_user": { "type": "string", "pattern": "^per_", "description": "Principal point of contact (MLA s.28).", "examples": [ "per_6PuFin1a" ] }, "principal_point_of_contact_address": { "$ref": "#/components/schemas/Address", "description": "Address of the principal point of contact.", "examples": [ "{\"line1\":\"Craigmuir Chambers\",\"city\":\"Road Town\",\"region\":\"Tortola\",\"postal_code\":\"VG1110\",\"country\":\"VG\"}" ] }, "secondary_users": { "type": "array", "items": {}, "description": "Service providers the Primary User should add as Secondary Users.", "examples": [ "[{\"organisation\":\"Entiva\",\"email\":\"bvifars@partner.example\"}]" ] } }, "required": [ "regimes", "became_financial_institution_date", "fi_type", "crs_status", "primary_user", "principal_point_of_contact_address" ], "description": "Registers a BVI financial institution with the International Tax Authority on the BVI Financial Account Reporting System, for US FATCA and the Common Reporting Standard. Every BVI financial institution, reporting or non-reporting, must." }, "Create_vg_fatca_crs_enrol": { "type": "object", "properties": { "type": { "const": "vg.fatca_crs.enrol" }, "params": { "$ref": "#/components/schemas/Params_vg_fatca_crs_enrol" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Enrol a BVI financial institution on BVIFARS for FATCA and CRS", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "enrolment_data_sheet", "title": "BVIFARS enrolment data sheet", "source": "generated", "required": true }, { "key": "fi_classification_memo", "title": "FATCA and CRS classification memo", "source": "generated", "required": true }, { "key": "board_resolution_appointing_agent", "title": "Board resolution appointing the Primary User and Entiva as agent under MLA s.31", "source": "generated", "required": true }, { "key": "primary_user_authorisation_letter", "title": "Director's letter authorising the Primary User", "source": "generated", "required": false }, { "key": "bvifars_enrolment_confirmation", "title": "BVIFARS enrolment confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution_appointing_agent", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "primary_user_authorisation_letter", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "enrolment_data_sheet", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI International Tax Authority", "form": "BVIFARS sign-up and financial institution enrolment for FATCA and CRS", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "primary_user_is_agent", "type": null, "when": "The proposed Primary User is an Entiva, partner or other s.31 agent user." }, { "code": "not_a_financial_institution", "type": null, "when": "The classification memo concludes the entity is not a BVI financial institution, so no enrolment is needed." }, { "code": "giin_invalid", "type": null, "when": "The GIIN fails format validation." }, { "code": "already_enrolled", "type": null, "when": "The entity already has a BVIFARS enrolment." } ] } }, "Params_vg_fatca_crs_file": { "type": "object", "properties": { "reporting_year": { "type": "integer", "description": "Calendar year reported.", "examples": [ "2024" ] }, "regimes": { "type": "string", "enum": [ "fatca", "crs" ], "description": "Reports to file.", "examples": [ "[\"crs\"]" ] }, "report_kind": { "type": "string", "enum": [ "new", "nil", "correction", "deletion" ], "description": "new: first filing for the year. nil: no reportable accounts (mandatory under CRS law s.29). correction or deletion: amends records already filed.", "examples": [ "correction" ] }, "crs_xml_schema_version": { "type": "string", "enum": [ "v2_0", "v3_0" ], "description": "CRS schema version. v3.0 is mandatory for every CRS submission from 1 January 2027.", "examples": [ "v2_0" ] }, "account_data": { "type": "string", "pattern": "^doc_", "description": "Reportable account data.", "examples": [ "doc_3AccD24x" ] }, "reportable_accounts_count": { "type": "integer", "description": "Number of reportable accounts, for reconciliation.", "examples": [ "3" ] }, "corrected_message_refs": { "type": "array", "items": {}, "description": "MessageRefId and DocRefId values of the records being corrected or deleted.", "examples": [ "[\"VG2024BVI-0001-CRS-001\"]" ] }, "giin": { "type": "string", "description": "GIIN for FATCA reports.", "examples": [ "98Q96B.00000.LE.092" ] } }, "required": [ "reporting_year", "regimes", "report_kind" ], "description": "Files a BVI reporting financial institution's annual FATCA and CRS XML reports on BVIFARS by 31 May for the previous calendar year. A nil return is mandatory where there are no reportable accounts (CRS law s.29)." }, "Create_vg_fatca_crs_file": { "type": "object", "properties": { "type": { "const": "vg.fatca_crs.file" }, "params": { "$ref": "#/components/schemas/Params_vg_fatca_crs_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual FATCA and CRS reports on BVIFARS, including nil returns and corrections", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "account_data", "title": "Reportable account data", "source": "uploaded", "required": false }, { "key": "crs_xml", "title": "CRS XML report", "source": "generated", "required": false }, { "key": "fatca_xml", "title": "FATCA XML report", "source": "generated", "required": false }, { "key": "validation_report", "title": "Pre-submission validation report", "source": "generated", "required": true }, { "key": "data_approval", "title": "Institution's approval of the report", "source": "generated", "required": true }, { "key": "ita_submission_receipt", "title": "BVIFARS submission receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "data_approval", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "crs_xml", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fatca_xml", "signer_role": "other", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI International Tax Authority", "form": "FATCA XML and CRS XML reports, or a nil return where there are no reportable accounts", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "schema_version_not_accepted", "type": null, "when": "A CRS report in v2.0 is submitted on or after 1 January 2027." }, { "code": "not_enrolled", "type": null, "when": "The entity has no BVIFARS enrolment." }, { "code": "secondary_user_access_missing", "type": null, "when": "The Primary User has not granted Entiva Secondary User access." }, { "code": "validation_failed", "type": null, "when": "The XML fails schema or business-rule validation." }, { "code": "rejected_by_bvifars", "type": null, "when": "BVIFARS rejects the file." } ] } }, "Params_vg_fatca_crs_enrolment_change": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "replace_primary_user", "update_primary_user_details", "add_secondary_user", "remove_secondary_user", "update_fi_details", "change_classification" ], "description": "What changes.", "examples": [ "add_secondary_user" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change takes effect.", "examples": [ "2026-10-20" ] }, "primary_user": { "type": "string", "pattern": "^per_", "description": "Required for replace_primary_user.", "examples": [ "per_2PuNew1b" ] }, "secondary_user": { "type": "object", "description": "{name, email, organisation, role}.", "examples": [ "{\"name\":\"Entiva Tax Desk\",\"email\":\"bvifars@partner.example\",\"organisation\":\"Entiva\"}" ] }, "fi_details": { "type": "object", "description": "Changed institution details.", "examples": [ "{}" ] }, "reason": { "type": "string", "description": "Reason for the change, for example the Primary User left the institution.", "examples": [ "Appoint Entiva as reporting agent" ] } }, "required": [ "change_type", "effective_date" ], "description": "Keeps a BVI financial institution's BVIFARS enrolment current. The action changes or updates the Primary User (the principal point of contact under MLA s.28), adds or removes Secondary Users such as Entiva or a fund administrator acting." }, "Create_vg_fatca_crs_enrolment_change": { "type": "object", "properties": { "type": { "const": "vg.fatca_crs_enrolment.change" }, "params": { "$ref": "#/components/schemas/Params_vg_fatca_crs_enrolment_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a BVIFARS enrolment: Primary User, Secondary Users and institution details", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_instruction_sheet", "title": "Change instruction sheet for the Primary User", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": false }, { "key": "bvifars_change_confirmation", "title": "BVIFARS confirmation or screenshot of the change", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "change_instruction_sheet", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI International Tax Authority", "form": "Enrolment change in BVIFARS", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_enrolled", "type": null, "when": "The entity has no BVIFARS enrolment." }, { "code": "primary_user_is_agent", "type": null, "when": "new_primary_user is an s.31 agent or service-provider user." }, { "code": "new_primary_user_required", "type": null, "when": "change_type is replace_primary_user without new_primary_user." } ] } }, "Params_vg_fatca_crs_enrolment_deactivate": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "no_longer_financial_institution", "no_longer_in_existence", "no_longer_bvi_resident" ], "description": "Ground for deregistration.", "examples": [ "no_longer_in_existence" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the entity ceased to be a BVI financial institution.", "examples": [ "2026-09-30" ] }, "explanation": { "type": "string", "description": "Clear explanation of the change in circumstances, which the ITA requires.", "examples": [ "Fund fully redeemed on 30 June 2026; voluntary liquidation completed 30 September 2026." ] }, "final_reporting_year": { "type": "integer", "description": "Last calendar year for which FATCA and CRS reports are due.", "examples": [ "2026" ] }, "all_reports_filed": { "type": "boolean", "description": "Confirms that all reporting for years before cessation has been filed.", "examples": [ "true" ] }, "linked_closure_action_id": { "type": "string", "description": "act_ id of the related liquidation, continuation-out or strike-off action.", "examples": [ "act_2VolLiq26" ] } }, "required": [ "reason", "effective_date", "explanation", "final_reporting_year", "all_reports_filed" ], "description": "Submits a deactivation notification on BVIFARS for an entity that is no longer a BVI financial institution, no longer exists or is no longer resident in the BVI. All reporting for earlier years must already be filed." }, "Create_vg_fatca_crs_enrolment_deactivate": { "type": "object", "properties": { "type": { "const": "vg.fatca_crs_enrolment.deactivate" }, "params": { "$ref": "#/components/schemas/Params_vg_fatca_crs_enrolment_deactivate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a financial institution from BVIFARS", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "deactivation_notification", "title": "BVIFARS deactivation notification data", "source": "generated", "required": true }, { "key": "evidence_of_change", "title": "Evidence of cessation", "source": "uploaded", "required": true }, { "key": "ita_deactivation_decision", "title": "ITA deactivation approval", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "deactivation_notification", "signer_role": "authorised_representative", "method": "registry_authentication", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI International Tax Authority", "form": "Deactivation Notification on BVIFARS", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "outstanding_reports", "type": null, "when": "Reporting for an earlier year has not been filed." }, { "code": "struck_off_not_dissolved", "type": null, "when": "The entity is struck off but not yet dissolved and is still a financial institution." }, { "code": "outstanding_fee", "type": null, "when": "An annual BVIFARS fee is unpaid." }, { "code": "deactivation_refused", "type": null, "when": "The ITA declines deactivation after its review." } ] } }, "Params_vg_financial_statements_file": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Year end covered.", "examples": [ "2026-06-30" ] }, "fund_category": { "type": "string", "enum": [ "private_fund", "professional_fund" ], "description": "Regulatory category of the fund." }, "audited_financial_statements": { "type": "string", "pattern": "^doc_", "description": "Statements prepared under permitted accounting standards and audited under permitted auditing standards (reg 10-)." }, "auditor": { "type": "string", "pattern": "^ent_", "description": "Auditor." }, "accounting_standard": { "type": "string", "description": "Accounting standard used, for example IFRS." }, "auditing_standard": { "type": "string", "description": "Auditing standard used, for example ISA." }, "audit_exemption": { "type": "string", "pattern": "^doc_", "description": "FSC exemption from appointing an auditor, if any." }, "extension": { "type": "string", "description": "Id of an approved vg.financial_statements_extension.request action or FSC letter reference." }, "authorised_representative": { "type": "string", "pattern": "^ent_", "description": "BVI authorised representative who submits." } }, "required": [ "financial_year_end", "fund_category", "audited_financial_statements", "auditor", "accounting_standard", "auditing_standard", "authorised_representative" ], "description": "Files the audited financial statements of a private or professional fund with the FSC through its authorised representative, within 6 months after year end." }, "Create_vg_financial_statements_file": { "type": "object", "properties": { "type": { "const": "vg.financial_statements.file" }, "params": { "$ref": "#/components/schemas/Params_vg_financial_statements_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File audited financial statements of a private or professional fund with the FSC", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Audited financial statements", "source": "uploaded", "required": true }, { "key": "auditor_report", "title": "Auditor's report", "source": "uploaded", "required": true }, { "key": "audit_exemption", "title": "FSC audit exemption", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Directors' approval of the financial statements", "source": "generated", "required": true }, { "key": "fsc_submission_cover", "title": "Submission cover letter to the FSC", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "FSC acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "auditor", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "auditor_report", "signer_role": "auditor", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fsc_submission_cover", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Audited financial statements", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fund_not_regulated", "type": null, "when": "Entity is not a private or professional fund." }, { "code": "auditor_required", "type": null, "when": "No auditor and no FSC exemption supplied." }, { "code": "deadline_passed", "type": null, "when": "Filing is past 6 months and no extension reference is given." }, { "code": "standards_not_permitted", "type": null, "when": "Accounting or auditing standard is not on the permitted list." } ] } }, "Params_vg_financial_statements_extension_request": { "type": "object", "properties": { "financial_year_end": { "type": "string", "format": "date", "description": "Year end concerned." }, "requested_filing_date": { "type": "string", "format": "date", "description": "New date; at most 15 months after year end." }, "reason": { "type": "string", "description": "Reason for the delay." }, "exceptional_circumstances": { "type": "boolean", "description": "True when the date is more than 9 months after year end; reg 10 then applies." }, "supporting_evidence": { "type": "array", "items": {}, "description": "document_refs, for example auditor letter." } }, "required": [ "financial_year_end", "requested_filing_date", "reason", "exceptional_circumstances" ], "description": "Asks the FSC in writing to extend the 6-month deadline for audited fund financial statements, up to 15 months after year end; beyond 9 months only in exceptional circumstances." }, "Create_vg_financial_statements_extension_request": { "type": "object", "properties": { "type": { "const": "vg.financial_statements_extension.request" }, "params": { "$ref": "#/components/schemas/Params_vg_financial_statements_extension_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request an FSC extension to file fund financial statements", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_request_letter", "title": "Extension request letter", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Supporting evidence", "source": "uploaded", "required": false }, { "key": "fsc_extension_letter", "title": "FSC decision letter", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "extension_request_letter", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Written request for extension", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "extension_exceeds_limit", "type": null, "when": "Requested date is beyond 15 months after year end." }, { "code": "exceptional_circumstances_required", "type": null, "when": "Date is beyond 9 months and exceptional_circumstances is false." }, { "code": "deadline_passed", "type": null, "when": "The 6-month deadline has already passed." } ] } }, "Params_vg_foreign_company_annual_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year whose 31 March due date this payment covers.", "examples": [ "2027" ] }, "pay_on": { "type": "string", "format": "date", "description": "Date on which the partner should pay.", "examples": [ "2027-03-17" ] }, "include_arrears": { "type": "boolean", "description": "Also pay earlier unpaid annual fees and penalties.", "examples": [ "true" ] } }, "required": [ "fee_year" ], "description": "A foreign company registered to carry on business in the BVI pays an annual fee of US$550 on 31 March each year, starting the year after it registers (BCA s.236 as amended by SI 2022 No. 89; Schedule 1 Part III para 4). The penalty is 10%." }, "Create_vg_foreign_company_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee for a registered foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_fee_statement", "title": "Entiva statement of the fee, due date, any penalty and any arrears", "source": "generated", "required": true }, { "key": "registry_payment_confirmation", "title": "VIRRGIN payment confirmation for the foreign company annual fee", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "registry_payment_confirmation", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Annual fee payment for a foreign company", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered foreign company." }, { "code": "fee_not_yet_due", "type": null, "when": "fee_year is the year of registration or earlier." }, { "code": "already_paid", "type": null, "when": "The fee for fee_year is already recorded as paid." }, { "code": "not_registered_agent", "type": null, "when": "Entiva is not the registered agent, so it cannot pay." }, { "code": "foreign_company_removed", "type": null, "when": "The company has been removed from the Register of Foreign Companies." }, { "code": "spending_limit_exceeded", "type": null, "when": "The quote is above the agent mandate's spending limit." }, { "code": "payment_failed", "type": null, "when": "Entiva could not collect the government fee." } ] } }, "Params_vg_foreign_company_annual_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Must be foreign_company, meaning a foreign company registered under BCA Part XI.", "examples": [ "foreign_company" ] }, "return_year": { "type": "integer", "description": "Calendar year the return covers.", "examples": [ "2026" ] }, "made_up_to_date": { "type": "string", "format": "date", "description": "Defaults to 31 December of return_year.", "examples": [ "2026-12-31" ] }, "corporate_name": { "type": "string", "description": "Corporate name as registered in the country of incorporation.", "examples": [ "Harbour Logistics Pte. Ltd." ] }, "alternate_name": { "type": "string", "description": "The alternate name, if the company is registered under one (s.190-).", "examples": [ "Harbour Logistics (BVI Branch)" ] }, "country_of_incorporation": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the home jurisdiction.", "examples": [ "SG" ] }, "home_registered_office": { "$ref": "#/components/schemas/Address", "description": "Address of the registered office in the country of incorporation (s.186, s.188).", "examples": [ "{\"line1\": \"1 Raffles Place\", \"city\": \"Singapore\", \"postal_code\": \"048616\", \"country\": \"SG\"}" ] }, "directors": { "type": "array", "items": {}, "description": "person_ref ids of the directors on the made-up-to date, each with full name, nationality, address and date of appointment, as filed under s.186.", "examples": [ "[\"per_Tz4kQ1aV\"]" ] }, "members": { "type": "array", "items": {}, "description": "Members on the made-up-to date, each with full name, nationality and address (s.186).", "examples": [ "[{\"name\": \"Harbour Holdings Ltd\", \"nationality\": \"SG\", \"address\": \"1 Raffles Place, Singapore\"}]" ] }, "still_carrying_on_business_in_bvi": { "type": "boolean", "description": "Confirms the company still carries on business in the BVI.", "examples": [ "true" ] }, "certifier": { "type": "string", "enum": [ "registered_agent", "director" ], "description": "Who certifies the return as correct (s.192).", "examples": [ "registered_agent" ] }, "certifying_director": { "type": "string", "pattern": "^per_", "description": "Required when certifier is director.", "examples": [ "per_Tz4kQ1aV" ] } }, "required": [ "entity_type", "return_year", "corporate_name", "country_of_incorporation", "home_registered_office", "directors", "members", "still_carrying_on_business_in_bvi", "certifier" ], "description": "A foreign company registered under BCA Part XI files an annual return by 31 March each year, made up to 31 December of the previous year. The return is in the approved form and certified as correct by a director of the foreign company or." }, "Create_vg_foreign_company_annual_return_file": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual return of a registered foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_company_annual_return", "title": "Annual return of a foreign company", "source": "generated", "required": true }, { "key": "home_registry_extract", "title": "Current extract or good standing certificate from the home registry", "source": "uploaded", "required": false }, { "key": "filing_record", "title": "VIRRGIN filing record and fee receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "foreign_company_annual_return", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "foreign_company_annual_return", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "foreign_company_annual_return", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Annual return of a foreign company in the approved form", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a foreign company registered under BCA Part XI." }, { "code": "made_up_to_date_invalid", "type": null, "when": "made_up_to_date is not 31 December, or the year has not ended." }, { "code": "change_of_particulars_outstanding", "type": null, "when": "A change in name, domicile, constitution, directors, members, home registered office or registered agent was not notified under s.188." }, { "code": "business_ceased", "type": null, "when": "still_carrying_on_business_in_bvi is false." }, { "code": "certifying_director_not_in_office", "type": null, "when": "certifying_director was not a director on the made-up-to date." }, { "code": "entity_removed_from_register", "type": null, "when": "The company has already been removed under s.193A." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the filing." } ] } }, "Params_vg_foreign_company_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Year in which the fee falls due.", "examples": [ "2026" ] }, "expected_amount": { "$ref": "#/components/schemas/Money", "description": "Optional guard on the base fee before late charges.", "examples": [ "{\"amount\":550,\"currency\":\"USD\"}" ] }, "accept_late_penalty": { "type": "boolean", "description": "Must be true when overdue: 10% if paid by 31 May, 50% from 1 June." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Person instructing the payment." } }, "required": [ "fee_year" ], "description": "Pays the BCA s.236 annual fee of US$550 for a foreign company registered to carry on business in the BVI, due 31 March each year, via the registered agent's VIRRGIN account." }, "Create_vg_foreign_company_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee for a registered foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "fee_payment_instruction", "title": "Foreign company annual fee payment instruction", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "fee_payment_instruction", "signer_role": "registered_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, Financial Services Commission", "form": "Annual fee payment on VIRRGIN", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_fee_due", "type": null, "when": "Nothing outstanding for fee_year." }, { "code": "fee_mismatch", "type": null, "when": "expected_amount differs from the computed base fee." }, { "code": "late_penalty_not_accepted", "type": null, "when": "Overdue and accept_late_penalty is not true." }, { "code": "entity_removed", "type": null, "when": "The company has already been removed from the Register of Foreign Companies; re-registration is needed." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses the action." }, { "code": "registry_unavailable", "type": null, "when": "VIRRGIN is unavailable; the partner retries." } ] } }, "Params_vg_foreign_company_registered_agent_appoint": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "previous_agent_resigning", "previous_agent_no_longer_eligible", "no_agent_on_register", "other" ], "description": "Why a new agent is needed. previous_agent_resigning: the agent gave 60 days' notice under s.189A. previous_agent_no_longer_eligible: the agent lost its licence.", "examples": [ "previous_agent_resigning" ] }, "previous_registered_agent": { "type": "object", "description": "The outgoing agent, as {name, fsc_licence_number, notice_date, ceases_on}.", "examples": [ "{\"name\": \"Outgoing Agent (BVI) Limited\", \"notice_date\": \"2026-09-01\", \"ceases_on\": \"2026-11-02\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the company's own authorisation makes the new agent effective.", "examples": [ "2026-10-20" ] }, "authorising_body": { "type": "string", "enum": [ "board", "sole_director", "other_governing_body" ], "description": "The body of the foreign company that appoints the agent, under its constitution and home law.", "examples": [ "board" ] }, "bvi_principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "The company's principal place of business in the BVI, if any.", "examples": [ "{\"line1\": \"Wickhams Cay II\", \"city\": \"Road Town\", \"region\": \"Tortola\", \"country\": \"VG\"}" ] } }, "required": [ "reason", "authorising_body" ], "description": "A foreign company registered to carry on business in the BVI must have a BVI registered agent at all times. That agent needs a Company Management Act or Banks and Trust Companies Act licence and FSC approval to provide registered agent." }, "Create_vg_foreign_company_registered_agent_appoint": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_registered_agent.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_registered_agent_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a new registered agent for a registered foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_change_in_particulars", "title": "Notice of change in particulars, approved form, endorsed by the new agent with its agreement to act.", "source": "generated", "required": true }, { "key": "authorising_resolution", "title": "Resolution of the foreign company's board or equivalent body appointing the new agent, in the form.", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation or registration from the home registry", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Current constitution.", "source": "uploaded", "required": true }, { "key": "register_of_directors_and_members", "title": "Current list of directors and members", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart down to natural persons", "source": "uploaded", "required": true }, { "key": "home_registry_good_standing", "title": "Certificate of good standing or registry extract from the home registry", "source": "uploaded", "required": false }, { "key": "previous_agent_notice", "title": "The outgoing agent's resignation notice (s.189A) or ineligibility notice (s.189B)", "source": "uploaded", "required": false }, { "key": "registered_notice", "title": "Notice of change in particulars as registered by the Registrar", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "authorising_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_change_in_particulars", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_change_in_particulars", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of change in particulars of a foreign company: registered agent", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is a BVI company or LP." }, { "code": "foreign_company_removed", "type": null, "when": "The company has already been removed from the Register of Foreign Companies." }, { "code": "late_filing_penalty_applies", "type": null, "when": "Returned as a warning when change_date is more than 30 days ago." }, { "code": "cdd_not_accepted", "type": null, "when": "The Entiva compliance team declined the client, so nothing is filed." }, { "code": "outstanding_registry_fees", "type": null, "when": "The company owes annual fees or penalties." } ] } }, "Params_vg_fund_audit_exemption_apply": { "type": "object", "properties": { "exemption_type": { "type": "string", "enum": [ "fund_auditor_exemption", "portfolio_audit_exemption", "portfolio_statements_exemption" ], "description": "fund_auditor_exemption: reg 10. portfolio_audit_exemption: SPC Regulations reg 6. portfolio_statements_exemption: reg 6.", "examples": [ "fund_auditor_exemption" ] }, "fund_type": { "type": "string", "enum": [ "private_fund", "professional_fund", "public_fund", "incubator_fund", "approved_fund" ], "description": "SIBA recognition category.", "examples": [ "private_fund" ] }, "fsc_recognition_number": { "type": "string", "description": "FSC recognition or registration number.", "examples": [ "SIBA/PF/24/0456" ] }, "portfolios": { "type": "array", "items": {}, "description": "Segregated portfolios to exempt.", "examples": [ "[\"SP-C\"]" ] }, "grounds": { "type": "string", "description": "Why the exemption is justified, for example the investor base, size, or a dormant portfolio.", "examples": [ "Single-investor private fund wholly owned by a family office that receives monthly administrator reports." ] }, "financial_years_covered": { "type": "array", "items": {}, "description": "Financial years for which the exemption is sought.", "examples": [ "[\"2026-12-31\"]" ] } }, "required": [ "exemption_type", "fund_type", "fsc_recognition_number", "grounds" ], "description": "Applies to the Financial Services Commission for one of three exemptions. A private or professional fund can be exempted from having an auditor (Mutual Funds Regulations reg 10)." }, "Create_vg_fund_audit_exemption_apply": { "type": "object", "properties": { "type": { "const": "vg.fund_audit_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_vg_fund_audit_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the FSC to exempt a fund from appointing an auditor, or a segregated portfolio from audit", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exemption_application", "title": "Exemption application", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' or general partner's resolution approving the application", "source": "generated", "required": true }, { "key": "supporting_evidence", "title": "Supporting evidence", "source": "uploaded", "required": false }, { "key": "fsc_exemption_letter", "title": "FSC exemption", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "exemption_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Written application under Mutual Funds Regulations reg 10", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "portfolio_ids_required", "type": null, "when": "A portfolio exemption is requested without portfolio_ids." }, { "code": "not_a_segregated_portfolio_company", "type": null, "when": "A portfolio exemption is requested for an entity that is not a mutual fund SPC." }, { "code": "exemption_refused", "type": null, "when": "The FSC refuses the application." } ] } }, "Params_vg_fund_financial_statements_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "description": "Legal form of the fund.", "examples": [ "bc_ltd_shares" ] }, "fund_type": { "type": "string", "enum": [ "private_fund", "professional_fund" ], "description": "SIBA recognition category. reg 10 applies to private and professional funds only.", "examples": [ "professional_fund" ] }, "fsc_recognition_number": { "type": "string", "description": "FSC certificate of recognition number.", "examples": [ "SIBA/F/21/1234" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end covered by the statements.", "examples": [ "2026-06-30" ] }, "accounting_standard": { "type": "string", "enum": [ "ifrs", "uk_gaap", "us_gaap", "canadian_gaap", "equivalent_recognised_gaap" ], "description": "Framework used (reg 10, referring to reg 17-, or an equivalent recognised framework).", "examples": [ "ifrs" ] }, "auditing_standard": { "type": "string", "enum": [ "us_gaas", "isa_uk", "isa", "hk_standards_on_auditing", "canadian_auditing_standards", "other_fsc_approved" ], "description": "Auditing standard (reg 10).", "examples": [ "isa" ] }, "auditor": { "type": "object", "description": "{firm_name, address, engagement_partner, appointed_date}.", "examples": [ "{\"firm_name\":\"Example Audit LLP\",\"address\":\"1 Harbour Road, Road Town, Tortola\",\"engagement_partner\":\"J. Example\"}" ] }, "audit_report_date": { "type": "string", "format": "date", "description": "Date of the auditor's report.", "examples": [ "2026-10-10" ] }, "auditor_exemption_reference": { "type": "string", "description": "FSC reference for an exemption from appointing an auditor (reg 10).", "examples": [ "FSC/EX/2025/0042" ] }, "extension_approved_until": { "type": "string", "format": "date", "description": "Deadline as extended in writing by the FSC (reg 10).", "examples": [ "2027-03-31" ] }, "portfolio_presentation": { "type": "string", "enum": [ "separate_per_portfolio", "consolidated_identifying_portfolios" ], "description": "For a mutual fund SPC: separate audits per portfolio, or one consolidated audit identifying each portfolio (SPC Regulations reg 6).", "examples": [ "consolidated_identifying_portfolios" ] }, "authorised_representative": { "type": "object", "description": "{name, fsc_certificate_number} of the fund's FSC-certified authorised representative, who submits.", "examples": [ "{\"name\":\"Example AR Services (BVI) Ltd\",\"fsc_certificate_number\":\"AR/2019/015\"}" ] } }, "required": [ "entity_type", "fund_type", "fsc_recognition_number", "financial_year_end", "accounting_standard", "authorised_representative" ], "description": "Files a BVI private or professional fund's audited financial statements with the Financial Services Commission under Mutual Funds Regulations reg 10. The fund prepares statements under IFRS, UK, US or Canadian GAAP, or an equivalent." }, "Create_vg_fund_financial_statements_file": { "type": "object", "properties": { "type": { "const": "vg.fund_financial_statements.file" }, "params": { "$ref": "#/components/schemas/Params_vg_fund_financial_statements_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a private or professional fund's audited financial statements with the FSC", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "audited_financial_statements", "title": "Audited financial statements with the auditor's report", "source": "uploaded", "required": true }, { "key": "auditor_certifications", "title": "Auditor's certifications to the FSC", "source": "uploaded", "required": false }, { "key": "fs_approval_resolution", "title": "Directors' or general partner's approval of the financial statements", "source": "generated", "required": true }, { "key": "extension_approval_letter", "title": "FSC extension approval", "source": "uploaded", "required": false }, { "key": "auditor_exemption_letter", "title": "FSC auditor exemption", "source": "uploaded", "required": false }, { "key": "fsc_submission_cover", "title": "Authorised representative's submission cover", "source": "generated", "required": true }, { "key": "fsc_acknowledgement", "title": "FSC acknowledgement of receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "fs_approval_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fs_approval_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "audited_financial_statements", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fsc_submission_cover", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Audited financial statements under Mutual Funds Regulations reg 10", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fund_not_recognised", "type": null, "when": "The entity has no recorded private or professional fund recognition." }, { "code": "auditor_required", "type": null, "when": "No auditor is given and there is no FSC exemption (reg 10)." }, { "code": "standard_not_permitted", "type": null, "when": "The accounting or auditing standard is outside reg 10 and reg 10, and there is no FSC approval." }, { "code": "deadline_passed", "type": null, "when": "Filing after the 6-month deadline without an approved extension." }, { "code": "statements_not_approved", "type": null, "when": "fs_approval_resolution has not been signed." } ] } }, "Params_vg_fund_financial_statements_deadline_extend": { "type": "object", "properties": { "fund_type": { "type": "string", "enum": [ "private_fund", "professional_fund" ], "description": "SIBA recognition category.", "examples": [ "professional_fund" ] }, "fsc_recognition_number": { "type": "string", "description": "FSC certificate of recognition number.", "examples": [ "SIBA/F/21/1234" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end of the statements concerned.", "examples": [ "2026-06-30" ] }, "requested_deadline": { "type": "string", "format": "date", "description": "Requested filing date.", "examples": [ "2027-03-31" ] }, "reason": { "type": "string", "description": "Why the statements cannot be filed within 6 months, for example a delayed audit of an underlying investment.", "examples": [ "Audited accounts of the master fund will not be available until February 2027." ] }, "exceptional_circumstances": { "type": "string", "description": "Required when requested_deadline is more than 9 months after financial_year_end (reg 10).", "examples": [ "" ] }, "previous_extensions": { "type": "array", "items": {}, "description": "Earlier FSC extensions for this year: {approved_until, fsc_reference}.", "examples": [ "[]" ] } }, "required": [ "fund_type", "fsc_recognition_number", "financial_year_end", "requested_deadline", "reason" ], "description": "Applies in writing to the Financial Services Commission to extend the 6-month deadline for filing a private or professional fund's audited financial statements. The FSC may approve an extended period of up to 15 months after the year end." }, "Create_vg_fund_financial_statements_deadline_extend": { "type": "object", "properties": { "type": { "const": "vg.fund_financial_statements_deadline.extend" }, "params": { "$ref": "#/components/schemas/Params_vg_fund_financial_statements_deadline_extend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Ask the FSC to extend a fund's financial statements deadline", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "segregated_portfolio_company", "mutual_fund_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_application", "title": "Extension application letter", "source": "generated", "required": true }, { "key": "auditor_status_letter", "title": "Auditor's status letter", "source": "uploaded", "required": false }, { "key": "board_authorisation", "title": "Directors' or general partner's authorisation", "source": "generated", "required": true }, { "key": "fsc_extension_approval", "title": "FSC written approval", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_authorisation", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "extension_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Written application for an extension under Mutual Funds Regulations reg 10", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "extension_exceeds_maximum", "type": null, "when": "requested_deadline is more than 15 months after financial_year_end (reg 10)." }, { "code": "exceptional_circumstances_required", "type": null, "when": "requested_deadline is more than 9 months after financial_year_end and exceptional_circumstances is empty (reg 10)." }, { "code": "original_deadline_passed", "type": null, "when": "The 6-month deadline has already passed." }, { "code": "extension_refused", "type": null, "when": "The FSC refuses the application." } ] } }, "Params_vg_good_standing_certificate_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "quantity": { "type": "integer", "description": "Number of certificates.", "examples": [ "1" ] }, "physical_copy": { "type": "boolean", "description": "Also obtain a physical certificate.", "examples": [ "false" ] }, "apostille": { "type": "boolean", "description": "If true, Entiva creates the BVI apostille action once the certificate issues.", "examples": [ "true" ] }, "purpose": { "type": "string", "description": "Free text, for example bank account opening or a closing.", "examples": [ "Bank account opening in Singapore" ] }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Courier address for physical or apostilled documents.", "examples": [ "{\"line1\": \"8 Marina View\", \"city\": \"Singapore\", \"postal_code\": \"018960\", \"country\": \"SG\"}" ] } }, "required": [ "entity_type" ], "description": "Obtains the Registrar's certificate of good standing for a BVI company or limited partnership. The Registrar issues it only if all of these hold: - the entity is on the Register - all fees and penalties are paid - its registers and its." }, "Create_vg_good_standing_certificate_request": { "type": "object", "properties": { "type": { "const": "vg.good_standing_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_vg_good_standing_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request a certificate of good standing", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "good_standing_request", "title": "Certificate of good standing request", "source": "generated", "required": true }, { "key": "certificate_of_good_standing", "title": "Certificate of good standing", "source": "registry_issued", "required": true }, { "key": "physical_certificate", "title": "Physical certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "good_standing_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Request for a certificate of good standing", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "fees_or_penalties_outstanding", "type": null, "when": "Annual fees or penalties are unpaid (s.235; LPA s.112)." }, { "code": "register_of_members_not_filed", "type": null, "when": "A company's register of members, or a change to it, was due but not filed (s.235)." }, { "code": "register_of_directors_not_filed", "type": null, "when": "A company's register of directors, or a change to it, was due but not filed (s.235)." }, { "code": "partner_registers_not_filed", "type": null, "when": "An LP's registers of general and limited partners were due but not filed (LPA s.112)." }, { "code": "beneficial_ownership_not_filed", "type": null, "when": "Beneficial ownership information was due but not filed (s.235; LPA s.112)." }, { "code": "annual_return_default_notified", "type": null, "when": "The registered agent has notified the Registrar that the entity failed to lodge its annual financial return (s.98A; LPA s.54A)." }, { "code": "entity_struck_off", "type": null, "when": "The entity is not on the Register." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is a foreign company or a general partnership." } ] } }, "Params_vg_insurer_spc_annual_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year in which the fee falls due.", "examples": [ "2027" ] }, "licence_category": { "type": "string", "enum": [ "category_c", "other_than_category_c" ], "description": "Insurance Act licence category of the BVI insurer.", "examples": [ "category_c" ] }, "segregated_portfolios_at_31_december": { "type": "integer", "description": "Number of segregated portfolios in existence on 31 December of the previous year.", "examples": [ "4" ] }, "gross_written_premium": { "$ref": "#/components/schemas/Money", "description": "Total gross written premium used for the company element of the fee under the Financial Services Regulations.", "examples": [ "{\"amount\":12500000,\"currency\":\"USD\"}" ] }, "company_fee_computed": { "$ref": "#/components/schemas/Money", "description": "Company element computed by the insurance manager under the Financial Services Regulations, for non-Category C insurers.", "examples": [ "{\"amount\":6000,\"currency\":\"USD\"}" ] }, "insurance_manager": { "type": "string", "description": "Name of the insurance manager, who may pay the fee.", "examples": [ "Example Insurance Managers (BVI) Ltd" ] }, "incorporation_or_registration_date": { "type": "string", "format": "date", "description": "Date of incorporation or registration as a BVI insurer SPC.", "examples": [ "2022-03-01" ] } }, "required": [ "fee_year", "licence_category", "segregated_portfolios_at_31_december", "insurance_manager", "incorporation_or_registration_date" ], "description": "Pays the Financial Services Commission's annual fee for a BVI insurer SPC under the Segregated Portfolio Companies Regulations, reg 15 and Schedule Part III. It is due on or before 28 February each year, starting the year after." }, "Create_vg_insurer_spc_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.insurer_spc_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_insurer_spc_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the FSC annual fee for a BVI insurer segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "portfolio_schedule", "title": "Schedule of segregated portfolios at 31 December", "source": "generated", "required": true }, { "key": "gwp_computation", "title": "Gross written premium fee computation", "source": "uploaded", "required": false }, { "key": "fsc_payment_receipt", "title": "FSC payment confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "portfolio_schedule", "signer_role": "registered_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Annual fee payment under SPC", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "gross_written_premium_required", "type": null, "when": "licence_category is other_than_category_c and neither gross_written_premium nor company_fee_computed is given." }, { "code": "fee_not_yet_due", "type": null, "when": "fee_year equals the year of incorporation or registration." }, { "code": "entity_type_mismatch", "type": null, "when": "The entity is not recorded as a BVI insurer SPC." }, { "code": "already_paid", "type": null, "when": "A completed payment exists for this fee_year." } ] } }, "Params_vg_limited_partnership_annual_fee_pay": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type.", "examples": [ "lp" ] }, "fee_year": { "type": "integer", "description": "Year in which the fee is paid.", "examples": [ "2027" ] }, "pay_on": { "type": "string", "format": "date", "description": "Date on which the partner should pay.", "examples": [ "2027-04-16" ] }, "include_arrears": { "type": "boolean", "description": "Also pay earlier unpaid annual fees and penalties.", "examples": [ "true" ] } }, "required": [ "entity_type", "fee_year" ], "description": "Every limited partnership on the BVI Register of Limited Partnerships on 31 December pays an annual fee the following year. The fee is US$750 if paid by 30 April, then rises to US$850, US$1,000 and US$1,150 after that (Financial Services." }, "Create_vg_limited_partnership_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee for a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_fee_statement", "title": "Entiva statement of the fee tier, due date and any arrears", "source": "generated", "required": true }, { "key": "registry_payment_confirmation", "title": "VIRRGIN payment confirmation for the LP annual fee", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "registry_payment_confirmation", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships, BVI Financial Services Commission", "form": "Annual fee for a limited partnership", "channel": "online", "government_fee": { "amount": 750, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an LPA 2017 limited partnership." }, { "code": "fee_not_yet_due", "type": null, "when": "The LP was not on the Register on 31 December of the year before fee_year." }, { "code": "already_paid", "type": null, "when": "The fee for fee_year is already recorded as paid." }, { "code": "not_registered_agent", "type": null, "when": "Entiva is not the LP's registered agent, so it cannot pay (LPA s.115)." }, { "code": "entity_struck_off", "type": null, "when": "The LP has been struck off." }, { "code": "spending_limit_exceeded", "type": null, "when": "The quote is above the agent mandate's spending limit." }, { "code": "payment_failed", "type": null, "when": "Entiva could not collect the government fee." } ] } }, "Params_vg_limited_partnership_annual_return_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type key", "examples": [ "lp" ] }, "financial_year_start": { "type": "string", "format": "date", "description": "First day of the financial year the return covers.", "examples": [ "2025-04-01" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Last day of the financial year the return covers. 'Year' means the calendar year or the LP's own financial year (s.54A).", "examples": [ "2026-03-31" ] }, "reporting_currency": { "type": "string", "description": "ISO 4217 code of the currency the LP prepares its accounts in.", "examples": [ "USD" ] }, "basis": { "type": "string", "enum": [ "prescribed_form", "consolidated_group_accounts", "combined_group_filing" ], "description": "prescribed_form, consolidated_group_accounts (s.54A) or combined_group_filing (s.54A).", "examples": [ "prescribed_form" ] }, "group_parent": { "type": "object", "description": "Required when basis is consolidated_group_accounts or combined_group_filing.", "examples": [ "{\"legal_name\": \"Harbour Capital Holdings Ltd\", \"jurisdiction\": \"KY\", \"registration_number\": \"345678\"}" ] }, "exemption": { "type": "string", "enum": [ "none", "regulated_files_with_fsc", "tax_return_with_financial_statements" ], "description": "Claim an exemption under s.54A.", "examples": [ "none" ] }, "nil_return": { "type": "boolean", "description": "Set to true if the LP had no assets, liabilities, income or expenses in the year.", "examples": [ "false" ] }, "balance_sheet": { "type": "object", "description": "Required unless exemption or nil_return is set.", "examples": [ "{\"cash_and_cash_equivalents\": 18000000, \"investments_and_other_financial_assets\": 940000000, \"total_assets\": 958000000, \"accounts_payable\": 2500000, \"total_liabilities\": 2500000, \"partners_capital\": 955500000}" ] }, "income_statement": { "type": "object", "description": "Required unless exemption or nil_return is set.", "examples": [ "{\"revenue\": 61000000, \"cost_of_sales\": 0, \"gross_profit\": 61000000, \"operating_expenses\": 14200000, \"other_expenses\": 0, \"income_tax_expense\": 0, \"total_expenses\": 14200000, \"net_income\": 46800000}" ] }, "records_location": { "type": "object", "description": "Give {address, custodian_name} if the financial records are kept away from the agent's office (LPA s.54).", "examples": [ "{\"address\": {\"line1\": \"1 Harbour Road\", \"city\": \"George Town\", \"country\": \"KY\"}, \"custodian_name\": \"Harbour Fund Administration Ltd\"}" ] } }, "required": [ "entity_type", "financial_year_start", "financial_year_end", "reporting_currency" ], "description": "Every BVI limited partnership must submit an annual financial return to its registered agent within 9 months after the end of each financial year. The return is not filed with the Registrar." }, "Create_vg_limited_partnership_annual_return_file": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership_annual_return.file" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_annual_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Submit a limited partnership's annual financial return to the registered agent", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_financial_return", "title": "LP annual financial return in the form the FSC prescribes by Order under LPA s.54A, as PDF plus.", "source": "generated", "required": true }, { "key": "financial_statements", "title": "The financial statements or management accounts the figures come from", "source": "uploaded", "required": false }, { "key": "consolidated_accounts", "title": "Group consolidated accounts, when basis is consolidated_group_accounts or combined_group_filing", "source": "uploaded", "required": false }, { "key": "exemption_evidence", "title": "Evidence for an exemption: FSC financial statement filing, or the Inland Revenue Department tax.", "source": "uploaded", "required": false }, { "key": "lodgement_receipt", "title": "The partner registered agent's dated acknowledgement of receipt", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "liquidator", "verification_level": "none" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_financial_return", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Entiva, as the LP's registered agent", "form": "Annual financial return in the form the FSC prescribes", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is a company or a Partnership Act 1996 LP that has not re-registered." }, { "code": "financial_year_not_ended", "type": null, "when": "financial_year_end is in the future." }, { "code": "balance_sheet_does_not_balance", "type": null, "when": "total_assets does not equal total_liabilities plus partners_capital." }, { "code": "totals_inconsistent", "type": null, "when": "The lines do not add up to their totals." }, { "code": "group_parent_required", "type": null, "when": "basis needs group_parent and consolidated_accounts, and one is missing." }, { "code": "exemption_evidence_required", "type": null, "when": "exemption is set but no exemption_evidence document has been uploaded." }, { "code": "already_lodged", "type": null, "when": "A return for this financial year is already on file with the agent." }, { "code": "default_already_notified", "type": null, "when": "Returned as a warning when more than 30 days have passed since the deadline." } ] } }, "Params_vg_lp_beneficial_ownership_change": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect.", "examples": [ "2026-10-01" ] }, "awareness_date": { "type": "string", "format": "date", "description": "Date the general partner became aware of the change.", "examples": [ "2026-10-10" ] }, "changes": { "type": "array", "items": {}, "description": "Each item: change_type, beneficial_owner, capital_percent, profit_percent, vote_percent, control, ownership_path, cessation_date." }, "general_partner": { "type": "string", "pattern": "^per_", "description": "General partner confirming the information." }, "also_file_register_of_partners": { "type": "boolean", "description": "True when the partner registers also change." } }, "required": [ "effective_date", "awareness_date", "changes", "general_partner" ], "description": "Files a change to a BVI limited partnership's beneficial ownership information within 30 days of becoming aware (LPA s.53B)." }, "Create_vg_lp_beneficial_ownership_change": { "type": "object", "properties": { "type": { "const": "vg.lp_beneficial_ownership.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_beneficial_ownership_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File change in beneficial ownership", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "beneficial_ownership_form", "title": "Beneficial ownership particulars", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart to natural persons", "source": "uploaded", "required": true }, { "key": "transfer_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "beneficial_ownership_form", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "beneficial_ownership_form", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "beneficial_ownership_form", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Beneficial ownership change filing on VIRRGIN", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "filing_window_exceeded", "type": null, "when": "More than 30 days since awareness_date; late penalty quoted." }, { "code": "beneficial_owner_unverified", "type": null, "when": "A new beneficial owner has not completed enhanced verification." }, { "code": "unsupported_entity_type", "type": null, "when": "The entity is not a registered limited partnership." }, { "code": "sanctions_alert_open", "type": null, "when": "An open alert on a beneficial owner or general partner pauses the filing." } ] } }, "Params_vg_lp_certified_copy_request": { "type": "object", "properties": { "items": { "type": "array", "items": {}, "description": "Each item: copy_type, document_description, quantity." }, "delivery": { "type": "string", "enum": [ "electronic", "courier" ], "description": "How to receive." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for courier." }, "apostille_required": { "type": "boolean", "description": "Request an apostille; priced separately at cost." }, "intended_use": { "type": "string", "description": "Purpose of the copies." } }, "required": [ "items" ], "description": "Requests certified or uncertified copies or inspection for a BVI limited partnership." }, "Create_vg_lp_certified_copy_request": { "type": "object", "properties": { "type": { "const": "vg.lp_certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request certified copies or extracts from the Registrar", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_copy", "title": "Certified copy or extract", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Request for LP certified copies and extracts", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unknown_copy_type", "type": null, "when": "An item has a copy_type outside the LP schedule." }, { "code": "document_not_on_file", "type": null, "when": "The Registry holds no such document." }, { "code": "delivery_address_missing", "type": null, "when": "Courier without address." } ] } }, "Params_vg_lp_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "The year whose 31 December register position sets the fee.", "examples": [ "2025" ] }, "expected_amount": { "$ref": "#/components/schemas/Money", "description": "Optional guard.", "examples": [ "{\"amount\":1000,\"currency\":\"USD\"}" ] }, "accept_escalated_fee": { "type": "boolean", "description": "Must be true when the payment date is after 30 April and the escalated fee applies." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Person instructing the payment, normally a general partner or authorised signatory." } }, "required": [ "fee_year" ], "description": "Pays the annual limited partnership fee under the Financial Services Regulations for an LP on the Register on 31 December. US$750 if paid by 30 April of the following year, rising to US$850, US$1,000 and US$1,150 the later it is paid." }, "Create_vg_lp_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.lp_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual fee for a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "fee_payment_instruction", "title": "LP annual fee payment instruction to the registered agent", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "fee_payment_instruction", "signer_role": "registered_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, Financial Services Commission", "form": "Annual LP fee payment on VIRRGIN", "channel": "online", "government_fee": { "amount": 750, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_fee_due", "type": null, "when": "Nothing outstanding for fee_year." }, { "code": "fee_mismatch", "type": null, "when": "expected_amount differs from the fee for today's payment date." }, { "code": "escalated_fee_not_accepted", "type": null, "when": "The payment date is after 30 April and accept_escalated_fee is not true." }, { "code": "entity_struck_off", "type": null, "when": "The LP has been struck off for non-payment (LPA s.95); use restoration." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses the action." }, { "code": "registry_unavailable", "type": null, "when": "VIRRGIN is unavailable; the partner retries." } ] } }, "Params_vg_lp_good_standing_certificate_request": { "type": "object", "properties": { "copies": { "type": "integer", "description": "Number of certificates.", "examples": [ "1" ] }, "delivery": { "type": "string", "enum": [ "electronic", "courier" ], "description": "How to receive it." }, "apostille_required": { "type": "boolean", "description": "Request an apostille; priced separately at cost." }, "intended_use": { "type": "string", "description": "Purpose of the certificate." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for courier." } }, "description": "Requests the Registrar's certificate of good standing for a BVI limited partnership." }, "Create_vg_lp_good_standing_certificate_request": { "type": "object", "properties": { "type": { "const": "vg.lp_good_standing_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_good_standing_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request certificate of good standing", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_good_standing", "title": "LP certificate of good standing", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Request for LP certificate of good standing", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_in_good_standing", "type": null, "when": "Fees unpaid, partner registers or BO filing overdue, or an annual-return default notice exists." }, { "code": "unsupported_entity_type", "type": null, "when": "The entity is not a registered limited partnership." }, { "code": "delivery_address_missing", "type": null, "when": "Courier without address." } ] } }, "Params_vg_mutual_fund_spc_annual_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year in which the fee falls due.", "examples": [ "2027" ] }, "segregated_portfolios_at_31_december": { "type": "integer", "description": "Number of segregated portfolios in existence on 31 December of the year before fee_year.", "examples": [ "6" ] }, "portfolios": { "type": "array", "items": {}, "description": "Identifiers or designations of the portfolios counted, for the fee schedule.", "examples": [ "[\"SP-A\",\"SP-B\",\"SP-C\",\"SP-D\",\"SP-E\",\"SP-F\"]" ] }, "incorporation_or_registration_date": { "type": "string", "format": "date", "description": "Date of incorporation or registration as a mutual fund SPC.", "examples": [ "2023-05-09" ] }, "fsc_approval_reference": { "type": "string", "description": "FSC approval reference for the mutual fund SPC (SPC Regulations reg 4).", "examples": [ "FSC/MF-SPC/2023/0117" ] }, "include_late_penalty": { "type": "boolean", "description": "Default true.", "examples": [ "true" ] } }, "required": [ "fee_year", "segregated_portfolios_at_31_december", "incorporation_or_registration_date" ], "description": "Pays the Financial Services Commission's annual fee for a mutual fund SPC under the Segregated Portfolio Companies Regulations, reg 15 and Schedule Part III. The fee is US$1,500 for the company plus US$350 for each segregated portfolio in." }, "Create_vg_mutual_fund_spc_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.mutual_fund_spc_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_mutual_fund_spc_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the FSC annual fee for a mutual fund segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "mutual_fund_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "portfolio_schedule", "title": "Schedule of segregated portfolios at 31 December", "source": "generated", "required": true }, { "key": "fsc_payment_receipt", "title": "FSC payment confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "portfolio_schedule", "signer_role": "registered_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Annual fee payment under SPC", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "fee_not_yet_due", "type": null, "when": "fee_year equals the year of incorporation or registration, when no annual fee is due." }, { "code": "entity_type_mismatch", "type": null, "when": "The entity is not recorded as a mutual fund SPC." }, { "code": "portfolio_count_mismatch", "type": null, "when": "segregated_portfolios_at_31_december differs from the portfolio register." }, { "code": "already_paid", "type": null, "when": "A completed payment exists for this fee_year." }, { "code": "spending_limit_exceeded", "type": null, "when": "An agent key's mandate spending limit is below the quote total." } ] } }, "Params_vg_npo_renew": { "type": "object", "properties": { "npo_registration_number": { "type": "string", "description": "NPO registration number." }, "certificate_expiry_date": { "type": "string", "format": "date", "description": "Expiry of the current certificate; the application is due 2 months before." }, "gross_annual_income": { "$ref": "#/components/schemas/Money", "description": "Sets the fee and whether accountant-certified statements are needed." }, "financial_statements": { "type": "string", "pattern": "^doc_", "description": "Last financial year's statements of revenue and expenditure." }, "large_donors": { "type": "array", "items": {}, "description": "Donors of more than US$10,000 in the year (s.24); empty triggers the no-large-donor declaration." }, "controlled_associations": { "type": "array", "items": {}, "description": "Associations operating under the NPO's control, with funds raised and disbursed (s.24); subsidiary and branch NPOs complete Part B." } }, "required": [ "npo_registration_number", "certificate_expiry_date", "gross_annual_income", "financial_statements" ], "description": "Renews the NPO's one-year certificate of registration on Form B, no later than two months before the certificate expires (NPO Act s.13 as replaced by Act 10 of 2022). The application comes with the fee and the financial statements of the." }, "Create_vg_npo_renew": { "type": "object", "properties": { "type": { "const": "vg.npo.renew" }, "params": { "$ref": "#/components/schemas/Params_vg_npo_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a non-profit organisation's registration", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_b", "title": "Form B: Renewal of Registration", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Financial statements", "source": "uploaded", "required": true }, { "key": "donor_list_or_declaration", "title": "List of donors over US$10,000, or declaration of none", "source": "generated", "required": true }, { "key": "subsidiary_statements", "title": "Statements for subsidiary or branch NPOs", "source": "uploaded", "required": false }, { "key": "renewed_certificate", "title": "Renewed certificate of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_b", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "financial_statements", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Non-Profit Organisation Registration Board", "form": "Form B, Renewal of Registration", "channel": "paper", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "certified_statements_required", "type": null, "when": "Gross annual income exceeds US$250,000 but the statements are not accountant-certified." }, { "code": "renewal_late", "type": null, "when": "Less than 2 months before expiry; not blocking, adds the US$75 late fee." }, { "code": "deregistered", "type": null, "when": "More than 30 days after expiry; restoration is needed (s.15)." } ] } }, "Params_vg_npo_registration_renew": { "type": "object", "properties": { "npo_registration_number": { "type": "string", "description": "NPO registration number on the certificate.", "examples": [ "NPO-2021-0087" ] }, "company_number": { "type": "string", "description": "BVI company number.", "examples": [ "2045511" ] }, "certificate_expiry_date": { "type": "string", "format": "date", "description": "Expiry date of the current certificate (one year from issue, s.13).", "examples": [ "2027-01-15" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "End of the last fiscal year covered by the statements.", "examples": [ "2025-12-31" ] }, "gross_annual_income": { "$ref": "#/components/schemas/Money", "description": "Gross annual income.", "examples": [ "{\"amount\":180000,\"currency\":\"USD\"}" ] }, "contact_person": { "type": "string", "pattern": "^per_", "description": "Contact person and position for Form B Part A.", "examples": [ "per_4NpoC1aa" ] }, "donors_over_10000": { "type": "array", "items": {}, "description": "Donors who gave more than US$10,000 singly or cumulatively in the year: {name, date, event, amount, within_bvi} (s.24).", "examples": [ "[{\"name\":\"Example Foundation\",\"date\":\"2025-04-02\",\"amount\":25000,\"within_bvi\":false}]" ] }, "no_large_donors_declaration": { "type": "boolean", "description": "True to give the Declaration of Full Disclosure that no individual donated more than US$10,000.", "examples": [ "false" ] }, "funds_raised": { "type": "array", "items": {}, "description": "Fundraising: {date, event, purpose, amount, within_bvi}.", "examples": [ "[{\"date\":\"2025-11-20\",\"event\":\"Annual gala\",\"purpose\":\"Youth sailing programme\",\"amount\":42000,\"within_bvi\":true}]" ] }, "funds_distributed": { "type": "array", "items": {}, "description": "Distributions: {date, event, purpose, amount, within_bvi} (s.24; Form B Part C).", "examples": [ "[{\"date\":\"2025-12-15\",\"purpose\":\"Scholarships\",\"amount\":60000,\"within_bvi\":true}]" ] }, "subsidiaries_or_branches": { "type": "array", "items": {}, "description": "Subsidiary or branch NPOs.", "examples": [ "[]" ] }, "accountant": { "type": "object", "description": "{name, firm, qualification} of the certifying accountant.", "examples": [ "{}" ] }, "years_late": { "type": "integer", "description": "Number of years for which no renewal was made.", "examples": [ "0" ] } }, "required": [ "npo_registration_number", "company_number", "certificate_expiry_date", "financial_year_end", "gross_annual_income", "contact_person", "funds_raised", "funds_distributed" ], "description": "Renews a BVI non-profit organisation's one-year certificate of registration. The organisation files Form B with the fee and the financial statements required by s.24." }, "Create_vg_npo_registration_renew": { "type": "object", "properties": { "type": { "const": "vg.npo_registration.renew" }, "params": { "$ref": "#/components/schemas/Params_vg_npo_registration_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a non-profit organisation's annual registration with the NPO Registration Board", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_b", "title": "Form B: Renewal of Registration", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Financial statements of revenue and expenditure", "source": "uploaded", "required": true }, { "key": "accountant_certification", "title": "Accountant's certification", "source": "uploaded", "required": false }, { "key": "donor_list", "title": "List of donors over US$10,000", "source": "generated", "required": false }, { "key": "declaration_of_full_disclosure", "title": "Declaration of Full Disclosure", "source": "generated", "required": false }, { "key": "funds_schedules", "title": "Schedules of funds raised, donations received and funds distributed", "source": "generated", "required": true }, { "key": "renewed_certificate", "title": "Renewed certificate of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "auditor", "verification_level": "none" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_b", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "declaration_of_full_disclosure", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "financial_statements", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "accountant_certification", "signer_role": "auditor", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Non-Profit Organisation Registration Board", "form": "Form B, Renewal of Registration", "channel": "paper", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "organisation_deregistered", "type": null, "when": "More than 30 days have passed since expiry without an application, or the Board has deregistered the organisation." }, { "code": "accountant_certification_required", "type": null, "when": "gross_annual_income exceeds US$250,000 and no accountant_certification is uploaded." }, { "code": "donor_disclosure_missing", "type": null, "when": "donors_over_10000 is empty and no_large_donors_declaration is not true." }, { "code": "renewal_refused", "type": null, "when": "The Board refuses renewal under s.14." } ] } }, "Params_vg_npo_registration_restore": { "type": "object", "properties": { "npo_registration_number": { "type": "string", "description": "Former NPO registration number.", "examples": [ "NPO-2019-0031" ] }, "deregistration_date": { "type": "string", "format": "date", "description": "Date of deregistration.", "examples": [ "2025-03-01" ] }, "deregistration_ground": { "type": "string", "enum": [ "failed_to_renew", "contravention", "request", "inactive", "public_interest" ], "description": "Why the Board deregistered the organisation.", "examples": [ "failed_to_renew" ] }, "years_outstanding": { "type": "array", "items": {}, "description": "Each year without a renewal: {renewal_year, gross_annual_income, financial_statements}.", "examples": [ "[{\"renewal_year\":2025,\"gross_annual_income\":{\"amount\":90000,\"currency\":\"USD\"}},{\"renewal_year\":2026,\"gross_annual_income\":{\"amount\":110000,\"currency\":\"USD\"}}]" ] }, "explanation": { "type": "string", "description": "Why the organisation lapsed and how it will comply in future.", "examples": [ "Treasurer resigned in 2024 and renewals were missed; a new treasurer and Entiva deadline tracking are now in place." ] }, "ceased_npo_activities": { "type": "boolean", "description": "Confirms that NPO activities stopped while deregistered.", "examples": [ "true" ] } }, "required": [ "npo_registration_number", "deregistration_date", "deregistration_ground", "years_outstanding", "explanation", "ceased_npo_activities" ], "description": "Asks the NPO Registration Board to direct the Registrar to restore a deregistered organisation, for example one deregistered for not renewing within 30 days of expiry (s.15). Restoration requires the prescribed US$25 restoration fee plus." }, "Create_vg_npo_registration_restore": { "type": "object", "properties": { "type": { "const": "vg.npo_registration.restore" }, "params": { "$ref": "#/components/schemas/Params_vg_npo_registration_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a deregistered non-profit organisation to the NPO register", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restoration_application", "title": "Restoration application letter to the Board", "source": "generated", "required": true }, { "key": "form_b_outstanding_years", "title": "Form B for each outstanding year", "source": "generated", "required": true }, { "key": "financial_statements_outstanding_years", "title": "Financial statements for each outstanding year", "source": "uploaded", "required": true }, { "key": "board_direction", "title": "Board direction to restore", "source": "registry_issued", "required": true }, { "key": "restored_certificate", "title": "Certificate of registration after restoration", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "restoration_application", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "form_b_outstanding_years", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Non-Profit Organisation Registration Board", "form": "Application to restore under NPO Act 2012 s.15", "channel": "paper", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_deregistered", "type": null, "when": "The organisation is still registered." }, { "code": "statements_missing", "type": null, "when": "An outstanding year has no financial statements." }, { "code": "restoration_refused", "type": null, "when": "The Board declines to direct restoration." } ] } }, "Params_vg_registered_agent_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "reason": { "type": "string", "enum": [ "previous_agent_resigned", "previous_agent_no_longer_eligible", "restored_to_register", "other" ], "description": "Why the entity has no registered agent. previous_agent_resigned: the date in the agent's resignation notice has passed, so it is deemed to have resigned (BCA.", "examples": [ "previous_agent_resigned" ] }, "previous_registered_agent": { "type": "object", "description": "The outgoing agent, as {name, fsc_licence_number, ceased_on}.", "examples": [ "{\"name\": \"Outgoing Agent (BVI) Limited\", \"ceased_on\": \"2026-10-09\"}" ] }, "resolution_body": { "type": "string", "enum": [ "members", "directors", "general_partners" ], "description": "Who appoints the agent.", "examples": [ "members" ] }, "resolution_form": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "Written resolution (BCA s.88 for members, s.129 for directors) or minutes of a meeting.", "examples": [ "written_resolution" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office, as {use_registered_agent_office: boolean, address: address}.", "examples": [ "{\"use_registered_agent_office\": true}" ] }, "registered_agent": { "type": "string", "enum": [ "entiva_licensed_partner" ], "description": "The incoming agent.", "examples": [ "entiva_licensed_partner" ] }, "records_location": { "type": "object", "description": "Required if records and underlying documentation are not kept at the agent's office.", "examples": [ "{\"address\": {\"line1\": \"8 Marina View\", \"city\": \"Singapore\", \"country\": \"SG\"}, \"custodian_name\": \"Mei Lin Tan\"}" ] } }, "required": [ "entity_type", "reason", "resolution_body", "registered_office" ], "description": "Every BVI company and limited partnership must have a licensed BVI registered agent and a physical BVI registered office at all times. An entity can be left with no agent when its last agent resigns, stops being eligible, or when it has." }, "Create_vg_registered_agent_appoint": { "type": "object", "properties": { "type": { "const": "vg.registered_agent.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_registered_agent_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a registered agent for a company or limited partnership that has none", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_appointment", "title": "Notice of appointment of registered agent, endorsed by the agent with its agreement to act (BCA.", "source": "generated", "required": true }, { "key": "appointing_resolution", "title": "Resolution of members or directors, or of the general partners, appointing the registered agent", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation, continuation or LP registration, and any certificate of change of name", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Current memorandum and articles with every amendment, or the LP agreement with amendments", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members, including any nominator details.", "source": "uploaded", "required": false }, { "key": "register_of_directors", "title": "Register of directors.", "source": "uploaded", "required": false }, { "key": "register_of_partners", "title": "Registers of general partners and limited partners.", "source": "uploaded", "required": false }, { "key": "ownership_chart", "title": "Ownership and control chart tracing every layer down to natural persons", "source": "uploaded", "required": true }, { "key": "previous_agent_notice", "title": "The outgoing agent's resignation notice (BCA s.93; LPA s.23) or notice that it is no longer eligible", "source": "uploaded", "required": false }, { "key": "corporate_party_kyb_pack", "title": "For each corporate member, director or general partner: certificate of incorporation, constitution.", "source": "uploaded", "required": false }, { "key": "certificate_of_restoration", "title": "Certificate of restoration to the Register (BCA s.217), when reason is restored_to_register", "source": "uploaded", "required": false }, { "key": "registered_notice", "title": "Notice of appointment endorsed by the Registrar with the date and time of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointing_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "appointing_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "appointing_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_appointment", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_appointment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of appointment of registered agent", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registered_agent_already_appointed", "type": null, "when": "The Register still shows a current registered agent." }, { "code": "entity_struck_off", "type": null, "when": "The entity is struck off and dissolved." }, { "code": "registered_agent_not_required", "type": null, "when": "An Insolvency Act liquidator is in office, and a company in liquidation does not need a registered agent (BCA s.91)." }, { "code": "directors_not_authorised", "type": null, "when": "resolution_body is directors, but the memorandum and articles do not authorise directors to appoint the agent (s.91A)." }, { "code": "resolution_body_invalid", "type": null, "when": "general_partners was given for a company, or members or directors for a limited partnership." }, { "code": "registered_office_outside_bvi", "type": null, "when": "registered_office.address is not a physical address in the BVI (BCA s.90; LPA s.18)." }, { "code": "cdd_not_accepted", "type": null, "when": "The Entiva compliance team declined the client after CDD, so nothing is filed." }, { "code": "outstanding_registry_fees", "type": null, "when": "The entity owes annual fees or penalties." }, { "code": "partner_not_eligible_for_entity_type", "type": null, "when": "A private trust company's agent must meet the conditions in the Financial Services Regulations." } ] } }, "Params_vg_registrar_certificate_request": { "type": "object", "properties": { "certificate_type": { "type": "string", "enum": [ "register_information", "company_status" ], "description": "register_information: s.235A. company_status: s.235A.", "examples": [ "register_information" ] }, "information_items": { "type": "array", "items": {}, "description": "Items to confirm when certificate_type is register_information, for example name and former names, company number, type, date of incorporation, registered.", "examples": [ "[\"name_history\",\"registered_agent\",\"registered_office\"]" ] }, "format": { "type": "string", "enum": [ "electronic", "electronic_and_physical" ], "description": "electronic, or electronic_and_physical, which adds the US$50 physical-copy fee (s.233 item).", "examples": [ "electronic" ] }, "apostille": { "type": "boolean", "description": "Also apostille the certificate at the Deputy Governor's Office.", "examples": [ "true" ] }, "destination_country": { "type": "string", "description": "ISO 3166 country where the certificate will be used.", "examples": [ "DE" ] }, "purpose": { "type": "string", "description": "Optional, for example a bank account opening.", "examples": [ "Bank account opening in Germany" ] } }, "required": [ "certificate_type" ], "description": "Asks the Registrar of Corporate Affairs to issue a certificate confirming information recorded on the Register about a company, or confirming the company's status, for a fee of US$75. This is distinct from a certificate of good standing." }, "Create_vg_registrar_certificate_request": { "type": "object", "properties": { "type": { "const": "vg.registrar_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_vg_registrar_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request a Registrar's certificate confirming register information or company status", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_request", "title": "Request data sheet", "source": "generated", "required": true }, { "key": "registrar_certificate", "title": "Registrar's certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "certificate_request", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission, Registry of Corporate Affairs", "form": "Request for a certificate under BCA s.235A", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "item_not_on_register", "type": null, "when": "A requested item is not on the public Register, for example members, directors or beneficial owners." }, { "code": "fees_outstanding", "type": null, "when": "The Registrar refuses to act until fees owed by the company are paid." }, { "code": "information_items_required", "type": null, "when": "certificate_type is register_information without information_items." } ] } }, "Params_vg_registry_inspection_request": { "type": "object", "properties": { "target": { "type": "string", "enum": [ "this_entity", "other_company" ], "description": "this_entity inspects the entity in the path. other_company inspects a third-party company or foreign company; the path entity is the customer making the.", "examples": [ "other_company" ] }, "target_company_number": { "type": "string", "description": "BVI company number or foreign company registration number.", "examples": [ "1876543" ] }, "target_name": { "type": "string", "description": "Name of the target, used to confirm the match.", "examples": [ "Harbour Holdings Limited" ] }, "register": { "type": "string", "enum": [ "register_of_companies", "register_of_foreign_companies", "register_of_charges" ], "description": "Which register the target is on.", "examples": [ "register_of_companies" ] }, "scope": { "type": "string", "enum": [ "registers", "single_document", "all_documents" ], "description": "registers: inspect the s.230 Registers. single_document: one other qualifying document. all_documents: all qualifying documents of the company.", "examples": [ "all_documents" ] }, "document_description": { "type": "string", "description": "Required for single_document, for example 'Amended memorandum and articles filed March 2024'.", "examples": [ "" ] }, "purpose": { "type": "string", "description": "Optional note, for example counterparty due diligence.", "examples": [ "Counterparty due diligence" ] } }, "required": [ "target", "register", "scope" ], "description": "Inspects the public records the Registrar of Corporate Affairs keeps under BCA s.233-. The fee depends on scope: US$50 for the Registers maintained under s.230, US$100 for any other qualifying document, or US$250 for all qualifying." }, "Create_vg_registry_inspection_request": { "type": "object", "properties": { "type": { "const": "vg.registry_inspection.request" }, "params": { "$ref": "#/components/schemas/Params_vg_registry_inspection_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Inspect the BVI Registry's records for a company or foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "inspection_report", "title": "Registry inspection report", "source": "generated", "required": true }, { "key": "document_images", "title": "Copies of inspected documents", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "inspection_report", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission, Registry of Corporate Affairs", "form": "Inspection under BCA s.233", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "target_not_found", "type": null, "when": "No company or foreign company matches target_company_number." }, { "code": "private_register", "type": null, "when": "The request asks for the register of members, register of directors or beneficial ownership." }, { "code": "document_description_required", "type": null, "when": "scope is single_document without document_description." } ] } }, "Params_vg_spc_annual_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year in which the fee falls due.", "examples": [ "2027" ] }, "portfolio_count": { "type": "integer", "description": "Number of segregated portfolios in existence on the due date.", "examples": [ "3" ] }, "portfolios": { "type": "array", "items": {}, "description": "The portfolios as at the due date, as [{portfolio_id, name, created_on, status}].", "examples": [ "[{\"name\": \"Series A SP\", \"created_on\": \"2025-02-03\", \"status\": \"active\"}]" ] }, "pay_on": { "type": "string", "format": "date", "description": "Date on which the partner should pay.", "examples": [ "2027-05-14" ] }, "include_arrears": { "type": "boolean", "description": "Also pay earlier unpaid FSC fees and penalties.", "examples": [ "true" ] } }, "required": [ "fee_year" ], "description": "A BVI business company SPC pays the Financial Services Commission an annual fee: US$450 for the company plus US$400 for each segregated portfolio in existence on the due date. The fee is due on the same date as the company's BCA annual fee." }, "Create_vg_spc_annual_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.spc_annual_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_spc_annual_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the FSC annual fee for a segregated portfolio company and its portfolios", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "segregated_portfolio_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "portfolio_schedule", "title": "Schedule of segregated portfolios in existence on the due date", "source": "generated", "required": true }, { "key": "annual_fee_statement", "title": "Entiva statement of the company fee, the per-portfolio fees, any penalty and any arrears", "source": "generated", "required": true }, { "key": "fsc_payment_confirmation", "title": "Payment confirmation for the FSC SPC annual fee", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "fsc_payment_confirmation", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "SPC annual fee", "channel": "online", "government_fee": { "amount": 450, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI business company SPC." }, { "code": "portfolio_count_mismatch", "type": null, "when": "portfolio_count differs from Entiva's portfolio register or the FSC's records." }, { "code": "outstanding_portfolio_notifications", "type": null, "when": "A portfolio creation, termination or reinstatement has not been notified to the FSC." }, { "code": "already_paid", "type": null, "when": "The FSC fee for fee_year is already recorded as paid." }, { "code": "not_registered_agent", "type": null, "when": "Entiva is not the registered agent, so it cannot pay through its VIRRGIN account." }, { "code": "payment_failed", "type": null, "when": "Entiva could not collect the government fee." } ] } }, "Params_vg_spc_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year of the due date.", "examples": [ "2026" ] }, "portfolio_count": { "type": "integer", "description": "Number of segregated portfolios in existence on the due date.", "examples": [ "3" ] }, "expected_amount": { "$ref": "#/components/schemas/Money", "description": "Optional guard on the computed fee before late charges.", "examples": [ "{\"amount\":1650,\"currency\":\"USD\"}" ] }, "accept_late_penalty": { "type": "boolean", "description": "Must be true when overdue; US$200 for each month or part after the fee falls due." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "Person instructing the payment." } }, "required": [ "fee_year" ], "description": "Pays the FSC annual fee for a non-regulated BVI business company SPC under the SPC Regulations: US$450 plus US$400 for each portfolio in existence on the due date, deducted through the registered agent's VIRRGIN account. It is separate." }, "Create_vg_spc_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.spc_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_spc_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the FSC annual fee for a segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "segregated_portfolio_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "fee_payment_instruction", "title": "SPC fee payment instruction to the registered agent", "source": "generated", "required": true }, { "key": "portfolio_schedule", "title": "Schedule of portfolios in existence on the due date", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "fee_payment_instruction", "signer_role": "registered_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Financial Services Commission", "form": "SPC annual fee payment", "channel": "online", "government_fee": { "amount": 450, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "portfolio_count_mismatch", "type": null, "when": "portfolio_count differs from the Registry or the portfolio register." }, { "code": "regulated_spc_not_supported", "type": null, "when": "The SPC is a mutual fund or insurer SPC, which pays different fees to the FSC; handled as a regulatory action." }, { "code": "no_fee_due", "type": null, "when": "Nothing outstanding for fee_year." }, { "code": "late_penalty_not_accepted", "type": null, "when": "Overdue and accept_late_penalty is not true." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses the action." }, { "code": "registry_unavailable", "type": null, "when": "VIRRGIN is unavailable; the partner retries." } ] } }, "Params_vg_spc_insurer_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Year in which the fee falls due.", "examples": [ "2027" ] }, "insurer_category": { "type": "string", "enum": [ "category_c", "other" ], "description": "category_c or any other category." }, "portfolio_count": { "type": "integer", "description": "Number of portfolios counted for the fee." }, "gross_written_premium": { "$ref": "#/components/schemas/Money", "description": "Gross written premium used for the company fee." }, "company_fee": { "$ref": "#/components/schemas/Money", "description": "Company fee confirmed by the partner from the Financial Services Regulations." }, "insurance_manager": { "type": "string", "pattern": "^ent_", "description": "Insurance manager filing the payment, if not the registered agent." } }, "required": [ "fee_year", "insurer_category", "portfolio_count" ], "description": "Pays the annual FSC fee for an insurer SPC, due 28 February. Category C pays $7,500 plus $1,000 per portfolio; others pay a premium-based company fee plus $350 per portfolio." }, "Create_vg_spc_insurer_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.spc_insurer_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_spc_insurer_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual FSC fee for a BVI insurer SPC", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "fee_computation", "title": "Fee computation", "source": "generated", "required": true }, { "key": "payment_authorisation", "title": "Payment authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "FSC payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "payment_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Annual fee payment", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "wrong_entity_type", "type": null, "when": "Entity is not an insurer SPC." }, { "code": "premium_required", "type": null, "when": "insurer_category is other and no gross_written_premium or company_fee is available." }, { "code": "fee_already_paid", "type": null, "when": "A payment for fee_year exists." } ] } }, "Params_vg_spc_mutual_fund_fee_pay": { "type": "object", "properties": { "fee_year": { "type": "integer", "description": "Calendar year in which the fee falls due.", "examples": [ "2027" ] }, "portfolio_count": { "type": "integer", "description": "Number of segregated portfolios in existence on the preceding 31 December." }, "portfolios": { "type": "array", "items": {}, "description": "Names and creation dates of the portfolios, used to evidence the count." }, "payment_reference": { "type": "string", "description": "Customer reference printed on the payment authorisation." } }, "required": [ "fee_year", "portfolio_count" ], "description": "Computes and pays the annual FSC fee of $1,500 plus $350 per portfolio in existence on the preceding 31 December for a mutual fund SPC, due 31 March." }, "Create_vg_spc_mutual_fund_fee_pay": { "type": "object", "properties": { "type": { "const": "vg.spc_mutual_fund_fee.pay" }, "params": { "$ref": "#/components/schemas/Params_vg_spc_mutual_fund_fee_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay the annual FSC fee for a mutual fund SPC", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "mutual_fund_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "portfolio_schedule", "title": "Schedule of portfolios at 31 December", "source": "generated", "required": true }, { "key": "payment_authorisation", "title": "Payment authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "FSC payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "payment_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Annual fee payment", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "wrong_entity_type", "type": null, "when": "Entity is not a mutual fund SPC." }, { "code": "portfolio_count_mismatch", "type": null, "when": "portfolio_count disagrees with the portfolio register." }, { "code": "fee_already_paid", "type": null, "when": "A payment for fee_year already exists." }, { "code": "mandate_limit_exceeded", "type": null, "when": "Computed fee exceeds the agent mandate spending limit." } ] } }, "Params_vg_status_certificate_request": { "type": "object", "properties": { "information_requested": { "type": "array", "items": {}, "description": "What the certificate confirms, for example status, registered_agent, registered_office, directors_filed, members_filed.", "examples": [ "[\"status\",\"registered_agent\"]" ] }, "copies": { "type": "integer", "description": "Number of certificates." }, "delivery": { "type": "string", "enum": [ "electronic", "courier" ], "description": "How to receive it." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Required for courier." } }, "required": [ "information_requested" ], "description": "Requests a certificate confirming register information or status under BCA s.235A, a lighter alternative to good standing." }, "Create_vg_status_certificate_request": { "type": "object", "properties": { "type": { "const": "vg.status_certificate.request" }, "params": { "$ref": "#/components/schemas/Params_vg_status_certificate_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request certificate of register information or status", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "status_certificate", "title": "Certificate of register information or status", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Request for certificate of register information or status", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "unsupported_entity_type", "type": null, "when": "The entity is not a BVI company." }, { "code": "information_not_available", "type": null, "when": "A requested item is not held on the register." } ] } }, "Params_vg_transitional_filing_file": { "type": "object", "properties": { "filings": { "type": "array", "items": {}, "description": "Which components to file.", "examples": [ "[\"register_of_members\",\"beneficial_ownership\"]" ] }, "registers_as_at": { "type": "string", "format": "date", "description": "Date at which the registers and BO information are stated as correct.", "examples": [ "2026-10-15" ] }, "members": { "type": "array", "items": {}, "description": "Register of members: each item has member, share_class, number_of_shares, voting_percentage, date_entered, date_ceased, is_nominee and nominator." }, "nominee_arrangements": { "type": "array", "items": {}, "description": "Nominee shareholder details (s.41, s.43A): nominee, nominator, date_nominee_ceased and date_nominator_ceased." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Beneficial owners and controllers: person_ref, nature_of_interest, percentage, direct_or_indirect, date_became_bo, date_ceased." }, "bo_exemption": { "type": "string", "enum": [ "none", "listed_company", "fund_subsidiary_75", "government_owned_50", "regulated_trustee", "recognised_fund_holder_details" ], "description": "BO Regs reg 11 / BCA s.96A- exemption claimed." }, "professional_directors": { "type": "array", "items": {}, "description": "Professional-director information (ss.118, 118A): director, licensee, acts_for." }, "is_restoration": { "type": "boolean", "description": "True when the company was struck off and is being restored; filing must then be made before, or within 14 days after, restoration." }, "restoration_date": { "type": "string", "format": "date", "description": "Date of restoration, when is_restoration is true." }, "registrar_extension_until": { "type": "string", "format": "date", "description": "End date of any extension the Registrar granted." }, "ownership_chart": { "type": "string", "pattern": "^doc_", "description": "Ownership and control chart down to natural persons." } }, "required": [ "filings", "registers_as_at", "members", "ownership_chart" ], "description": "Files, in one pass, the register of members, nominee details, beneficial ownership information and professional-director information that every BVI company incorporated before 2 January 2025 had to lodge under BCA Schedule 2 paras 60I-60J.." }, "Create_vg_transitional_filing_file": { "type": "object", "properties": { "type": { "const": "vg.transitional_filing.file" }, "params": { "$ref": "#/components/schemas/Params_vg_transitional_filing_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File transitional registers, nominee, beneficial ownership and professional-director information for a pre-2025 company", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members as filed", "source": "generated", "required": true }, { "key": "nominee_details", "title": "Nominee and nominator schedule", "source": "generated", "required": false }, { "key": "bo_particulars_form", "title": "Beneficial ownership particulars form", "source": "generated", "required": false }, { "key": "professional_director_disclosure", "title": "Professional-director disclosure", "source": "generated", "required": false }, { "key": "declaration_of_trust", "title": "Nominee declaration of trust", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Directors' resolution approving the registers and filing", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "bo_particulars_form", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "declaration_of_trust", "signer_role": "nominee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Filings under ss.41, 43A, 96A and, where applicable, ss.118 and 118A", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "transitional_period_not_applicable", "type": null, "when": "The company was incorporated on or after 2 January 2025; use vg.register_of_members.file and vg.beneficial_ownership.file instead." }, { "code": "entity_struck_off", "type": null, "when": "Entity is struck off and is_restoration is not set; restore first." }, { "code": "bo_unverified", "type": null, "when": "A BO or controller has not reached enhanced verification (BCA s.96A)." }, { "code": "nominee_details_missing", "type": null, "when": "A member is flagged nominee without a nominator." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a listed person." } ] } }, "Params_vg_transitional_registers_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "BVI entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "company_number": { "type": "string", "description": "BVI company number on the Register of Companies.", "examples": [ "1987654" ] }, "incorporation_date": { "type": "string", "format": "date", "description": "Date of incorporation.", "examples": [ "2018-06-12" ] }, "situation": { "type": "string", "enum": [ "existing_company", "restoration_s217", "restoration_s218" ], "description": "existing_company: a company on the Register. restoration_s217: a struck-off company being restored by the Registrar (para 60J). restoration_s218: a struck-off.", "examples": [ "existing_company" ] }, "restoration_action_id": { "type": "string", "description": "act_ id of the linked restoration action.", "examples": [ "act_9RsT2wQe" ] }, "registrar_extension_until": { "type": "string", "format": "date", "description": "End date of any extension the Registrar granted under para 60I.", "examples": [ "2026-01-02" ] }, "register_of_members_previously_filed": { "type": "boolean", "description": "True if the company opted to file its register of members before 2 January 2025.", "examples": [ "false" ] }, "components": { "type": "string", "enum": [ "register_of_members", "nominee_details", "beneficial_ownership", "bo_holder_details", "licensed_director_details", "register_of_directors" ], "description": "Which filings this action makes. register_of_directors applies only on restoration.", "examples": [ "[\"register_of_members\",\"nominee_details\",\"beneficial_ownership\"]" ] }, "members": { "type": "array", "items": {}, "description": "Register of members entries under s.41: {person, member_type, share_class, series, shares_held, voting_rights (omit if the memorandum or articles state them.", "examples": [ "[{\"person\":\"per_8Hq2LmN4\",\"member_type\":\"shareholder\",\"share_class\":\"Ordinary\",\"shares_held\":40000,\"date_entered\":\"2018-06-20\",\"is_nominee\":true}]" ] }, "nominee_arrangements": { "type": "array", "items": {}, "description": "For each nominee shareholder (s.2): {nominee_member, nominator, nominee_ceased_date, nominator_ceased_date}.", "examples": [ "[{\"nominee_member\":\"per_8Hq2LmN4\",\"nominator\":\"per_5KcW7pZs\"}]" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "Beneficial owners and controllers with the BO Regulations reg 21 particulars: {person, nature_of_interest, percentage, direct, via_entities (entity particulars.", "examples": [ "[{\"person\":\"per_5KcW7pZs\",\"nature_of_interest\":[\"shares_10pct\",\"votes_10pct\"],\"percentage\":80,\"direct\":false,\"date_became_bo\":\"2018-06-20\"}]" ] }, "members_filing_exemption": { "type": "string", "enum": [ "none", "listed_on_recognised_exchange", "siba_recognised_fund", "incubator_or_approved_fund" ], "description": "Ground for not filing the register of members (s.43A).", "examples": [ "none" ] }, "bo_filing_exemption": { "type": "string", "enum": [ "none", "listed_on_recognised_exchange", "fund_bo_held_by_licensee" ], "description": "Ground for not filing BO information (s.96A). fund_bo_held_by_licensee requires bo_holder.", "examples": [ "none" ] }, "bo_holder": { "type": "object", "description": "For an exempt fund: {name, address, holder_type, licence_number}.", "examples": [ "{\"name\":\"Example Fund Administrators (BVI) Ltd\",\"holder_type\":\"category_6_licensee\",\"licence_number\":\"SIBA/L/12/0001\"}" ] }, "licensed_directors": { "type": "array", "items": {}, "description": "Directors provided by an FSC licensee under the Banks and Trust Companies Act or the Company Management Act: {director, licensee_name, appointed_as.", "examples": [ "[]" ] }, "register_of_members_public": { "type": "boolean", "description": "Opt to make the filed register of members publicly accessible (s.43A).", "examples": [ "false" ] }, "penalties_assessed": { "$ref": "#/components/schemas/Money", "description": "Penalties the Registrar has already assessed under para 60I, if a notice has been received.", "examples": [ "{\"amount\":1400,\"currency\":\"USD\"}" ] } }, "required": [ "entity_type", "company_number", "incorporation_date", "situation", "register_of_members_previously_filed", "components", "members_filing_exemption", "bo_filing_exemption" ], "description": "Brings a company incorporated before 2 January 2025 into line with the BVI Business Companies Act 2024. It files the register of members, nominee shareholder details (s.41), beneficial ownership information and, where an FSC-licensed." }, "Create_vg_transitional_registers_file": { "type": "object", "properties": { "type": { "const": "vg.transitional_registers.file" }, "params": { "$ref": "#/components/schemas/Params_vg_transitional_registers_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the transitional register of members, nominee, beneficial ownership and licensed-director information for a.", "x-entiva": { "jurisdiction": "vg", "stage": "ongoing_compliance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_members", "title": "Register of members in the Registrar's form", "source": "generated", "required": false }, { "key": "nominee_details_schedule", "title": "Nominee shareholder details", "source": "generated", "required": false }, { "key": "bo_particulars", "title": "Beneficial ownership particulars", "source": "generated", "required": false }, { "key": "ownership_chart", "title": "Ownership and control chart to natural persons", "source": "uploaded", "required": true }, { "key": "nominee_declaration_of_trust", "title": "Nominee agreement or declaration of trust", "source": "uploaded", "required": false }, { "key": "bo_holder_confirmation", "title": "BO holder's confirmation", "source": "uploaded", "required": false }, { "key": "exemption_evidence", "title": "Listing or fund recognition evidence", "source": "uploaded", "required": false }, { "key": "licensed_director_services_agreement", "title": "Director services agreement with the FSC licensee", "source": "uploaded", "required": false }, { "key": "director_confirmation", "title": "Director's confirmation and filing instruction", "source": "generated", "required": true }, { "key": "filing_confirmations", "title": "VIRRGIN filing confirmations", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominee", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "bo_particulars", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_confirmation", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nominee_declaration_of_trust", "signer_role": "nominee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "register_of_members", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "bo_particulars", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission, Registry of Corporate Affairs", "form": "Register of members and nominator information", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_existing_company", "type": null, "when": "incorporation_date is on or after 2 January 2025." }, { "code": "entity_struck_off", "type": null, "when": "situation is existing_company but the Registrar has struck the company off." }, { "code": "restoration_link_required", "type": null, "when": "situation is restoration_s217 or restoration_s218 and restoration_action_id is missing." }, { "code": "transitional_filing_already_complete", "type": null, "when": "Registry records show the register of members (with complete s.41 particulars and nominee information) and the BO information already filed (para 60I)." }, { "code": "beneficial_owner_not_verified", "type": null, "when": "A beneficial owner or controller has not completed enhanced verification." }, { "code": "nominator_details_missing", "type": null, "when": "A member is flagged as a nominee but no nominator is given (s.41)." }, { "code": "bo_holder_required", "type": null, "when": "bo_filing_exemption is fund_bo_held_by_licensee but bo_holder is missing (s.96A)." }, { "code": "exemption_evidence_missing", "type": null, "when": "An exemption is claimed without exemption_evidence." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejected or queried the filing." } ] } }, "Params_vg_common_seal_record": { "type": "object", "properties": { "seal_kind": { "type": "string", "enum": [ "adopt", "replace" ], "description": "Whether this records a first seal or replaces an existing one." }, "seal_text": { "type": "string", "description": "Wording that appears on the seal, normally the company name and number." }, "imprint": { "type": "string", "pattern": "^doc_", "description": "Scan of the seal imprint." }, "custodian": { "type": "string", "pattern": "^per_", "description": "Person who holds the physical seal." }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the seal is in use." } }, "required": [ "seal_kind", "seal_text", "imprint" ], "description": "Every BVI business company must have a common seal, and an imprint must be kept at the registered agent's office (BCA s.102). This action adopts or changes the seal and delivers the imprint to the registered agent." }, "Create_vg_common_seal_record": { "type": "object", "properties": { "type": { "const": "vg.common_seal.record" }, "params": { "$ref": "#/components/schemas/Params_vg_common_seal_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record the common seal and its imprint", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "seal_imprint", "title": "Seal imprint", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution adopting the seal", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Seal imprint", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "imprint_unreadable", "type": null, "when": "The imprint scan is not legible." }, { "code": "document_required", "type": null, "when": "imprint is missing." } ] } }, "Params_vg_directors_resolution_pass": { "type": "object", "properties": { "subject": { "type": "string", "enum": [ "share_allotment", "share_transfer_approval", "distribution", "registered_office_change", "registered_agent_change", "appoint_officer", "authorise_signatory", "approve_mandate", "declaration_of_solvency", "liquidation_plan", "other" ], "description": "What the resolution decides." }, "resolution_text": { "type": "string", "description": "Full wording of the resolution." }, "effective_date": { "type": "string", "format": "date", "description": "Defaults to the date of the last required consent." }, "directors": { "type": "array", "items": {}, "description": "Directors asked to consent, as person_ref." }, "alternate_signers": { "type": "array", "items": {}, "description": "Alternate directors signing for an appointer, each with person_ref and appointing_director." }, "solvency_confirmation": { "type": "boolean", "description": "Required true when subject is distribution: the directors confirm the solvency test." }, "follow_on_params": { "type": "object", "description": "Parameters for any follow-on action created from this resolution." }, "supporting_documents": { "type": "array", "items": {}, "description": "List of document_ref." } }, "required": [ "subject", "resolution_text" ], "description": "Records a resolution of directors passed by written consent or other written electronic communication, in counterparts and without notice (BCA s.129-). The majority required is set by the memorandum and articles, and is unanimity if they." }, "Create_vg_directors_resolution_pass": { "type": "object", "properties": { "type": { "const": "vg.directors_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_vg_directors_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass directors' written resolution", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' written resolution", "source": "generated", "required": true }, { "key": "constitution", "title": "Memorandum and articles of association", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "alternate_director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Directors' written resolution", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_not_on_register", "type": null, "when": "A listed signer is not a current director or alternate." }, { "code": "consent_threshold_not_met", "type": null, "when": "Required consents are not reached." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to give a director's consent itself." }, { "code": "solvency_confirmation_required", "type": null, "when": "subject is distribution and solvency_confirmation is not true." } ] } }, "Params_vg_members_meeting_call": { "type": "object", "properties": { "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting.", "examples": [ "2026-11-20" ] }, "meeting_time": { "type": "string", "description": "Start time, HH:MM 24-hour, with timezone in meeting_timezone.", "examples": [ "10:00" ] }, "meeting_timezone": { "type": "string", "description": "IANA timezone.", "examples": [ "America/Tortola" ] }, "format": { "type": "string", "enum": [ "in_person", "electronic", "hybrid" ], "description": "In person, electronic or hybrid (s.82- allows any place and electronic means)." }, "location": { "$ref": "#/components/schemas/Address", "description": "Required when format is in_person or hybrid." }, "electronic_access_details": { "type": "string", "description": "Dial-in or video link; required when format is electronic or hybrid." }, "called_by": { "type": "string", "enum": [ "directors", "members_requisition" ], "description": "Who calls the meeting: the directors, or the directors acting on a members' requisition." }, "requisitioning_members": { "type": "array", "items": {}, "description": "List of person_ref or entity_ref for members who requisitioned the meeting." }, "requisition_votes_percentage": { "type": "number", "description": "Percentage of votes the requisitioning members hold." }, "record_date": { "type": "string", "format": "date", "description": "Date by which a member must be on the register of members to vote, where the articles allow one." }, "agenda": { "type": "array", "items": {}, "description": "Agenda items." }, "notice_period_days": { "type": "integer", "description": "Notice period the articles require." }, "notice_recipients": { "type": "array", "items": {}, "description": "Members to notify." }, "notice": { "type": "string", "pattern": "^doc_", "description": "Existing notice to use instead of the generated one." } }, "required": [ "meeting_date", "meeting_time", "meeting_timezone", "format", "called_by", "agenda" ], "description": "Convenes a meeting of members of a BVI company, either on the directors' own initiative or because members holding 30% of the votes required it (BCA s.82). Meetings may be held anywhere and by electronic means (s.82-)." }, "Create_vg_members_meeting_call": { "type": "object", "properties": { "type": { "const": "vg.members_meeting.call" }, "params": { "$ref": "#/components/schemas/Params_vg_members_meeting_call" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Call a members' meeting", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_meeting_notice", "title": "Notice of members' meeting", "source": "generated", "required": true }, { "key": "constitution", "title": "Memorandum and articles of association", "source": "uploaded", "required": false }, { "key": "members_requisition", "title": "Members' requisition", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_meeting_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_requisition", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Notice of meeting under the memorandum and articles", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "requisition_below_threshold", "type": null, "when": "called_by is members_requisition and requisition_votes_percentage is below the threshold in the articles." }, { "code": "meeting_location_required", "type": null, "when": "format is in_person or hybrid without location." }, { "code": "notice_period_too_short", "type": null, "when": "meeting_date is earlier than today plus the notice period." }, { "code": "unsupported_entity_type", "type": null, "when": "The entity is a limited partnership, foreign company or other type without members' meetings under the BCA." } ] } }, "Params_vg_members_resolution_pass": { "type": "object", "properties": { "subject": { "type": "string", "enum": [ "amend_constitution", "name_change", "authorised_shares_change", "merger", "continuation_out", "appoint_voluntary_liquidator", "appoint_director", "remove_director", "other" ], "description": "What the resolution decides." }, "resolution_text": { "type": "string", "description": "Full wording of the resolution." }, "effective_date": { "type": "string", "format": "date", "description": "Date the resolution takes effect; defaults to the date the last required consent is given." }, "members": { "type": "array", "items": {}, "description": "Members asked to consent, as person_ref or entity_ref." }, "required_consent": { "type": "string", "enum": [ "constitution_default", "majority_of_votes", "unanimous" ], "description": "Consent rule that applies." }, "signing_basis": { "type": "string", "enum": [ "personal", "corporate_authorised_person", "proxy_or_attorney" ], "description": "How each member signs: personally, through an authorised person of a corporate member, or through a proxy or attorney the articles allow." }, "follow_on_params": { "type": "object", "description": "Parameters for the follow-on filing action, for example the new name." }, "supporting_documents": { "type": "array", "items": {}, "description": "List of document_ref." } }, "required": [ "subject", "resolution_text" ], "description": "Records a resolution of members passed in writing or by written electronic communication, in counterparts, without a meeting, subject to the memorandum and articles. Used for constitution amendments, name changes, mergers, continuation." }, "Create_vg_members_resolution_pass": { "type": "object", "properties": { "type": { "const": "vg.members_resolution.pass" }, "params": { "$ref": "#/components/schemas/Params_vg_members_resolution_pass" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pass members' written resolution", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' written resolution", "source": "generated", "required": true }, { "key": "constitution", "title": "Memorandum and articles of association", "source": "uploaded", "required": false }, { "key": "power_of_attorney", "title": "Power of attorney", "source": "uploaded", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None for the resolution itself", "form": "Members' written resolution", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "consent_threshold_not_met", "type": null, "when": "The action cannot complete because the consents received do not reach the threshold." }, { "code": "member_not_on_register", "type": null, "when": "A listed signer is not on the register of members." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to sign a power of attorney or a document the member must sign personally." }, { "code": "constitution_restricts_electronic_signature", "type": null, "when": "The articles on file do not allow electronic signatures or written resolutions by electronic communication." } ] } }, "Params_vg_minutes_record": { "type": "object", "properties": { "meeting_type": { "type": "string", "enum": [ "directors", "members" ], "description": "Body that met." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting." }, "held_electronically": { "type": "boolean", "description": "True if held by electronic means." }, "chair": { "type": "string", "pattern": "^per_", "description": "Person who chaired and authorises the signature." }, "attendees": { "type": "array", "items": {}, "description": "Each with person_ref or entity_ref, capacity and present: true." }, "minutes_text": { "type": "string", "description": "Minutes text." }, "resolutions_passed": { "type": "array", "items": {}, "description": "Resolutions passed, each with text and result." }, "storage_location": { "type": "string", "enum": [ "registered_agent_office", "other_notified_place" ], "description": "Where the minute book is kept." }, "link_to_action": { "type": "string", "description": "act_ id of the vg.members_meeting.call action this meeting followed." } }, "required": [ "meeting_type", "meeting_date", "chair", "attendees" ], "description": "Adds the minutes of a directors' or members' meeting, and copies of any resolutions passed, to the company's minute book (BCA s.102). The statute names no signatory; articles usually make minutes signed by the chair evidence of proceedings." }, "Create_vg_minutes_record": { "type": "object", "properties": { "type": { "const": "vg.minutes.record" }, "params": { "$ref": "#/components/schemas/Params_vg_minutes_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record minutes of a meeting", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "minutes", "title": "Minutes of meeting", "source": "generated", "required": true }, { "key": "members_meeting_notice", "title": "Notice of meeting", "source": "uploaded", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "minutes", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Minutes under BCA s.102", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "minutes_content_required", "type": null, "when": "Neither minutes_text nor an uploaded minutes document is provided." }, { "code": "chair_not_attendee", "type": null, "when": "chair is not listed as an attendee." }, { "code": "unsupported_entity_type", "type": null, "when": "The entity is not a BVI business company." } ] } }, "Params_vg_nominee_details_file": { "type": "object", "properties": { "filing_kind": { "type": "string", "enum": [ "initial", "change" ], "description": "Initial copy of the register or a change." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change." }, "nominee_arrangements": { "type": "array", "items": {}, "description": "One item per arrangement: nominee, nominators, shares, nominee_ceased_date, nominator_ceased_date." }, "register_of_members": { "type": "string", "pattern": "^doc_", "description": "Current copy of the register of members." }, "exemption_claimed": { "type": "string", "enum": [ "none", "listed_company", "recognised_fund", "incubator_fund", "approved_fund" ], "description": "Exemption under s.43A, if claimed." }, "nominee_is_licensed_provider": { "type": "boolean", "description": "True when the nominee is an FSC-licensed provider; the licence number is then needed." }, "nominee_licence_number": { "type": "string", "description": "FSC licence number when nominee_is_licensed_provider is true." } }, "required": [ "filing_kind", "nominee_arrangements", "register_of_members" ], "description": "Files a copy of the register of members with the nominator's name and address, and the dates a nominee ceased to be a member or a person ceased to be a nominator. Initial filing within 30 days of incorporation or continuation; changes." }, "Create_vg_nominee_details_file": { "type": "object", "properties": { "type": { "const": "vg.nominee_details.file" }, "params": { "$ref": "#/components/schemas/Params_vg_nominee_details_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File nominee shareholder details", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_members", "title": "Register of members", "source": "uploaded", "required": true }, { "key": "nominator_disclosure", "title": "Nominator disclosure", "source": "generated", "required": true }, { "key": "declaration_of_trust", "title": "Nominee declaration of trust", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "nominee", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "enhanced" } ], "approvals": [], "signatures": [ { "document_key": "declaration_of_trust", "signer_role": "nominee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "register_of_members", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Register of members filing with nominator details", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nominator_unverified", "type": null, "when": "A nominator has not completed verification." }, { "code": "filing_out_of_time", "type": null, "when": "change_date is more than 30 days ago; late penalties apply." }, { "code": "exemption_not_applicable", "type": null, "when": "exemption_claimed is set but the entity is not listed or a recognised fund." }, { "code": "licence_number_required", "type": null, "when": "nominee_is_licensed_provider is true without a licence number." } ] } }, "Params_vg_records_location_change": { "type": "object", "properties": { "records_kind": { "type": "array", "items": {}, "description": "Records covered: minute_book, registers, accounting_records, underlying_documentation." }, "location": { "$ref": "#/components/schemas/Address", "description": "New place where the records are kept." }, "previous_location": { "$ref": "#/components/schemas/Address", "description": "Previous place, if any." }, "controller": { "type": "string", "pattern": "^per_", "description": "Person or entity that controls access to the records." }, "effective_date": { "type": "string", "format": "date", "description": "Date records moved or will move." }, "retention_years": { "type": "integer", "description": "Retention period the company applies." } }, "required": [ "records_kind", "location", "controller", "effective_date" ], "description": "Tells the licensed registered agent where the company's statutory records and accounting records are kept and who controls them. Records must be kept for at least 5 years; a change of location must be notified within 14 days." }, "Create_vg_records_location_change": { "type": "object", "properties": { "type": { "const": "vg.records_location.change" }, "params": { "$ref": "#/components/schemas/Params_vg_records_location_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the registered agent of where records are kept", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "records_location_notice", "title": "Notice of records location", "source": "generated", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "records_location_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. Notice goes to the registered agent, not the Registrar", "form": "Written notice to registered agent", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_out_of_time", "type": null, "when": "effective_date is more than 14 days ago; the action proceeds but a penalty warning is returned in requirements." }, { "code": "retention_below_minimum", "type": null, "when": "retention_years is less than 5." } ] } }, "Params_vg_register_rectify": { "type": "object", "properties": { "register": { "type": "string", "enum": [ "members", "directors" ], "description": "Register to rectify." }, "applicant": { "type": "string", "pattern": "^per_", "description": "Member, director or other aggrieved person applying." }, "applicant_entity": { "type": "string", "pattern": "^ent_", "description": "Corporate applicant, instead of applicant." }, "respondents": { "type": "array", "items": {}, "description": "Other parties affected, each with name and address." }, "grounds": { "type": "string", "enum": [ "entry_omitted", "entry_wrongly_made", "entry_wrongly_retained", "error_or_defect", "other" ], "description": "Why the register is wrong." }, "relief_sought": { "type": "string", "description": "The entries to add, delete or correct." }, "facts_summary": { "type": "string", "description": "Factual background for the draft evidence." }, "urgent": { "type": "boolean", "description": "True if interim relief is sought." }, "supporting_documents": { "type": "array", "items": {}, "description": "List of document_ref: share transfers, resolutions, correspondence, extracts of the register." }, "deponents": { "type": "array", "items": {}, "description": "People who will swear affidavits, each with person_ref and where they can attend a notary." } }, "required": [ "register", "applicant", "grounds", "relief_sought", "facts_summary", "supporting_documents", "deponents" ], "description": "Applies to the High Court for an order rectifying the register of members or the register of directors. Run through a partner BVI law firm." }, "Create_vg_register_rectify": { "type": "object", "properties": { "type": { "const": "vg.register.rectify" }, "params": { "$ref": "#/components/schemas/Params_vg_register_rectify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rectify the register of members or directors by court order", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "court_application", "title": "Application and draft order", "source": "generated", "required": true }, { "key": "affidavit", "title": "Supporting affidavit", "source": "uploaded", "required": true }, { "key": "court_order", "title": "Court order", "source": "registry_issued", "required": true }, { "key": "register_of_members", "title": "Rectified register of members", "source": "generated", "required": false }, { "key": "register_of_directors", "title": "Rectified register of directors", "source": "generated", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "affidavit", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "court_application", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court of the Virgin Islands, Commercial Division", "form": "Application for rectification order", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "applicant_not_eligible", "type": null, "when": "The applicant is not a member, director or aggrieved person." }, { "code": "affidavit_not_sworn", "type": null, "when": "An affidavit upload has no jurat with place and date." }, { "code": "legal_counsel_required", "type": null, "when": "The matter is outside what the partner law firm will accept; the action moves to rejected with a reason." }, { "code": "unsupported_register", "type": null, "when": "register is not members or directors." } ] } }, "Params_vg_register_change_notify": { "type": "object", "properties": { "register": { "type": "string", "enum": [ "members", "directors", "charges" ], "description": "Register that changed." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change occurred." }, "change_summary": { "type": "string", "description": "What changed." }, "updated_register": { "type": "string", "pattern": "^doc_", "description": "The updated register or a certified copy." }, "create_registry_filing": { "type": "boolean", "description": "If true, a filing action for the Registrar is created automatically." } }, "required": [ "register", "effective_date", "change_summary", "updated_register" ], "description": "Tells the registered agent of a change to the register of members or register of directors within 15 days, and supplies the updated register so the agent holds current copies. The agent then files the change with the Registrar through the." }, "Create_vg_register_change_notify": { "type": "object", "properties": { "type": { "const": "vg.register_change.notify" }, "params": { "$ref": "#/components/schemas/Params_vg_register_change_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the registered agent of a register change", "x-entiva": { "jurisdiction": "vg", "stage": "governance", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "register_of_members", "title": "Updated register of members", "source": "uploaded", "required": false }, { "key": "register_of_directors", "title": "Updated register of directors", "source": "uploaded", "required": false }, { "key": "register_change_notice", "title": "Notice of register change", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "register_change_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None for the notice", "form": "Written notice to registered agent", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_out_of_time", "type": null, "when": "change_date is more than 15 days ago." }, { "code": "updated_register_required", "type": null, "when": "updated_register is missing." } ] } }, "Params_vg_alternate_director_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "appointing_director": { "type": "string", "pattern": "^per_", "description": "The director making the appointment.", "examples": [ "per_4tXq9LmC2a" ] }, "alternate": { "type": "string", "pattern": "^per_", "description": "Another director, or any other person not disqualified under s.111 (s.130).", "examples": [ "per_3eRt5YuI7o" ] }, "alternate_is_existing_director": { "type": "boolean", "description": "If true, no register entry is required (s.118) and nothing is filed, although the company may still record the name.", "examples": [ "false" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the written appointment.", "examples": [ "2026-10-21" ] }, "scope": { "type": "string", "description": "Any limit on the alternate's authority set by the appointing director, for example specific meetings.", "examples": [ "All board meetings while the appointing director is travelling, October to December 2026" ] }, "board_approval_required_by_articles": { "type": "boolean", "description": "Set if the M&A make a non-director alternate's appointment subject to board approval. s.130 is subject to the M&A.", "examples": [ "false" ] } }, "required": [ "entity_type", "appointing_director", "alternate", "alternate_is_existing_director", "effective_date" ], "description": "A director appoints an alternate to exercise their powers and responsibilities in decisions taken in their absence. The appointment is made in writing with written notice to the company, the alternate's consent is collected, and the." }, "Create_vg_alternate_director_appoint": { "type": "object", "properties": { "type": { "const": "vg.alternate_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_alternate_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an alternate director", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "alternate_appointment_and_notice", "title": "Written appointment of alternate and notice to the company", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Alternate's written consent to act", "source": "generated", "required": true }, { "key": "board_approval_resolution", "title": "Directors' resolution approving the alternate", "source": "generated", "required": false }, { "key": "passport", "title": "Alternate's photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Alternate's proof of address", "source": "uploaded", "required": false }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "alternate_director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "alternate_appointment_and_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "alternate_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_approval_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors including the alternate", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "alternate_disqualified", "type": null, "when": "The proposed alternate is disqualified under s.111 (s.130)." }, { "code": "alternate_cannot_appoint_alternate", "type": null, "when": "The appointing person is acting as an alternate (s.130)." }, { "code": "articles_prohibit_alternates", "type": null, "when": "The M&A exclude alternate directors." }, { "code": "consent_not_signed", "type": null, "when": "The alternate has not signed the s.112 consent." } ] } }, "Params_vg_alternate_director_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "alternate": { "type": "string", "pattern": "^per_", "description": "The alternate director.", "examples": [ "per_3eRt5YuI7o" ] }, "appointing_director": { "type": "string", "pattern": "^per_", "description": "The director who appointed the alternate.", "examples": [ "per_4tXq9LmC2a" ] }, "termination_reason": { "type": "string", "enum": [ "terminated_by_appointing_director", "alternate_resigned", "appointing_director_ceased" ], "description": "terminated_by_appointing_director: s.130. alternate_resigned: under the M&A. appointing_director_ceased: where the M&A end the alternate's appointment when the.", "examples": [ "terminated_by_appointing_director" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the written notice reaches the company (s.130).", "examples": [ "2026-12-31" ] }, "alternate_was_existing_director": { "type": "boolean", "description": "If the alternate was already a director, nothing is filed.", "examples": [ "false" ] } }, "required": [ "entity_type", "alternate", "appointing_director", "termination_reason", "effective_date", "alternate_was_existing_director" ], "description": "Ends an alternate's appointment, either by the appointing director at any time (BCA s.130) or on the alternate's resignation. Termination takes effect only once written notice reaches the company (s.130)." }, "Create_vg_alternate_director_remove": { "type": "object", "properties": { "type": { "const": "vg.alternate_director.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_alternate_director_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End an alternate director's appointment", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "termination_notice", "title": "Written notice of termination, or the alternate's resignation", "source": "generated", "required": true }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "alternate_director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "termination_notice", "signer_role": "alternate_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_an_alternate", "type": null, "when": "The person is not a recorded alternate of the appointing director." }, { "code": "notice_not_given", "type": null, "when": "Termination cannot be recorded until the company has written notice (s.130)." } ] } }, "Params_vg_director_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The person being appointed.", "examples": [ "per_4tXq9LmC2a" ] }, "director_kind": { "type": "string", "enum": [ "individual", "corporate" ], "description": "Whether the director is an individual (s.118A) or a body corporate (s.118A).", "examples": [ "individual" ] }, "is_licensed_director_service": { "type": "boolean", "description": "True if the director is provided by a person licensed by the FSC under the Company Management Act or the Banks and Trust Companies Act to provide director.", "examples": [ "false" ] }, "appointing_body": { "type": "string", "enum": [ "members", "directors", "registered_agent" ], "description": "Who appoints. members: default route unless the M&A provide otherwise (s.113). directors: only where the M&A permit (s.113) or to fill a vacancy (s.113)..", "examples": [ "members" ] }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "Written resolution (members s.88; directors s.129) or a resolution passed at a meeting.", "examples": [ "written_resolution" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the members' or directors' meeting.", "examples": [ "2026-10-20" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-10-20" ] }, "term": { "type": "string", "description": "Term specified on appointment (s.113).", "examples": [ "Until the 2028 annual review" ] }, "fills_vacancy_of": { "type": "string", "pattern": "^per_", "description": "The former director whose departure created the vacancy, when the directors fill a vacancy under s.113.", "examples": [ "per_8wNc3RbT1k" ] }, "particulars": { "type": "object", "description": "Register particulars, defaulting from the person object.", "examples": [ "{\"full_name\":\"Amelia Rose Hartley\",\"former_names\":[],\"service_address\":{\"line1\":\"14 Kings Road\",\"city\":\"London\",\"postal_code\":\"SW3 4RD\",\"country\":\"GB\"},\"date_of_birth\":\"1984-03-12\",\"place_of_birth\":\"Bristol, GB\",\"nationality\":\"GB\"}" ] }, "corporate_representative": { "type": "string", "pattern": "^per_", "description": "Required for a corporate director: the individual who represents it.", "examples": [ "per_2hJk7VnQ0s" ] }, "consent_document": { "type": "string", "pattern": "^doc_", "description": "An s.112 consent already signed outside Entiva.", "examples": [ "doc_1aB2cD3eF4" ] }, "resolution_document": { "type": "string", "pattern": "^doc_", "description": "A resolution already passed outside Entiva.", "examples": [ "doc_5gH6iJ7kL8" ] } }, "required": [ "entity_type", "director", "director_kind", "is_licensed_director_service", "appointing_body", "resolution_method", "effective_date", "particulars" ], "description": "Appoints an individual or corporate director, including filling a casual vacancy, by members' or directors' resolution. Collects the appointee's written consent, runs CDD through the licensed Entiva, updates the register of directors." }, "Create_vg_director_appoint": { "type": "object", "properties": { "type": { "const": "vg.director.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a director of a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "appointment_resolution", "title": "Members' or directors' resolution appointing the director", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Written consent to act as director", "source": "generated", "required": true }, { "key": "passport", "title": "Government-issued photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": false }, { "key": "pep_sanctions_declaration", "title": "PEP and sanctions self-declaration", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Corporate director: certificate of incorporation", "source": "uploaded", "required": false }, { "key": "constitution", "title": "Corporate director: constitution", "source": "uploaded", "required": false }, { "key": "corporate_registers_and_ownership_chart", "title": "Corporate director: registers of directors and members, and ownership chart", "source": "uploaded", "required": false }, { "key": "corporate_board_resolution", "title": "Corporate director: board resolution approving the appointment and naming its representative", "source": "uploaded", "required": false }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "appointee", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "appointment_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "pep_sanctions_declaration", "signer_role": "appointee", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change, filed as the s.118A particulars i", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_disqualified", "type": null, "when": "The appointee is disqualified under BCA s.111: under 18, an Insolvency Act s.260 disqualified person, an s.409 restricted person, an undischarged bankrupt, or barred by the M&A." }, { "code": "licensed_director_action_required", "type": null, "when": "is_licensed_director_service is true." }, { "code": "articles_do_not_permit_director_appointment", "type": null, "when": "appointing_body is directors, the M&A do not permit it (s.113), and the appointment does not fill a vacancy under s.113." }, { "code": "vacancy_term_exceeded", "type": null, "when": "A director appointed to fill a vacancy is given a term longer than the term that remained (s.113)." }, { "code": "registered_agent_appointment_not_available", "type": null, "when": "appointing_body is registered_agent but the s.113 conditions are not met, for example the company already has members." }, { "code": "consent_not_signed", "type": null, "when": "Filing is blocked until the s.112 consent is signed." }, { "code": "verification_refused", "type": null, "when": "The Entiva compliance team refuses the appointee after CDD or screening, for example on a sanctions match." }, { "code": "entity_not_with_partner_registered_agent", "type": null, "when": "The company's registered agent is not Entiva." }, { "code": "filing_overdue", "type": null, "when": "The effective date is more than 30 days ago." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI business company of a listed type." } ] } }, "Params_vg_director_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The director who has ceased to hold office.", "examples": [ "per_8wNc3RbT1k" ] }, "reason": { "type": "string", "enum": [ "death", "corporate_director_ceased_to_exist", "term_expired", "vacated_under_articles", "disqualified" ], "description": "Why the office ended.", "examples": [ "death" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of death, dissolution, term expiry or vacation.", "examples": [ "2026-10-08" ] }, "reserve_director_takes_office": { "type": "boolean", "description": "True where the deceased was the sole member and sole director and had nominated a reserve director under s.113.", "examples": [ "true" ] }, "reserve_director": { "type": "string", "pattern": "^per_", "description": "Required when reserve_director_takes_office is true.", "examples": [ "per_6yUi3OpL9d" ] }, "replacement_director": { "type": "string", "pattern": "^per_", "description": "Opens a linked vg.director.appoint to fill the vacancy (s.113-).", "examples": [ "per_4tXq9LmC2a" ] } }, "required": [ "entity_type", "director", "reason", "effective_date" ], "description": "Records a director leaving office without a resignation or removal: death, a corporate director ceasing to exist, expiry of a fixed term (s.113), vacation under the articles, or disqualification. Activates a nominated reserve director." }, "Create_vg_director_cease": { "type": "object", "properties": { "type": { "const": "vg.director.cease" }, "params": { "$ref": "#/components/schemas/Params_vg_director_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a director ceasing to hold office", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "death_certificate", "title": "Death certificate", "source": "uploaded", "required": false }, { "key": "evidence_of_dissolution", "title": "Evidence that the corporate director has been dissolved", "source": "uploaded", "required": false }, { "key": "cessation_notice", "title": "Notice recording the cessation", "source": "generated", "required": true }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "none" }, { "role": "reserve_director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "cessation_notice", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_remaining_director", "type": null, "when": "No director remains and no reserve director or replacement is named." }, { "code": "reserve_nomination_not_effective", "type": null, "when": "reserve_director_takes_office is true but the s.113 conditions were not met, or the nomination had lapsed under s.113." }, { "code": "evidence_missing", "type": null, "when": "No death certificate or dissolution evidence was uploaded." } ] } }, "Params_vg_director_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The director, alternate or reserve director whose particulars change.", "examples": [ "per_4tXq9LmC2a" ] }, "change_type": { "type": "string", "enum": [ "change", "correction" ], "description": "change: the facts changed, for example a new address. correction: the register held an error.", "examples": [ "change" ] }, "changes": { "type": "object", "description": "Only the fields that change.", "examples": [ "{\"residential_address\":{\"line1\":\"2 Marina Way\",\"city\":\"Singapore\",\"postal_code\":\"018960\",\"country\":\"SG\"}}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change occurred.", "examples": [ "2026-10-10" ] } }, "required": [ "entity_type", "director", "change_type", "changes", "effective_date" ], "description": "Changes or corrects a director's particulars on the register of directors: name, former names, address for service, residential address, nationality, or a corporate director's name or office. Files the updated register on VIRRGIN within 30." }, "Create_vg_director_change": { "type": "object", "properties": { "type": { "const": "vg.director.change" }, "params": { "$ref": "#/components/schemas/Params_vg_director_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a director's registered particulars", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence_of_change", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "particulars_confirmation", "title": "Director's confirmation of the new particulars", "source": "generated", "required": true }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "particulars_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_detected", "type": null, "when": "The submitted particulars match the register." }, { "code": "verification_failed", "type": null, "when": "The new ID or address evidence fails verification." }, { "code": "court_rectification_required", "type": null, "when": "The register is disputed between directors or with the company." } ] } }, "Params_vg_director_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The director being removed.", "examples": [ "per_8wNc3RbT1k" ] }, "removal_by": { "type": "string", "enum": [ "members", "directors" ], "description": "members: s.114, subject to the M&A. directors: only where the M&A permit (s.114).", "examples": [ "members" ] }, "resolution_method": { "type": "string", "enum": [ "meeting", "written_resolution" ], "description": "meeting: a meeting called for the purpose of, or for purposes including, the removal (s.114). written_resolution: needs at least 75% of the votes of those.", "examples": [ "written_resolution" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Required when resolution_method is meeting.", "examples": [ "2026-11-05" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the resolution is passed, or a later date it states.", "examples": [ "2026-10-24" ] }, "with_cause": { "type": "boolean", "description": "Recorded for the minutes.", "examples": [ "false" ] }, "replacement_director": { "type": "string", "pattern": "^per_", "description": "Opens a linked vg.director.appoint, filed in the same register filing.", "examples": [ "per_4tXq9LmC2a" ] }, "reason": { "type": "string", "description": "Free-text reason for the minutes.", "examples": [ "Board restructuring following the Series A" ] } }, "required": [ "entity_type", "director", "removal_by", "resolution_method", "effective_date" ], "description": "Removes a director by members' resolution, or by directors' resolution where the M&A permit. Produces the meeting notice or written resolution with the statutory thresholds, updates the register of directors, and files the change on." }, "Create_vg_director_remove": { "type": "object", "properties": { "type": { "const": "vg.director.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_director_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a director of a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_meeting", "title": "Notice of meeting stating the removal purpose", "source": "generated", "required": false }, { "key": "removal_resolution", "title": "Members' or directors' resolution removing the director", "source": "generated", "required": true }, { "key": "notice_to_director", "title": "Notice of removal sent to the director", "source": "generated", "required": false }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "none" }, { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "special", "percent": 50, "method": "meeting" }, { "kind": "corporate", "body": "board", "threshold": "special", "percent": 75, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "removal_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "removal_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_meeting", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_director", "type": null, "when": "Removing the only director without a replacement_director." }, { "code": "written_resolution_threshold_not_met", "type": null, "when": "Fewer than 75% of the eligible votes consent to a written removal resolution and the M&A set no lower threshold (s.114)." }, { "code": "articles_do_not_permit_removal_by_directors", "type": null, "when": "removal_by is directors but the M&A do not permit it (s.114)." }, { "code": "meeting_notice_missing_purpose", "type": null, "when": "An uploaded meeting notice does not state the removal purpose (s.114)." }, { "code": "entity_not_with_partner_registered_agent", "type": null, "when": "The company's registered agent is not Entiva." }, { "code": "filing_overdue", "type": null, "when": "More than 30 days have passed since the removal." } ] } }, "Params_vg_director_resign": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The resigning director.", "examples": [ "per_8wNc3RbT1k" ] }, "notice_received_date": { "type": "string", "format": "date", "description": "Date the company received the notice.", "examples": [ "2026-10-17" ] }, "effective_date": { "type": "string", "format": "date", "description": "A later date stated in the notice.", "examples": [ "2026-10-31" ] }, "reason": { "type": "string", "enum": [ "voluntary", "disqualified" ], "description": "disqualified: the director is or has become disqualified under s.111 and must resign forthwith (s.115).", "examples": [ "voluntary" ] }, "resignation_document": { "type": "string", "pattern": "^doc_", "description": "A resignation letter already signed outside Entiva.", "examples": [ "doc_9mN0pQ1rS2" ] }, "replacement_director": { "type": "string", "pattern": "^per_", "description": "Opens a linked vg.director.appoint so both changes go in one register filing.", "examples": [ "per_4tXq9LmC2a" ] } }, "required": [ "entity_type", "director", "reason" ], "description": "Collects the director's written resignation notice (BCA s.115), records the cessation date, updates the register of directors and files the change on VIRRGIN within 30 days (s.118B). Flags a disqualified director who must resign at once." }, "Create_vg_director_resign": { "type": "object", "properties": { "type": { "const": "vg.director.resign" }, "params": { "$ref": "#/components/schemas/Params_vg_director_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a director's resignation", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Director's written notice of resignation", "source": "generated", "required": true }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "resignation_notice", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_remaining_director", "type": null, "when": "The resignation would leave no director." }, { "code": "director_not_on_register", "type": null, "when": "The person is not a current director of the entity." }, { "code": "filing_overdue", "type": null, "when": "More than 30 days have passed since the resignation took effect." } ] } }, "Params_vg_directors_list_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "purpose": { "type": "string", "description": "Why the list is needed, for the request record.", "examples": [ "Bank account opening at a Singapore bank" ] }, "apostille": { "type": "boolean", "description": "If true, Entiva also opens an apostille action after issue.", "examples": [ "false" ] } }, "required": [ "entity_type" ], "description": "Asks the Registrar for the list of directors in the register of directors filed for the company (BCA s.118B), for example for a bank or counterparty. Fee US$75." }, "Create_vg_directors_list_request": { "type": "object", "properties": { "type": { "const": "vg.directors_list.request" }, "params": { "$ref": "#/components/schemas/Params_vg_directors_list_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request the Registrar's list of directors", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_list", "title": "Registrar's list of directors", "source": "registry_issued", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "directors_list", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Request for a list of directors", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_not_filed", "type": null, "when": "The company has not filed a register of directors, for example a restored company exempt under s.118B." } ] } }, "Params_vg_general_partner_admit": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Limited partnership under the Limited Partnership Act 2017, with or without legal personality.", "examples": [ "lp" ] }, "general_partner": { "type": "string", "pattern": "^per_", "description": "The incoming GP: an individual, body corporate or partnership (s.25).", "examples": [ "per_GpCo1Ab2Cd" ] }, "partner_kind": { "type": "string", "enum": [ "individual", "corporate" ], "description": "Individual or corporate GP.", "examples": [ "corporate" ] }, "admission_method": { "type": "string", "enum": [ "execute_lpa_or_counterpart", "accession", "transfer_of_gp_interest", "vacancy_admission_by_limited_partners" ], "description": "execute_lpa_or_counterpart or accession: s.26-. transfer_of_gp_interest: the transferee is admitted in place of or alongside the transferor (s.43)..", "examples": [ "accession" ] }, "admission_date": { "type": "string", "format": "date", "description": "Admission takes effect when the person agrees to become a GP under the LPA (s.27).", "examples": [ "2026-10-26" ] }, "particulars": { "type": "object", "description": "Register particulars (s.53).", "examples": [ "{\"corporate_name\":\"Northsound GP Ltd\",\"registration_number\":\"2154321\",\"registered_office\":{\"line1\":\"Road Town\",\"city\":\"Tortola\",\"country\":\"VG\"},\"general_partnership_interest\":\"1% GP interest, no capital commitment\"}" ] }, "capital_contribution": { "$ref": "#/components/schemas/Money", "description": "A GP may, but need not, contribute capital (s.27).", "examples": [ "{\"amount\":1000000,\"currency\":\"USD\"}" ] }, "replaces_general_partner": { "type": "string", "pattern": "^per_", "description": "The outgoing GP.", "examples": [ "per_GpOld9Zx8" ] }, "limited_partner_consent_required": { "type": "boolean", "description": "Limited partners' consent is not needed unless the LPA requires it (s.26).", "examples": [ "true" ] }, "statement_particulars_change": { "type": "boolean", "description": "True if the change alters any particular in the s.8 statement or an s.8 document, triggering a s.10 notice.", "examples": [ "false" ] } }, "required": [ "entity_type", "general_partner", "partner_kind", "admission_method", "admission_date", "particulars" ], "description": "Admits a new or replacement general partner under the limited partnership agreement. Collects the GP's written consent (s.6), runs enhanced CDD with look-through, updates the register of general partners and files it within 30 days (s.53A)." }, "Create_vg_general_partner_admit": { "type": "object", "properties": { "type": { "const": "vg.general_partner.admit" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partner_admit" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Admit a general partner to a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_consent", "title": "Incoming general partner's written consent", "source": "generated", "required": true }, { "key": "accession_agreement", "title": "Accession agreement or counterpart of the LPA", "source": "generated", "required": true }, { "key": "admission_approval", "title": "Approval of the admission under the LPA", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Corporate GP: certificate of incorporation", "source": "uploaded", "required": false }, { "key": "constitution", "title": "Corporate GP: constitution", "source": "uploaded", "required": false }, { "key": "corporate_registers_and_ownership_chart", "title": "Corporate GP: registers of directors and members, and ownership chart", "source": "uploaded", "required": false }, { "key": "source_of_funds_wealth_declaration", "title": "Source of funds and source of wealth declaration", "source": "generated", "required": true }, { "key": "updated_register_of_general_partners", "title": "Updated register of general partners", "source": "generated", "required": true }, { "key": "notice_of_change_in_registered_particulars", "title": "Notice of change in registered particulars", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "accession_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "admission_approval", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "admission_approval", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "source_of_funds_wealth_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_change_in_registered_particulars", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "updated_register_of_general_partners", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of general partners containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "general_partner_disqualified", "type": null, "when": "The incoming GP is disqualified under LPA s.25." }, { "code": "vacancy_period_expired", "type": null, "when": "admission_method is vacancy_admission_by_limited_partners, but the 90-day period, or any shorter LPA period, has passed (s.6)." }, { "code": "lpa_conditions_not_met", "type": null, "when": "The admission requirements in the LPA have not been met or waived (s.26)." }, { "code": "gp_consent_missing", "type": null, "when": "The incoming GP has not consented in writing (s.6)." }, { "code": "verification_refused", "type": null, "when": "The Entiva compliance team refuses the GP, or a party in its ownership chain, after CDD or screening." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is an unconverted Partnership Act 1996 LP." } ] } }, "Params_vg_general_partner_appoint": { "type": "object", "properties": { "general_partner": { "type": "string", "pattern": "^per_", "description": "Incoming general partner.", "examples": [ "per_3Ek5cXs8" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the admission takes effect.", "examples": [ "2026-11-01" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "Existing general partner being replaced, if any; Entiva creates a linked vg.general_partner.remove.", "examples": [ "per_7Mu2aYh6" ] }, "interest_percentage": { "type": "number", "description": "Percentage of capital, profits or votes of the general partnership interest, used for the BO calculation.", "examples": [ "1" ] }, "partnership_agreement_amendment_date": { "type": "string", "format": "date", "description": "Date of the amending agreement or deed of adherence.", "examples": [ "2026-10-30" ] } }, "required": [ "general_partner", "effective_date" ], "description": "Admits a new general partner to a BVI LP, updates the register of general partners within 30 days, and files a notice of change in registered particulars within 14 days where the statement's particulars change." }, "Create_vg_general_partner_appoint": { "type": "object", "properties": { "type": { "const": "vg.general_partner.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partner_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint or replace a general partner of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Amended partnership agreement or deed of adherence", "source": "uploaded", "required": true }, { "key": "passport", "title": "Photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Proof of residential address", "source": "uploaded", "required": false }, { "key": "certificate_of_incorporation", "title": "KYB pack for a corporate GP", "source": "uploaded", "required": false }, { "key": "register_of_partners_filing", "title": "Updated register of general partners", "source": "generated", "required": true }, { "key": "change_of_particulars_notice", "title": "Notice of change in registered particulars", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "change_of_particulars_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_partners_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Updated register of general partners", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "person_not_verified", "type": null, "when": "The incoming GP is below enhanced." }, { "code": "no_general_partner_remaining", "type": null, "when": "The change would leave the LP without a general partner." }, { "code": "partner_approval_missing", "type": null, "when": "The partnership agreement's consent requirement is not evidenced." }, { "code": "filing_deadline_passed", "type": null, "when": "Register filing beyond 30 days or particulars notice beyond 14 days; penalty added at cost." } ] } }, "Params_vg_general_partner_remove": { "type": "object", "properties": { "general_partner": { "type": "string", "pattern": "^per_", "description": "The general partner ceasing.", "examples": [ "per_7Mu2aYh6" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the GP ceases.", "examples": [ "2026-11-01" ] }, "reason": { "type": "string", "enum": [ "withdrawal", "removal", "replacement", "dissolution" ], "description": "Why the GP ceases.", "examples": [ "replacement" ] }, "replacement": { "type": "string", "pattern": "^per_", "description": "Incoming GP; links to vg.general_partner.appoint.", "examples": [ "per_3Ek5cXs8" ] } }, "required": [ "general_partner", "effective_date" ], "description": "Records a general partner ceasing to act, updates the register of general partners within 30 days, and files a notice of change in particulars within 14 days where needed." }, "Create_vg_general_partner_remove": { "type": "object", "properties": { "type": { "const": "vg.general_partner.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partner_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove or record withdrawal of a general partner of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Amendment, withdrawal notice or removal instrument", "source": "uploaded", "required": true }, { "key": "register_of_partners_filing", "title": "Updated register of general partners", "source": "generated", "required": true }, { "key": "change_of_particulars_notice", "title": "Notice of change in registered particulars", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "none" }, { "role": "general_partner", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "change_of_particulars_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_partners_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Updated register of general partners", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_general_partner_remaining", "type": null, "when": "No GP would remain and no replacement is supplied." }, { "code": "general_partner_not_on_register", "type": null, "when": "The person is not on the register of general partners." }, { "code": "filing_deadline_passed", "type": null, "when": "Beyond 30 days or 14 days; penalty added at cost." } ] } }, "Params_vg_general_partner_withdraw": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Limited partnership type.", "examples": [ "lp" ] }, "general_partner": { "type": "string", "pattern": "^per_", "description": "The outgoing GP.", "examples": [ "per_GpOld9Zx8" ] }, "cessation_type": { "type": "string", "enum": [ "voluntary_withdrawal", "removal_under_lpa", "transfer_of_entire_interest", "death", "dissolution_or_bankruptcy" ], "description": "How the GP leaves.", "examples": [ "removal_under_lpa" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the event under the LPA.", "examples": [ "2026-10-26" ] }, "replacement_general_partner": { "type": "string", "pattern": "^per_", "description": "Opens or links vg.general_partner.admit.", "examples": [ "per_GpCo1Ab2Cd" ] }, "statement_particulars_change": { "type": "boolean", "description": "True if an s.8 statement particular or an s.8 document changes, which needs an s.10 notice.", "examples": [ "false" ] } }, "required": [ "entity_type", "general_partner", "cessation_type", "effective_date" ], "description": "Records a general partner ceasing to act, whether by withdrawal, removal under the LPA, transfer of its whole interest, death or dissolution. Files the register of general partners change within 30 days (LPA s.53A)." }, "Create_vg_general_partner_withdraw": { "type": "object", "properties": { "type": { "const": "vg.general_partner.withdraw" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partner_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a general partner's withdrawal or removal", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "withdrawal_or_removal_instrument", "title": "GP's withdrawal notice, or the partners' removal resolution", "source": "generated", "required": true }, { "key": "evidence_of_death_or_dissolution", "title": "Death certificate, or evidence of dissolution or bankruptcy", "source": "uploaded", "required": false }, { "key": "updated_register_of_general_partners", "title": "Updated register of general partners", "source": "generated", "required": true }, { "key": "notice_of_change_in_registered_particulars", "title": "Notice of change in registered particulars", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "withdrawal_or_removal_instrument", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "withdrawal_or_removal_instrument", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_change_in_registered_particulars", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "updated_register_of_general_partners", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of general partners containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_general_partner", "type": null, "when": "No GP would remain and no replacement is named." }, { "code": "lpa_removal_threshold_not_met", "type": null, "when": "The limited partners' consents fall short of the LPA threshold." } ] } }, "Params_vg_general_partners_list_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Limited partnership type.", "examples": [ "lp" ] }, "purpose": { "type": "string", "description": "Why the list is needed.", "examples": [ "Investor due diligence request" ] } }, "required": [ "entity_type" ], "description": "Asks the Registrar for the list of general partners in the register of general partners filed for the LP (LPA s.53A), for example for a bank, investor or counterparty. Fee US$50." }, "Create_vg_general_partners_list_request": { "type": "object", "properties": { "type": { "const": "vg.general_partners_list.request" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partners_list_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request the Registrar's list of general partners", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "general_partners_list", "title": "Registrar's list of general partners", "source": "registry_issued", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "general_partners_list", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Request for a list of general partners", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "register_not_filed", "type": null, "when": "The LP has not filed its register of general partners, for example a restored LP exempt under s.53A." } ] } }, "Params_vg_licensed_director_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "provider": { "type": "string", "enum": [ "entiva_partner", "third_party_licensee" ], "description": "entiva_partner: a director from Entiva. third_party_licensee: another FSC licensee.", "examples": [ "entiva_partner" ] }, "licensee": { "type": "object", "description": "The FSC licensee: name, licence_type, licence_number and bvi_address.", "examples": [ "{\"name\":\"Example Corporate Services (BVI) Ltd\",\"licence_type\":\"company_management_act\",\"licence_number\":\"CM-0000\",\"bvi_address\":{\"line1\":\"Road Town\",\"city\":\"Tortola\",\"country\":\"VG\"}}" ] }, "appointed_as": { "type": "string", "enum": [ "licensed_corporate_entity", "individual_representing_licensee" ], "description": "As the licensed corporate entity itself, or as an individual representing the licensee (s.118).", "examples": [ "individual_representing_licensee" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The licensee as a corporate person, or the individual representing it.", "examples": [ "per_5kLm8NbV2c" ] }, "acts_on_behalf_of": { "type": "object", "description": "Where applicable, the name and address of the individual on whose behalf the licensee acts (s.118A).", "examples": [ "{\"name\":\"Wei Chen\",\"address\":{\"line1\":\"88 Queensway\",\"city\":\"Hong Kong\",\"country\":\"HK\"}}" ] }, "instructing_persons": { "type": "array", "items": {}, "description": "person_refs of everyone whose instructions the professional director customarily accepts.", "examples": [ "[\"per_7aSd2FgH4j\"]" ] }, "appointing_body": { "type": "string", "enum": [ "members", "directors" ], "description": "As for vg.director.appoint (s.113,).", "examples": [ "members" ] }, "resolution_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "Written resolution or meeting.", "examples": [ "written_resolution" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-10-23" ] }, "director_services_agreement": { "type": "string", "pattern": "^doc_", "description": "The agreement with a third-party licensee, if already signed.", "examples": [ "doc_2qW3eR4tY5" ] } }, "required": [ "entity_type", "provider", "licensee", "appointed_as", "director", "instructing_persons", "appointing_body", "resolution_method", "effective_date" ], "description": "Appoints a director provided by an FSC licensee holding a Company Management Act or Banks and Trust Companies Act licence. The licensee may be Entiva or a third party." }, "Create_vg_licensed_director_appoint": { "type": "object", "properties": { "type": { "const": "vg.licensed_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_licensed_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a professional director", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "licence_check", "title": "FSC licence verification for the licensee", "source": "generated", "required": true }, { "key": "director_services_agreement", "title": "Director services agreement", "source": "generated", "required": true }, { "key": "instructing_person_disclosure", "title": "Disclosure of the instructing person", "source": "generated", "required": true }, { "key": "appointment_resolution", "title": "Members' or directors' resolution appointing the director", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Written consent to act as director", "source": "generated", "required": true }, { "key": "updated_register_of_directors", "title": "Updated register of directors with the licensed-director disclosure", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "other", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "director_services_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "director_services_agreement", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "instructing_person_disclosure", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "appointment_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Register of directors filing with the s.118", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "licensee_not_found", "type": null, "when": "The licensee is not on the FSC register of licensees, or its licence does not cover director services." }, { "code": "unlicensed_director_service", "type": null, "when": "A person proposes to provide directors for profit or reward in or from within the BVI without a licence." }, { "code": "instructing_person_not_disclosed", "type": null, "when": "The provider has not disclosed who instructs the director." }, { "code": "director_disqualified", "type": null, "when": "The individual is disqualified under BCA s.111." }, { "code": "entity_not_with_partner_registered_agent", "type": null, "when": "The company's registered agent is not Entiva." } ] } }, "Params_vg_licensed_director_disclosure_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The professional director already on the register.", "examples": [ "per_5kLm8NbV2c" ] }, "changes": { "type": "object", "description": "Only the fields that change: licensee and acts_on_behalf_of.", "examples": [ "{\"acts_on_behalf_of\":{\"name\":\"Priya Raman\",\"address\":{\"line1\":\"1 Raffles Place\",\"city\":\"Singapore\",\"country\":\"SG\"}}}" ] }, "instructing_persons": { "type": "array", "items": {}, "description": "Updated list of person_refs for the Code s.25A disclosure.", "examples": [ "[\"per_1zXc4VbN6m\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change.", "examples": [ "2026-10-12" ] } }, "required": [ "entity_type", "director", "changes", "effective_date" ], "description": "Updates the s.118 and s.118A details for a director provided by an FSC licensee: the licensee's name or licence, and the name and address of the individual it acts for. Also refreshes the Code s.25A instructing-person disclosure, and files." }, "Create_vg_licensed_director_disclosure_change": { "type": "object", "properties": { "type": { "const": "vg.licensed_director_disclosure.change" }, "params": { "$ref": "#/components/schemas/Params_vg_licensed_director_disclosure_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a professional director's licensee disclosure", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "licensee_notice_of_change", "title": "Licensee's notice of the change", "source": "generated", "required": true }, { "key": "instructing_person_disclosure", "title": "Updated instructing-person disclosure", "source": "generated", "required": false }, { "key": "updated_register_of_directors", "title": "Updated register of directors with the disclosure", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "licensee_notice_of_change", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "instructing_person_disclosure", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors with the updated s.118", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_licensed_director", "type": null, "when": "The director is not recorded as provided by an FSC licensee." }, { "code": "director_replacement_required", "type": null, "when": "The change replaces the individual who is the director." } ] } }, "Params_vg_limited_partner_admit": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Limited partnership type.", "examples": [ "lp" ] }, "limited_partner": { "type": "string", "pattern": "^per_", "description": "The incoming limited partner, which may be an individual, body corporate or partnership (s.25).", "examples": [ "per_LpInv3Qw4" ] }, "partner_kind": { "type": "string", "enum": [ "individual", "corporate" ], "description": "Individual or corporate.", "examples": [ "corporate" ] }, "admission_method": { "type": "string", "enum": [ "execute_lpa_or_counterpart", "accession", "in_accordance_with_act" ], "description": "LPA s.26-.", "examples": [ "accession" ] }, "admission_date": { "type": "string", "format": "date", "description": "Date of admission.", "examples": [ "2026-11-02" ] }, "commitment": { "$ref": "#/components/schemas/Money", "description": "Capital commitment.", "examples": [ "{\"amount\":500000000,\"currency\":\"USD\"}" ] }, "interest_percentage": { "type": "number", "description": "Share of capital, profits or votes after admission.", "examples": [ "12.5" ] }, "particulars": { "type": "object", "description": "Register particulars (s.53, applying s.53): name including former names, residential address, date and place of birth, and nationality.", "examples": [ "{\"corporate_name\":\"Harbour Pension Trustees Ltd\",\"registration_number\":\"C-778812\",\"registered_office\":{\"line1\":\"10 Bay Street\",\"city\":\"Toronto\",\"country\":\"CA\"}}" ] }, "is_recognised_fund": { "type": "boolean", "description": "True if the LP is a fund recognised under SIBA, or an incubator or approved fund.", "examples": [ "false" ] } }, "required": [ "entity_type", "limited_partner", "partner_kind", "admission_method", "admission_date", "interest_percentage", "particulars", "is_recognised_fund" ], "description": "Admits a new limited partner by subscription and accession, by executing the LPA or a counterpart, or otherwise under the Act. Verifies the investor according to their share, updates the register of limited partners, and files it within 30." }, "Create_vg_limited_partner_admit": { "type": "object", "properties": { "type": { "const": "vg.limited_partner.admit" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partner_admit" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Admit a limited partner to a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "subscription_agreement", "title": "Subscription agreement", "source": "uploaded", "required": false }, { "key": "accession_agreement", "title": "Accession agreement or LPA counterpart", "source": "generated", "required": true }, { "key": "gp_acceptance", "title": "General partner's acceptance of the admission", "source": "generated", "required": true }, { "key": "kyb_pack", "title": "Corporate limited partner: certificate of incorporation, constitution, registers and ownership chart", "source": "uploaded", "required": false }, { "key": "source_of_funds_wealth_declaration", "title": "Source of funds and source of wealth declaration", "source": "generated", "required": false }, { "key": "updated_register_of_limited_partners", "title": "Updated register of limited partners", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "accession_agreement", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gp_acceptance", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "source_of_funds_wealth_declaration", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "updated_register_of_limited_partners", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of limited partners containing the change", "channel": "online", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "lpa_conditions_not_met", "type": null, "when": "The admission requirements in the LPA are not met or waived (s.26)." }, { "code": "transfer_action_required", "type": null, "when": "The person is entering by transfer of an existing interest." }, { "code": "verification_refused", "type": null, "when": "The Entiva compliance team refuses the investor." } ] } }, "Params_vg_limited_partner_withdraw": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Limited partnership type.", "examples": [ "lp" ] }, "limited_partner": { "type": "string", "pattern": "^per_", "description": "The departing limited partner.", "examples": [ "per_LpInv3Qw4" ] }, "cessation_type": { "type": "string", "enum": [ "withdrawal_under_lpa", "redemption", "compulsory_removal", "death", "dissolution" ], "description": "How the limited partner leaves.", "examples": [ "redemption" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the limited partner ceases.", "examples": [ "2026-12-31" ] }, "return_of_contribution": { "$ref": "#/components/schemas/Money", "description": "Any payment returning contributions, or any release of commitment.", "examples": [ "{\"amount\":250000000,\"currency\":\"USD\"}" ] }, "is_recognised_fund": { "type": "boolean", "description": "If true, the register of limited partners is not filed (s.53A).", "examples": [ "false" ] } }, "required": [ "entity_type", "limited_partner", "cessation_type", "effective_date", "is_recognised_fund" ], "description": "Records a limited partner leaving the LP by withdrawal or redemption under the LPA, compulsory removal, death or dissolution. Runs the s.36 solvency check on any return of contributions or release of commitment, and files the register of." }, "Create_vg_limited_partner_withdraw": { "type": "object", "properties": { "type": { "const": "vg.limited_partner.withdraw" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partner_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a limited partner's withdrawal", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "withdrawal_instrument", "title": "Withdrawal notice, redemption agreement or removal notice", "source": "generated", "required": true }, { "key": "gp_approval", "title": "General partner's approval under the LPA", "source": "generated", "required": true }, { "key": "solvency_confirmation", "title": "General partner's confirmation of solvency", "source": "generated", "required": false }, { "key": "evidence_of_death_or_dissolution", "title": "Death certificate or dissolution evidence", "source": "uploaded", "required": false }, { "key": "updated_register_of_limited_partners", "title": "Updated register of limited partners", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "limited_partner", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "withdrawal_instrument", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gp_approval", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "solvency_confirmation", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_limited_partners", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of limited partners containing the change", "channel": "online", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "lp_not_solvent_for_return", "type": null, "when": "The solvency confirmation is not given." }, { "code": "last_limited_partner", "type": null, "when": "No limited partner would remain." }, { "code": "transfer_action_required", "type": null, "when": "The exit is a transfer of the interest to another person." } ] } }, "Params_vg_lp_particulars_change": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date the particulars changed.", "examples": [ "2026-10-15" ] }, "changes": { "type": "object", "description": "The registered particulars that change, as {field: new_value}.", "examples": [ "{\"registered_office\":{\"line1\":\"Suite 4, 18 Harbour Road\",\"city\":\"Road Town\",\"country\":\"VG\"}}" ] }, "related_action": { "type": "string", "pattern": "^ent_", "description": "A GP or LP change action that causes this notice.", "examples": [ "act_0QaK4uSe" ] } }, "required": [ "effective_date", "changes" ], "description": "Files the LPA s.10 notice of change when particulars in the registration statement change within 14 days." }, "Create_vg_lp_particulars_change": { "type": "object", "properties": { "type": { "const": "vg.lp_particulars.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_particulars_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a notice of change in registered particulars of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_of_particulars_notice", "title": "Notice of change in registered particulars", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "change_of_particulars_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "change_of_particulars_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change in registered particulars", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_supplied", "type": null, "when": "changes is empty." }, { "code": "unknown_particular", "type": null, "when": "A field in changes is not a registered particular of the LP." }, { "code": "filing_deadline_passed", "type": null, "when": "More than 14 days after effective_date; penalty added at cost." } ] } }, "Params_vg_nominee_director_appoint": { "type": "object", "properties": { "director": { "type": "string", "pattern": "^per_", "description": "The licensee's corporate entity or the individual it provides.", "examples": [ "per_4Hg7sLk2" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-10-22" ] }, "appointed_by": { "type": "string", "enum": [ "members_resolution", "directors_resolution" ], "description": "Organ that appoints, as the articles permit.", "examples": [ "directors_resolution" ] }, "licensee_name": { "type": "string", "description": "Name of the FSC licensee providing the director.", "examples": [ "Example Corporate Services Ltd" ] }, "licence_type": { "type": "string", "enum": [ "company_management_act", "banks_and_trust_companies_act" ], "description": "Licence under which the licensee acts.", "examples": [ "company_management_act" ] }, "licence_number": { "type": "string", "description": "FSC licence reference, checked against the FSC register of licensees.", "examples": [ "CM-0000" ] }, "acts_as": { "type": "string", "enum": [ "licensed_entity", "individual" ], "description": "Whether the licensee acts as the director itself or through an individual (s.118).", "examples": [ "individual" ] }, "individual_acted_for": { "type": "string", "pattern": "^per_", "description": "Individual on whose behalf the licensee acts (s.118A).", "examples": [ "per_9Zb3nVd5" ] }, "instructing_person": { "type": "string", "pattern": "^per_", "description": "Person whose instructions the nominee director accepts, disclosed to the company.", "examples": [ "per_2Jc8pQw7" ] }, "occupation": { "type": "string", "description": "Occupation for the register.", "examples": [ "Professional director" ] } }, "required": [ "director", "effective_date", "appointed_by", "licensee_name", "licence_type", "licence_number", "acts_as", "instructing_person" ], "description": "Appoints a director supplied by an FSC licensee and files the licensed-director disclosure with the register of directors (BCA ss.118, 118A). The BVI has no resident-director requirement." }, "Create_vg_nominee_director_appoint": { "type": "object", "properties": { "type": { "const": "vg.nominee_director.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_nominee_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a professional director at a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_services_agreement", "title": "Director services agreement with the licensee", "source": "uploaded", "required": true }, { "key": "consent_to_act", "title": "Director's written consent to act", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution appointing the director", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Members' resolution appointing the director", "source": "generated", "required": false }, { "key": "passport", "title": "Photo ID of the individual director and of the instructing person", "source": "uploaded", "required": true }, { "key": "register_of_directors_filing", "title": "Updated register of directors filing with licensed-director disclosure", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "consent_to_act", "signer_role": "nominee_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_directors_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Register of directors with licensed-director information", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "licence_not_found", "type": null, "when": "The licensee or licence number is not on the FSC register of licensees." }, { "code": "licensed_director_disclosure_incomplete", "type": null, "when": "acts_as is individual but individual_acted_for is missing, or instructing_person is missing." }, { "code": "person_not_verified", "type": null, "when": "Any named person is below identity_address." }, { "code": "human_signature_required", "type": null, "when": "An agent tries to sign the consent or a directors' resolution." } ] } }, "Params_vg_nominee_director_change": { "type": "object", "properties": { "director": { "type": "string", "pattern": "^per_", "description": "The licensed director already on the register.", "examples": [ "per_4Hg7sLk2" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change.", "examples": [ "2026-11-05" ] }, "licensee_name": { "type": "string", "description": "New licensee name, if changed.", "examples": [ "Example Corporate Services Ltd" ] }, "licence_number": { "type": "string", "description": "New FSC licence reference.", "examples": [ "CM-0001" ] }, "acts_as": { "type": "string", "enum": [ "licensed_entity", "individual" ], "description": "New capacity.", "examples": [ "licensed_entity" ] }, "individual_acted_for": { "type": "string", "pattern": "^per_", "description": "New individual on whose behalf the licensee acts.", "examples": [ "per_9Zb3nVd5" ] }, "instructing_person": { "type": "string", "pattern": "^per_", "description": "New instructing person disclosed to the company.", "examples": [ "per_2Jc8pQw7" ] } }, "required": [ "director", "effective_date" ], "description": "Updates the licensed-director information on the register of directors without changing the director, and files it within 30 days." }, "Create_vg_nominee_director_change": { "type": "object", "properties": { "type": { "const": "vg.nominee_director.change" }, "params": { "$ref": "#/components/schemas/Params_vg_nominee_director_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update licensed-director disclosure at a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "director_services_agreement", "title": "Updated director services agreement", "source": "uploaded", "required": false }, { "key": "register_of_directors_filing", "title": "Updated register of directors filing", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "registered_agent", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "register_of_directors_filing", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Updated register of directors with licensed-director information", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_licensed_director", "type": null, "when": "The director was not appointed as a licensed director." }, { "code": "licence_not_found", "type": null, "when": "The new licence number is not on the FSC register." }, { "code": "licensed_director_disclosure_incomplete", "type": null, "when": "acts_as is individual without individual_acted_for." } ] } }, "Params_vg_officer_appoint": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "The person appointed.", "examples": [ "per_9oP8iU7yT6" ] }, "title": { "type": "string", "enum": [ "secretary", "president", "vice_president", "treasurer", "chief_executive_officer", "chief_financial_officer", "other" ], "description": "Office held.", "examples": [ "secretary" ] }, "title_other": { "type": "string", "description": "Required when title is other.", "examples": [ "General Counsel" ] }, "powers": { "type": "string", "description": "Duties and powers delegated by the directors under the articles.", "examples": [ "Keep minutes and registers; authenticate documents under s.107(1)" ] }, "authorised_signatory": { "type": "boolean", "description": "True if the officer will sign or act for the company, for example authenticating documents (s.107) or signing contracts (s.103).", "examples": [ "true" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of appointment.", "examples": [ "2026-10-20" ] }, "term": { "type": "string", "description": "Term, if the directors fix one.", "examples": [ "Until removed by the board" ] }, "provided_by_licensee": { "type": "boolean", "description": "True if the officer is supplied for reward by a corporate services provider.", "examples": [ "false" ] } }, "required": [ "entity_type", "officer", "title", "authorised_signatory", "effective_date" ], "description": "Appoints an optional officer, such as a secretary, president or treasurer, by directors' resolution under the articles. A BVI company needs no statutory secretary, and nothing is filed with the Registry." }, "Create_vg_officer_appoint": { "type": "object", "properties": { "type": { "const": "vg.officer.appoint" }, "params": { "$ref": "#/components/schemas/Params_vg_officer_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an officer or company secretary", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution appointing the officer", "source": "generated", "required": true }, { "key": "officer_acceptance", "title": "Officer's acceptance of appointment", "source": "generated", "required": false }, { "key": "specimen_signature", "title": "Specimen signature", "source": "uploaded", "required": false }, { "key": "passport", "title": "Officer's photo ID", "source": "uploaded", "required": false }, { "key": "officer_list", "title": "Updated officer list", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "officer_acceptance", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "None. Officers are not filed with the BVI Registry of Corporate Affairs", "form": "No Registry form. The directors' resolution is kept with the minutes", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "articles_do_not_provide_for_officers", "type": null, "when": "The M&A do not allow the directors to appoint officers, or restrict who may be appointed." }, { "code": "unlicensed_officer_service", "type": null, "when": "provided_by_licensee is true but the provider holds no FSC licence for company management business." }, { "code": "verification_refused", "type": null, "when": "A signatory officer fails CDD or screening." } ] } }, "Params_vg_officer_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "The officer leaving office.", "examples": [ "per_9oP8iU7yT6" ] }, "cessation_type": { "type": "string", "enum": [ "removal", "resignation", "term_expired" ], "description": "How the appointment ends.", "examples": [ "resignation" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment ends.", "examples": [ "2026-11-30" ] }, "revoke_signing_authority": { "type": "boolean", "description": "Default true.", "examples": [ "true" ] }, "replacement": { "type": "string", "pattern": "^per_", "description": "Opens a linked vg.officer.appoint.", "examples": [ "per_0lK9jH8gF7" ] } }, "required": [ "entity_type", "officer", "cessation_type", "effective_date" ], "description": "Ends an officer's or secretary's appointment by directors' resolution, on the officer's resignation, or at the end of their term. Withdraws any signing authority and linked mandates, and records the change in the minutes and Entiva's." }, "Create_vg_officer_remove": { "type": "object", "properties": { "type": { "const": "vg.officer.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_officer_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove an officer or record an officer's resignation", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution removing the officer", "source": "generated", "required": false }, { "key": "resignation_letter", "title": "Officer's resignation letter", "source": "generated", "required": false }, { "key": "officer_list", "title": "Updated officer list", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "resignation_letter", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. Officers are not filed with the BVI Registry of Corporate Affairs", "form": "No Registry form. Recorded in the minutes", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_an_officer", "type": null, "when": "The person holds no recorded office." } ] } }, "Params_vg_partner_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Limited partnership type.", "examples": [ "lp" ] }, "partner": { "type": "string", "pattern": "^per_", "description": "The partner whose particulars change.", "examples": [ "per_GpCo1Ab2Cd" ] }, "register": { "type": "string", "enum": [ "general_partners", "limited_partners" ], "description": "Which register the change affects.", "examples": [ "general_partners" ] }, "change_type": { "type": "string", "enum": [ "change", "correction" ], "description": "change: the facts changed. correction: the register held an error.", "examples": [ "change" ] }, "changes": { "type": "object", "description": "Only the fields that change, from s.53: full_name, former names, residential_address, date_of_birth, place_of_birth and nationality for individuals.", "examples": [ "{\"registered_office\":{\"line1\":\"Wickhams Cay II\",\"city\":\"Road Town\",\"country\":\"VG\"}}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change.", "examples": [ "2026-10-14" ] }, "is_recognised_fund": { "type": "boolean", "description": "If true, changes to the register of limited partners are not filed (s.53A).", "examples": [ "false" ] } }, "required": [ "entity_type", "partner", "register", "change_type", "changes", "effective_date", "is_recognised_fund" ], "description": "Changes or corrects a general or limited partner's particulars on the partner registers: name, former names, residential address, nationality, a corporate partner's name or office, or the particulars of a GP's interest. Files the updated." }, "Create_vg_partner_change": { "type": "object", "properties": { "type": { "const": "vg.partner.change" }, "params": { "$ref": "#/components/schemas/Params_vg_partner_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update a partner's registered particulars", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "evidence_of_change", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "particulars_confirmation", "title": "Partner's confirmation of the new particulars", "source": "generated", "required": true }, { "key": "updated_partner_register", "title": "Updated register of general or limited partners", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "particulars_confirmation", "signer_role": "partner", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_partner_register", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of general partners or limited partners containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_change_detected", "type": null, "when": "The particulars match the register." }, { "code": "statement_particulars_affected", "type": null, "when": "The change also affects the s.8 statement, for example the LP's name, registered office, registered agent or term." } ] } }, "Params_vg_reserve_director_cease": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "reserve_director": { "type": "string", "pattern": "^per_", "description": "The reserve director.", "examples": [ "per_6yUi3OpL9d" ] }, "reason": { "type": "string", "enum": [ "revoked_by_sole_member_director", "resigned_by_reserve_director", "nominator_ceased_to_be_sole_member_director" ], "description": "revoked_by_sole_member_director: s.113. resigned_by_reserve_director: s.113. nominator_ceased_to_be_sole_member_director: s.113, for example after a share.", "examples": [ "revoked_by_sole_member_director" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of revocation, resignation or the triggering event.", "examples": [ "2026-11-15" ] }, "triggering_action": { "type": "string", "description": "act_ id of the share or director action that ended sole member and director status, for s.113.", "examples": [ "act_Vg9ShAllot2" ] } }, "required": [ "entity_type", "reserve_director", "reason", "effective_date" ], "description": "Ends a reserve director's nomination before the nominator's death (BCA s.113). This happens when the sole member and director revokes it in writing, when the reserve director resigns, or automatically when the nominator stops being the." }, "Create_vg_reserve_director_cease": { "type": "object", "properties": { "type": { "const": "vg.reserve_director.cease" }, "params": { "$ref": "#/components/schemas/Params_vg_reserve_director_cease" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "End a reserve director's nomination", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "revocation_or_resignation", "title": "Written revocation or resignation", "source": "generated", "required": false }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "enhanced" }, { "role": "reserve_director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "revocation_or_resignation", "signer_role": "reserve_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors containing the change", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_active_nomination", "type": null, "when": "The person has no active reserve director nomination." }, { "code": "nominator_deceased", "type": null, "when": "The nominator has died." } ] } }, "Params_vg_reserve_director_nominate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the company.", "examples": [ "bc_ltd_shares" ] }, "sole_member_director": { "type": "string", "pattern": "^per_", "description": "The individual who is both the sole member and the sole director.", "examples": [ "per_8wNc3RbT1k" ] }, "reserve_director": { "type": "string", "pattern": "^per_", "description": "The nominee.", "examples": [ "per_6yUi3OpL9d" ] }, "nomination_date": { "type": "string", "format": "date", "description": "Date of the written instrument.", "examples": [ "2026-10-22" ] } }, "required": [ "entity_type", "sole_member_director", "reserve_director", "nomination_date" ], "description": "Where a company's only member is an individual who is also its sole director, that person nominates a reserve director in writing to act in their place on their death (BCA s.113). Collects the nominee's consent, verifies the nominee, and." }, "Create_vg_reserve_director_nominate": { "type": "object", "properties": { "type": { "const": "vg.reserve_director.nominate" }, "params": { "$ref": "#/components/schemas/Params_vg_reserve_director_nominate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Nominate a reserve director", "x-entiva": { "jurisdiction": "vg", "stage": "officers_and_people", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nomination_instrument", "title": "Instrument in writing nominating the reserve director", "source": "generated", "required": true }, { "key": "consent_to_be_nominated", "title": "Reserve director's written consent", "source": "generated", "required": true }, { "key": "passport", "title": "Reserve director's photo ID", "source": "uploaded", "required": true }, { "key": "proof_of_address", "title": "Reserve director's proof of address", "source": "uploaded", "required": false }, { "key": "updated_register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "reserve_director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "sole", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "nomination_instrument", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_be_nominated", "signer_role": "reserve_director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "updated_register_of_directors", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of directors including the reserve director's nomination", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_sole_member_director", "type": null, "when": "The company has more than one member or director, or its sole member is not an individual (s.113)." }, { "code": "reserve_director_disqualified", "type": null, "when": "The nominee is disqualified under s.111." }, { "code": "reserve_director_already_nominated", "type": null, "when": "An active nomination exists." } ] } }, "Params_vg_authorised_shares_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "maximum_shares": { "type": "integer", "description": "New maximum number of shares.", "examples": [ "100000" ] }, "authorise_unlimited": { "type": "boolean", "description": "Authorise an unlimited number of shares.", "examples": [ "false" ] }, "class_allocation": { "type": "array", "items": {}, "description": "Per-class maximums where the memorandum states them: [{share_class, new_maximum, par_value}].", "examples": [ "[{\"share_class\":\"Ordinary\",\"new_maximum\":100000,\"par_value\":{\"amount\":1,\"currency\":\"USD\"}}]" ] }, "resolution_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Who amends the memorandum.", "examples": [ "members" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the resolution.", "examples": [ "2026-10-21" ] }, "filing_mode": { "type": "string", "enum": [ "notice_of_amendment", "restated_memorandum" ], "description": "File a notice of amendment or a restated memorandum (s.13).", "examples": [ "notice_of_amendment" ] } }, "required": [ "entity_type", "resolution_body", "resolution_date" ], "description": "Amends the memorandum to change the maximum number of shares the company is authorised to issue, or to authorise an unlimited number. Members pass the resolution under BCA s.12, or directors do where the memorandum lets them (s.12)." }, "Create_vg_authorised_shares_change": { "type": "object", "properties": { "type": { "const": "vg.authorised_shares.change" }, "params": { "$ref": "#/components/schemas/Params_vg_authorised_shares_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the maximum number of shares the company may issue", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' resolution amending the memorandum", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Directors' resolution amending the memorandum", "source": "generated", "required": false }, { "key": "notice_of_amendment", "title": "Notice of amendment of memorandum", "source": "generated", "required": true }, { "key": "s40_notice", "title": "Notice of change in number of shares the company is authorised to issue", "source": "generated", "required": true }, { "key": "current_memorandum", "title": "Current memorandum and articles", "source": "uploaded", "required": false }, { "key": "registered_amendment", "title": "Registered notice of amendment or restated memorandum", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "s40_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of amendment of memorandum, or restated memorandum", "channel": "online", "government_fee": { "amount": 300, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "below_issued_shares", "type": null, "when": "The new maximum is below the number of shares already in issue in the class." }, { "code": "directors_not_authorised", "type": null, "when": "resolution_body is directors and the memorandum does not authorise them, or s.12 applies." }, { "code": "amendment_restricted_by_memorandum", "type": null, "when": "The memorandum entrenches the provision or requires a higher majority or conditions that are not met (s.12)." }, { "code": "s40_notice_missing", "type": null, "when": "The s.40 notice is not filed with the notice of amendment." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent's mandate does not cover constitutional changes." } ] } }, "Params_vg_distribution_declare": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "distribution_type": { "type": "string", "enum": [ "cash_dividend", "in_specie", "other_distribution" ], "description": "Kind of distribution.", "examples": [ "cash_dividend" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class entitled.", "examples": [ "Ordinary" ] }, "amount_per_share": { "$ref": "#/components/schemas/Money", "description": "Amount per share for a cash dividend.", "examples": [ "{\"amount\":0.5,\"currency\":\"USD\"}" ] }, "total_amount": { "$ref": "#/components/schemas/Money", "description": "Total value distributed.", "examples": [ "{\"amount\":22500,\"currency\":\"USD\"}" ] }, "record_date": { "type": "string", "format": "date", "description": "Date for fixing the members entitled.", "examples": [ "2026-10-31" ] }, "payment_date": { "type": "string", "format": "date", "description": "Date of payment.", "examples": [ "2026-11-14" ] }, "solvency_assessment": { "type": "object", "description": "{total_assets, total_liabilities, as_of, able_to_pay_debts_as_due, cash_flow_forecast, basis}.", "examples": [ "{\"total_assets\":{\"amount\":3200000,\"currency\":\"USD\"},\"total_liabilities\":{\"amount\":900000,\"currency\":\"USD\"},\"as_of\":\"2026-09-30\",\"able_to_pay_debts_as_due\":true}" ] }, "in_specie_assets": { "type": "array", "items": {}, "description": "For in_specie: [{description, value, transfer_method}].", "examples": [ "[{\"description\":\"100% of shares in SubCo Ltd\",\"value\":{\"amount\":22500,\"currency\":\"USD\"},\"transfer_method\":\"instrument_of_transfer\"}]" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio whose shares receive the distribution.", "examples": [ "Alpha Segregated Portfolio" ] }, "waivers": { "type": "array", "items": {}, "description": "Members waiving their entitlement: [{member, shares}].", "examples": [ "[]" ] } }, "required": [ "entity_type", "distribution_type", "total_amount", "record_date", "payment_date", "solvency_assessment" ], "description": "Directors authorise a dividend or other distribution by resolution (BCA s.57), if they are satisfied on reasonable grounds that the company will satisfy the solvency test immediately after it. The test is that assets exceed liabilities and." }, "Create_vg_distribution_declare": { "type": "object", "properties": { "type": { "const": "vg.distribution.declare" }, "params": { "$ref": "#/components/schemas/Params_vg_distribution_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a dividend or other distribution", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_resolution_distribution", "title": "Directors' resolution authorising the distribution", "source": "generated", "required": true }, { "key": "solvency_support", "title": "Management accounts and cash-flow forecast", "source": "uploaded", "required": true }, { "key": "pre_payment_confirmation", "title": "Directors' confirmation before payment", "source": "generated", "required": true }, { "key": "dividend_notice", "title": "Notice to members", "source": "generated", "required": false }, { "key": "payment_schedule", "title": "Payment schedule by member", "source": "generated", "required": true }, { "key": "waiver_letters", "title": "Dividend waivers", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "directors_resolution_distribution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "pre_payment_confirmation", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "waiver_letters", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "dividend_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. Distributions are not filed with the Registrar of Corporate Affairs", "form": "Directors' resolution kept with the minutes", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "solvency_statement_missing", "type": null, "when": "The resolution lacks the s.57 statement." }, { "code": "solvency_test_not_met", "type": null, "when": "Liabilities would equal or exceed assets after the distribution, or the company could not pay debts as they fall due (s.56)." }, { "code": "directors_ceased_satisfied", "type": null, "when": "A director declines the pre-payment confirmation." }, { "code": "portfolio_cross_subsidy", "type": null, "when": "An SPC portfolio distribution relies on another portfolio's or general assets (s.141-)." }, { "code": "treasury_shares_excluded", "type": null, "when": "The schedule includes treasury shares, whose rights are suspended (s.64)." }, { "code": "sanctions_hold", "type": null, "when": "A payee matches a sanctions list." } ] } }, "Params_vg_fair_value_appraisal_hold": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "trigger": { "type": "string", "enum": [ "s176_redemption", "merger", "consolidation", "asset_disposition_s175", "arrangement", "lp_merger", "lp_consolidation", "lp_s79_redemption" ], "description": "The action dissented from.", "examples": [ "s176_redemption" ] }, "parent_action": { "type": "string", "description": "The act_ id of the action that triggered dissent.", "examples": [ "act_3MbN8Vc0" ] }, "dissenting_holder": { "type": "string", "pattern": "^per_", "description": "The dissenting member or limited partner.", "examples": [ "per_Min02" ] }, "holding": { "type": "object", "description": "{share_class, number_of_shares} or {partnership_interest}.", "examples": [ "{\"share_class\":\"Ordinary\",\"number_of_shares\":2000}" ] }, "offer_date": { "type": "string", "format": "date", "description": "Date of the written fair-value offer.", "examples": [ "2026-10-28" ] }, "offer_price": { "$ref": "#/components/schemas/Money", "description": "Total price offered.", "examples": [ "{\"amount\":28400,\"currency\":\"USD\"}" ] }, "valuation_reference_date": { "type": "string", "format": "date", "description": "Close of business on the day before the vote or written consent (BCA s.179; LPA s.81).", "examples": [ "2026-10-21" ] }, "entity_appraiser": { "type": "object", "description": "{name, firm, email, independence_confirmation} for the entity's appraiser.", "examples": [ "{\"name\":\"A. Valuer\",\"firm\":\"Island Valuations Ltd\"}" ] }, "dissenter_appraiser": { "type": "object", "description": "Appraiser designated by the dissenter, once known.", "examples": [ "{\"name\":\"B. Expert\",\"firm\":\"Caribbean Advisory\"}" ] }, "third_appraiser": { "type": "object", "description": "Appraiser designated jointly by the two appraisers.", "examples": [ "{\"name\":\"C. Chair\",\"firm\":\"Independent\"}" ] } }, "required": [ "entity_type", "trigger", "dissenting_holder", "holding", "offer_date", "offer_price", "valuation_reference_date", "entity_appraiser" ], "description": "Runs the statutory three-appraiser process when the entity and a dissenting holder do not agree a price within 30 days of the written offer. Within the next 20 days each side designates an appraiser, and the two designate a third." }, "Create_vg_fair_value_appraisal_hold": { "type": "object", "properties": { "type": { "const": "vg.fair_value_appraisal.hold" }, "params": { "$ref": "#/components/schemas/Params_vg_fair_value_appraisal_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Fair-value appraisal for dissenting members or limited partners", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "designation_notice", "title": "Entity's notice designating its appraiser", "source": "generated", "required": true }, { "key": "directors_or_gp_resolution", "title": "Directors' or general partners' resolution appointing the appraiser and authorising payment", "source": "generated", "required": true }, { "key": "appraiser_engagements", "title": "Appraiser engagement letters and independence confirmations", "source": "uploaded", "required": true }, { "key": "joint_designation", "title": "Two appraisers' designation of the third", "source": "uploaded", "required": true }, { "key": "appraisal_determination", "title": "Determination of fair value by the three appraisers", "source": "uploaded", "required": true }, { "key": "surrender_or_relinquishment", "title": "Surrendered certificates, or the LP relinquishment", "source": "uploaded", "required": true }, { "key": "payment_confirmation", "title": "Proof of payment", "source": "generated", "required": true } ], "people": [ { "role": "limited_partner", "verification_level": "none" }, { "role": "other", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "designation_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_or_gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "appraisal_determination", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "surrender_or_relinquishment", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "None for the appraisal itself. The register change is filed under the parent action", "form": "Not applicable", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_eligible_dissenter", "type": null, "when": "The holder voted for or consented to the action, or did not give the required notice of election to dissent (BCA s.179-; LPA s.81-)." }, { "code": "agreement_window_open", "type": null, "when": "The 30-day agreement window has not ended." }, { "code": "designation_deadline_missed", "type": null, "when": "A party has not designated an appraiser within 20 days." }, { "code": "appraiser_conflict", "type": null, "when": "An appraiser fails the independence check." }, { "code": "surrender_outstanding", "type": null, "when": "Payment is held until surrender or relinquishment." } ] } }, "Params_vg_minority_partnership_interests_redeem": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "lp" ] }, "resolution_mode": { "type": "string", "enum": [ "meeting", "written" ], "description": "Meeting or written resolution.", "examples": [ "written" ] }, "approval_threshold_percent": { "type": "number", "description": "Percentage of total LP capital contributions the supporting limited partners must exceed.", "examples": [ "90" ] }, "minority_cutoff_percent": { "type": "number", "description": "Limited partners below this share of total contributions can be redeemed.", "examples": [ "10" ] }, "supporting_limited_partners": { "type": "array", "items": {}, "description": "[{partner, capital_contribution}].", "examples": [ "[{\"partner\":\"per_LPa01\",\"capital_contribution\":{\"amount\":46000000,\"currency\":\"USD\"}}]" ] }, "interests_to_redeem": { "type": "array", "items": {}, "description": "[{partner, capital_contribution, redemption_price}].", "examples": [ "[{\"partner\":\"per_LPc03\",\"capital_contribution\":{\"amount\":1500000,\"currency\":\"USD\"},\"redemption_price\":{\"amount\":1720000,\"currency\":\"USD\"}}]" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the resolution.", "examples": [ "2026-11-05" ] }, "valuation_report": { "type": "string", "pattern": "^doc_", "description": "Supports the redemption price and the s.81 fair-value offer.", "examples": [ "doc_LPVal1" ] }, "is_recognised_fund": { "type": "boolean", "description": "Recognised funds file only the general partner register, so no LP register filing is made (s.53A).", "examples": [ "false" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "resolution_mode", "supporting_limited_partners", "interests_to_redeem", "resolution_date", "is_recognised_fund" ], "description": "Under Limited Partnership Act 2017 s.79, subject to the LP agreement, all general partners and limited partners with more than 90% of total capital contributions resolve to redeem the interests of limited partners with less than 10%. The." }, "Create_vg_minority_partnership_interests_redeem": { "type": "object", "properties": { "type": { "const": "vg.minority_partnership_interests.redeem" }, "params": { "$ref": "#/components/schemas/Params_vg_minority_partnership_interests_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redeem minority limited partnership interests", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "redemption_resolution", "title": "Resolution of all general partners and the qualifying limited partners", "source": "generated", "required": true }, { "key": "meeting_or_resolution_notice", "title": "Notice of the meeting or written resolution to all limited partners", "source": "generated", "required": true }, { "key": "redemption_notice", "title": "General partners' written notice to each redeemed limited partner", "source": "generated", "required": true }, { "key": "notice_to_objectors", "title": "Notice of the resolution to objectors and unnotified partners", "source": "generated", "required": false }, { "key": "election_to_dissent", "title": "Limited partner's notice of election to dissent", "source": "uploaded", "required": false }, { "key": "fair_value_offer", "title": "Partnership's written fair-value offer", "source": "generated", "required": false }, { "key": "relinquishment", "title": "Relinquishment of the interest", "source": "generated", "required": true }, { "key": "updated_register_of_limited_partners", "title": "Updated register of limited partners", "source": "generated", "required": true }, { "key": "register_filing_receipt", "title": "VIRRGIN filing record", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "redemption_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "redemption_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "redemption_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fair_value_offer", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "relinquishment", "signer_role": "limited_partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "register_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services Co", "form": "Copy of the register of limited partners containing the changes", "channel": "online", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "threshold_not_met", "type": null, "when": "Not all GPs approve, or the supporting limited partners do not exceed the required share of contributions (s.79)." }, { "code": "partner_not_minority", "type": null, "when": "A listed interest is at or above the minority cutoff (s.79)." }, { "code": "excluded_by_lp_agreement", "type": null, "when": "The LP agreement excludes or conditions s.79." }, { "code": "notice_deadline_missed", "type": null, "when": "The s.81 notice or s.81 offer is late." }, { "code": "price_not_agreed", "type": null, "when": "There is no agreement within 30 days." } ] } }, "Params_vg_minority_share_redeem": { "type": "object", "properties": { "majority_members": { "type": "array", "items": {}, "description": "Members giving the written direction, each {person, class, votes_percentage}.", "examples": [ "[{\"person\":\"per_8Kd2mQ\",\"class\":\"Ordinary\",\"votes_percentage\":92}]" ] }, "redeemed_members": { "type": "array", "items": {}, "description": "Minority members whose shares are redeemed, each {person, class, number_of_shares}.", "examples": [ "[{\"person\":\"per_5Bq7nR\",\"class\":\"Ordinary\",\"number_of_shares\":800}]" ] }, "direction_date": { "type": "string", "format": "date", "description": "Date of the written direction.", "examples": [ "2026-11-02" ] }, "fair_value_offer": { "$ref": "#/components/schemas/Money", "description": "Price per share offered in writing to the redeemed members.", "examples": [ "{\"amount\":3.5,\"currency\":\"USD\"}" ] }, "valuation_basis": { "type": "string", "description": "Basis for the fair-value offer.", "examples": [ "Independent valuation dated 2026-10-28" ] }, "dissent_expected": { "type": "boolean", "description": "If true, Entiva schedules the appraisal steps and refers to BVI counsel.", "examples": [ "false" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date redeemed shares are cancelled or transferred in the register.", "examples": [ "2026-12-05" ] }, "segregated_portfolio": { "type": "string", "description": "Portfolio for an SPC.", "examples": [ "Portfolio A" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "majority_members", "redeemed_members", "direction_date", "fair_value_offer", "effective_date" ], "description": "At the written direction of holders of 90% of the votes, the company redeems minority shares, serves notices, makes a fair-value offer within 7 days, runs the dissenters' appraisal if price is not agreed within 30 days, and files the." }, "Create_vg_minority_share_redeem": { "type": "object", "properties": { "type": { "const": "vg.minority_share.redeem" }, "params": { "$ref": "#/components/schemas/Params_vg_minority_share_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Compulsorily redeem minority shares", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "majority_direction", "title": "Written direction of 90% members", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution to give effect", "source": "generated", "required": true }, { "key": "redemption_notice", "title": "Notice to redeemed members", "source": "generated", "required": true }, { "key": "fair_value_offer_letter", "title": "Written fair-value offer", "source": "generated", "required": true }, { "key": "valuation_report", "title": "Valuation report", "source": "uploaded", "required": false }, { "key": "instrument_of_transfer", "title": "Instrument of transfer or surrender", "source": "uploaded", "required": false }, { "key": "register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "each", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "majority_direction", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "redemption_notice", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "instrument_of_transfer", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "register_of_members", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Registry of Corporate Affairs", "form": "Register of members change filing", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "majority_threshold_not_met", "type": null, "when": "Directing members hold less than 90% of votes or of a voting class." }, { "code": "offer_deadline_missed", "type": null, "when": "Fair-value offer not made within 7 days of the direction." }, { "code": "dissent_pending", "type": null, "when": "A redeemed member has dissented and the appraisal is unresolved; filing is held." }, { "code": "counsel_review_required", "type": null, "when": "The action needs BVI counsel sign-off before approval." } ] } }, "Params_vg_minority_shares_redeem": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "directing_members": { "type": "array", "items": {}, "description": "Members giving the written instruction: [{member, votes_overall, votes_by_class}].", "examples": [ "[{\"member\":\"per_HoldCo1\",\"votes_overall\":46800,\"votes_by_class\":{\"Ordinary\":46800}}]" ] }, "shares_to_redeem": { "type": "array", "items": {}, "description": "[{member, share_class, number_of_shares}] for each remaining member.", "examples": [ "[{\"member\":\"per_Min01\",\"share_class\":\"Ordinary\",\"number_of_shares\":1200},{\"member\":\"per_Min02\",\"share_class\":\"Ordinary\",\"number_of_shares\":2000}]" ] }, "direction_date": { "type": "string", "format": "date", "description": "Date the company receives the written instruction.", "examples": [ "2026-10-22" ] }, "fair_value_per_share": { "type": "object", "description": "Price per class the company determines to be fair value for the s.179 offer: {share_class: money}.", "examples": [ "{\"Ordinary\":{\"amount\":14.2,\"currency\":\"USD\"}}" ] }, "valuation_report": { "type": "string", "pattern": "^doc_", "description": "Independent valuation supporting the offer price.", "examples": [ "doc_Val2026" ] }, "payment_mechanics": { "type": "string", "enum": [ "company_pays_on_surrender", "paying_agent", "escrow_pending_appraisal" ], "description": "How payment is made.", "examples": [ "company_pays_on_surrender" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "directing_members", "shares_to_redeem", "direction_date", "fair_value_per_share", "payment_mechanics" ], "description": "Members holding 90% of the votes of the outstanding voting shares, and 90% of the votes of each voting class, instruct the company in writing to redeem the remaining members' shares (BCA s.176), subject to the memorandum and articles. The." }, "Create_vg_minority_shares_redeem": { "type": "object", "properties": { "type": { "const": "vg.minority_shares.redeem" }, "params": { "$ref": "#/components/schemas/Params_vg_minority_shares_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Compulsory redemption of minority shares", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "written_instruction", "title": "Written instruction of the 90% members", "source": "generated", "required": true }, { "key": "directors_resolution_implement", "title": "Directors' resolution implementing the redemption and fixing the offer price", "source": "generated", "required": true }, { "key": "redemption_notice", "title": "Notice to each redeemed member", "source": "generated", "required": true }, { "key": "fair_value_offer", "title": "Written offer to purchase at fair value", "source": "generated", "required": true }, { "key": "valuation_report", "title": "Valuation report", "source": "uploaded", "required": false }, { "key": "acceptance", "title": "Member's acceptance of the offered price", "source": "generated", "required": false }, { "key": "surrendered_certificates", "title": "Surrendered share certificates", "source": "uploaded", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "register_of_members_filing_receipt", "title": "VIRRGIN filing record", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "other", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "each", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "written_instruction", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "directors_resolution_implement", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "redemption_notice", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fair_value_offer", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "acceptance", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "register_of_members_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "threshold_not_met", "type": null, "when": "The directing members hold less than 90% of the votes overall, or of any voting class (s.176)." }, { "code": "excluded_by_constitution", "type": null, "when": "The memorandum or articles exclude or modify s.176 in a way that blocks this redemption." }, { "code": "offer_deadline_missed", "type": null, "when": "The fair-value offer was not made within 7 days of the direction (s.179)." }, { "code": "price_not_agreed", "type": null, "when": "There is no agreement within 30 days." }, { "code": "certificates_not_surrendered", "type": null, "when": "Payment is held until surrender (s.179)." }, { "code": "illegality_proceedings", "type": null, "when": "A member starts proceedings claiming the action is illegal (s.179)." } ] } }, "Params_vg_partnership_interest_redeem": { "type": "object", "properties": { "general_partners": { "type": "array", "items": {}, "description": "General partners joining the resolution.", "examples": [ "[\"per_4Hs8kV\"]" ] }, "majority_limited_partners": { "type": "array", "items": {}, "description": "Limited partners voting for the redemption, each {person, contribution_percentage}.", "examples": [ "[{\"person\":\"per_6Tn3wC\",\"contribution_percentage\":91}]" ] }, "redeemed_limited_partners": { "type": "array", "items": {}, "description": "Limited partners being redeemed, each {person, interest_percentage}.", "examples": [ "[{\"person\":\"per_7Ur4xD\",\"interest_percentage\":4}]" ] }, "threshold_percentage": { "type": "number", "description": "Approval threshold of contributions.", "examples": [ "90" ] }, "redemption_price": { "$ref": "#/components/schemas/Money", "description": "Amount paid for the redeemed interests.", "examples": [ "{\"amount\":40000,\"currency\":\"USD\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the register is updated.", "examples": [ "2026-12-05" ] }, "dissent_expected": { "type": "boolean", "description": "If true, the dissent process is scheduled and counsel is engaged.", "examples": [ "false" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "general_partners", "majority_limited_partners", "redeemed_limited_partners", "threshold_percentage", "redemption_price", "effective_date" ], "description": "Redeems minority limited partners' interests on a resolution of all general partners and limited partners holding over 90% of contributions, with written notice and dissent rights, then updates and files the register of limited partners." }, "Create_vg_partnership_interest_redeem": { "type": "object", "properties": { "type": { "const": "vg.partnership_interest.redeem" }, "params": { "$ref": "#/components/schemas/Params_vg_partnership_interest_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Redeem minority limited partnership interests", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_resolution", "title": "Resolution of general partners and majority limited partners", "source": "generated", "required": true }, { "key": "redemption_notice", "title": "Written notice to redeemed limited partners", "source": "generated", "required": true }, { "key": "limited_partnership_agreement", "title": "Limited partnership agreement", "source": "uploaded", "required": true }, { "key": "instrument_of_transfer", "title": "Surrender or assignment of interest", "source": "uploaded", "required": false }, { "key": "register_of_partners", "title": "Updated register of limited partners", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "redemption_notice", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "instrument_of_transfer", "signer_role": "limited_partner", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "register_of_partners", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Registry of Corporate Affairs", "form": "Register of limited partners change", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "threshold_not_met", "type": null, "when": "Supporting limited partners hold 90% or less of contributions, or less than the LP agreement threshold." }, { "code": "counsel_review_required", "type": null, "when": "BVI counsel sign-off is needed before approval." }, { "code": "dissent_pending", "type": null, "when": "A limited partner has dissented and the process is unresolved." }, { "code": "fee_unconfirmed", "type": null, "when": "Government fee is unknown; the quote is marked provisional." } ] } }, "Params_vg_partnership_interest_transfer": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Entity type key.", "examples": [ "lp" ] }, "interest_type": { "type": "string", "enum": [ "limited", "general" ], "description": "Whether a limited or general partnership interest is transferred.", "examples": [ "limited" ] }, "transferor": { "type": "string", "pattern": "^per_", "description": "Partner transferring the interest.", "examples": [ "per_LPa01" ] }, "transferee": { "type": "string", "pattern": "^per_", "description": "Incoming partner.", "examples": [ "per_LPb02" ] }, "transferee_address": { "$ref": "#/components/schemas/Address", "description": "Address entered in the register (s.53).", "examples": [ "{\"line1\":\"1 Raffles Place\",\"city\":\"Singapore\",\"postal_code\":\"048616\",\"country\":\"SG\"}" ] }, "portion": { "type": "object", "description": "What is transferred: {whole: boolean, capital_contribution, unfunded_commitment, percentage}.", "examples": [ "{\"whole\":false,\"capital_contribution\":{\"amount\":2000000,\"currency\":\"USD\"},\"unfunded_commitment\":{\"amount\":500000,\"currency\":\"USD\"},\"percentage\":12.5}" ] }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price paid.", "examples": [ "{\"amount\":1850000,\"currency\":\"USD\"}" ] }, "transfer_date": { "type": "string", "format": "date", "description": "Effective date of the transfer under the LP agreement.", "examples": [ "2026-11-02" ] }, "admission_mode": { "type": "string", "enum": [ "in_place_of_transferor", "in_addition_to_transferor" ], "description": "For a general partnership interest: admit the incoming GP in place of, to the exclusion of, or in addition to the transferor (s.43).", "examples": [ "in_place_of_transferor" ] }, "liability_agreements": { "type": "object", "description": "Written agreements that move pre-admission liabilities: {incoming_gp_assumes_prior_liabilities (s.43), creditor_release (s.43), incoming_lp_assumes_s35_s36.", "examples": [ "{\"incoming_lp_assumes_s35_s36\":false}" ] }, "consent_route": { "type": "string", "enum": [ "statutory_gp_consent", "lp_agreement_terms" ], "description": "Whether the statutory consent applies or the LP agreement modifies or excludes it (s.42).", "examples": [ "statutory_gp_consent" ] }, "is_recognised_fund": { "type": "boolean", "description": "Recognised private, professional, public or private investment funds, and incubator or approved funds, file only the register of general partners (s.53A).", "examples": [ "false" ] }, "lp_holds_bvi_land": { "type": "boolean", "description": "Whether the LP, or a partnership or company it has a prescribed interest in, holds BVI land.", "examples": [ "false" ] } }, "required": [ "entity_type", "interest_type", "transferor", "transferee", "transferee_address", "portion", "transfer_date", "consent_route", "is_recognised_fund", "lp_holds_bvi_land" ], "description": "Transfers all or part of a general or limited partnership interest. Under Limited Partnership Act 2017 s.42, a limited partner needs the prior or simultaneous written consent of the general partners, and a general partner needs that of any." }, "Create_vg_partnership_interest_transfer": { "type": "object", "properties": { "type": { "const": "vg.partnership_interest.transfer" }, "params": { "$ref": "#/components/schemas/Params_vg_partnership_interest_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a BVI limited partnership interest and admit the transferee", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "transfer_instrument", "title": "Instrument of transfer or assignment of the partnership interest", "source": "generated", "required": true }, { "key": "gp_consent", "title": "General partners' written consent to the transfer", "source": "generated", "required": true }, { "key": "accession_agreement", "title": "Deed or agreement of adherence to the LP agreement", "source": "generated", "required": true }, { "key": "liability_agreement", "title": "Written agreement on prior liabilities", "source": "generated", "required": false }, { "key": "kyb_pack", "title": "KYB pack for a corporate transferee", "source": "uploaded", "required": false }, { "key": "source_of_funds_declaration", "title": "Source of funds and wealth declaration", "source": "uploaded", "required": false }, { "key": "power_of_attorney", "title": "Power of attorney for a signing attorney", "source": "uploaded", "required": false }, { "key": "updated_partner_registers", "title": "Updated registers of general and limited partners", "source": "generated", "required": true }, { "key": "register_filing_receipt", "title": "VIRRGIN filing record for the register change", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "transfer_instrument", "signer_role": "lawyer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "transfer_instrument", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "gp_consent", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "accession_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liability_agreement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services Co", "form": "Copy of the register of limited partners and/or general partners containing the changes", "channel": "online", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "gp_consent_missing", "type": null, "when": "The s.42 consent, or the consent the LP agreement requires, has not been given." }, { "code": "transfer_prohibited_by_lp_agreement", "type": null, "when": "The LP agreement prohibits or conditions the transfer and the conditions are unmet." }, { "code": "no_general_partner_remaining", "type": null, "when": "The transfer would leave the partnership with no general partner." }, { "code": "electronic_signature_not_permitted", "type": null, "when": "An e-signature is attempted on the transfer instrument." }, { "code": "wet_ink_original_outstanding", "type": null, "when": "The original instrument has not been received within the policy period." }, { "code": "verification_failed", "type": null, "when": "The incoming partner or a beneficial owner fails verification, or there is a sanctions match." }, { "code": "register_filing_overdue", "type": null, "when": "More than 30 days have passed since the change." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent's mandate does not cover this action." } ] } }, "Params_vg_segregated_portfolio_create": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key.", "examples": [ "segregated_portfolio_company" ] }, "portfolio_name": { "type": "string", "description": "Name or designation.", "examples": [ "Beta Segregated Portfolio" ] }, "creation_date": { "type": "string", "format": "date", "description": "Date of creation.", "examples": [ "2026-10-20" ] }, "purpose": { "type": "string", "description": "Purpose of the portfolio.", "examples": [ "Hold the group's Asia property interests separately" ] }, "portfolio_directors": { "type": "array", "items": {}, "description": "Directors appointed to act for the portfolio.", "examples": [ "[\"per_Dir01\"]" ] }, "fund_status": { "type": "string", "enum": [ "public_fund", "private_fund", "professional_fund", "incubator_fund", "approved_fund" ], "description": "Mutual fund SPC only: decides approval or notification (MF reg 7).", "examples": [ "professional_fund" ] }, "functionaries": { "type": "array", "items": {}, "description": "Mutual fund SPC only: [{role, name, principal_place_of_business, same_as_notified}].", "examples": [ "[{\"role\":\"administrator\",\"name\":\"Example Fund Services Ltd\",\"principal_place_of_business\":\"KY\",\"same_as_notified\":true}]" ] }, "offering_document": { "type": "string", "pattern": "^doc_", "description": "Mutual fund SPC: the offering document or investment warning, which must be issued before creation and sent with the notice (MF reg 8).", "examples": [ "doc_OM_Beta" ] }, "insurer_licence_category": { "type": "string", "enum": [ "category_c", "other" ], "description": "Insurer SPC only: Category C licence holders pay higher initial fees.", "examples": [ "other" ] }, "share_classes": { "type": "array", "items": {}, "description": "Segregated portfolio share classes to be issued for the portfolio.", "examples": [ "[{\"share_class\":\"Beta Participating\",\"par_value\":null}]" ] } }, "required": [ "entity_type", "portfolio_name", "creation_date" ], "description": "Creates a new segregated portfolio in a BVI segregated portfolio company. Its designation must include the words 'Segregated Portfolio' (BCA s.138)." }, "Create_vg_segregated_portfolio_create": { "type": "object", "properties": { "type": { "const": "vg.segregated_portfolio.create" }, "params": { "$ref": "#/components/schemas/Params_vg_segregated_portfolio_create" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Create an additional segregated portfolio", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_resolution_create_portfolio", "title": "Directors' resolution creating the segregated portfolio", "source": "generated", "required": true }, { "key": "fsc_notification", "title": "Notification of creation to the FSC", "source": "generated", "required": false }, { "key": "fsc_approval_application", "title": "Application for approval to create a segregated portfolio", "source": "generated", "required": false }, { "key": "offering_document", "title": "Offering document or investment warning", "source": "uploaded", "required": false }, { "key": "fsc_approval", "title": "FSC written approval", "source": "registry_issued", "required": false }, { "key": "fsc_acknowledgement", "title": "FSC acknowledgement of notification and fee receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "directors_resolution_create_portfolio", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fsc_notification", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "fsc_approval_application", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Business company SPC: written notification of creation", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_an_spc", "type": null, "when": "The entity is not a segregated portfolio company." }, { "code": "invalid_portfolio_designation", "type": null, "when": "portfolio_name does not include 'Segregated Portfolio' (s.138)." }, { "code": "fsc_approval_required", "type": null, "when": "The approval route applies and creation_date is before approval (s.138)." }, { "code": "offering_document_missing", "type": null, "when": "A mutual fund SPC portfolio has no offering document or investment warning (MF reg 8)." }, { "code": "notification_overdue", "type": null, "when": "More than 14 days have passed since creation." }, { "code": "fsc_rejected", "type": null, "when": "The FSC refuses approval." } ] } }, "Params_vg_share_allot": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "allotments": { "type": "array", "items": {}, "description": "One item per allottee: {allottee, share_class, share_series, number_of_shares, issue_price_per_share, consideration_type, amount_paid_on_issue.", "examples": [ "[{\"allottee\":\"per_5MnB3x\",\"share_class\":\"Ordinary\",\"number_of_shares\":5000,\"issue_price_per_share\":{\"amount\":10,\"currency\":\"USD\"},\"consideration_type\":\"money\",\"amount_paid_on_issue\":{\"amount\":50000,\"currency\":\"USD\"}}]" ] }, "issue_date": { "type": "string", "format": "date", "description": "Intended date of entry in the register of members, which is the date of issue.", "examples": [ "2026-10-24" ] }, "par_value": { "$ref": "#/components/schemas/Money", "description": "Par value per share of the class, or null for no par value shares.", "examples": [ "{\"amount\":1,\"currency\":\"USD\"}" ] }, "non_money_consideration": { "type": "object", "description": "Required when any consideration is not money: {description, amount_to_be_credited, present_cash_value, valuation_document}.", "examples": [ "{\"description\":\"Assignment of software IP\",\"amount_to_be_credited\":{\"amount\":200000,\"currency\":\"USD\"},\"present_cash_value\":{\"amount\":210000,\"currency\":\"USD\"}}" ] }, "pre_emption_status": { "type": "string", "enum": [ "not_applicable", "offered_and_lapsed", "offered_and_accepted", "waived_by_members", "disapplied_by_resolution" ], "description": "How pre-emption is met. s.46 applies only if the memorandum or articles expressly apply it, and they may modify it (s.46,).", "examples": [ "not_applicable" ] }, "partly_paid": { "type": "boolean", "description": "True if shares are issued unpaid or partly paid, or otherwise impose a liability on the holder.", "examples": [ "false" ] }, "bonus_issue": { "type": "boolean", "description": "True for a bonus issue.", "examples": [ "false" ] }, "certificates": { "type": "boolean", "description": "Issue share certificates.", "examples": [ "true" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio the shares are issued for.", "examples": [ "Alpha Segregated Portfolio" ] }, "register_publicly_accessible": { "type": "boolean", "description": "Opt in to public access to the register filing (s.43A).", "examples": [ "false" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "allotments", "issue_date", "pre_emption_status" ], "description": "Issues new registered shares by directors' resolution, subject to the memorandum and articles. The action enforces the statutory checks: - pre-emption, if the articles opt in; - consideration not below par value; - a directors' resolution." }, "Create_vg_share_allot": { "type": "object", "properties": { "type": { "const": "vg.share.allot" }, "params": { "$ref": "#/components/schemas/Params_vg_share_allot" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Issue new shares in a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_resolution_allotment", "title": "Directors' resolution to issue shares", "source": "generated", "required": true }, { "key": "non_money_consideration_resolution", "title": "Directors' resolution on non-money consideration", "source": "generated", "required": false }, { "key": "valuation_support", "title": "Valuation or evidence for non-money consideration", "source": "uploaded", "required": false }, { "key": "subscription_agreement", "title": "Subscription letter or agreement", "source": "generated", "required": true }, { "key": "liability_consent", "title": "Allottee's written agreement to become holder of shares carrying a liability", "source": "generated", "required": false }, { "key": "pre_emption_offer", "title": "Pre-emption offer, acceptances or waivers", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Members' resolution", "source": "generated", "required": false }, { "key": "evidence_of_payment", "title": "Evidence of payment of the subscription price", "source": "uploaded", "required": false }, { "key": "kyb_pack", "title": "KYB pack for a corporate allottee at 10% or more", "source": "uploaded", "required": false }, { "key": "source_of_funds_declaration", "title": "Source of funds and wealth declaration", "source": "uploaded", "required": false }, { "key": "share_certificate", "title": "Share certificate", "source": "generated", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "register_of_members_filing_receipt", "title": "VIRRGIN filing record", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "each", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "directors_resolution_allotment", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "non_money_consideration_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "subscription_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "subscription_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liability_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "pre_emption_offer", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_certificate", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_members_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "exceeds_authorised_shares", "type": null, "when": "The issue would take issued shares of the class above the maximum in the memorandum (s.9)." }, { "code": "class_not_authorised", "type": null, "when": "share_class is not a class the memorandum authorises." }, { "code": "issue_below_par", "type": null, "when": "The issue price per share is below par value (s.47)." }, { "code": "non_money_resolution_missing", "type": null, "when": "There is non-money consideration and no s.48 resolution." }, { "code": "pre_emption_not_satisfied", "type": null, "when": "s.46 applies through the articles and the offer, waiver or disapplication is incomplete." }, { "code": "liability_consent_missing", "type": null, "when": "The shares impose a liability and the allottee has not agreed in writing." }, { "code": "bearer_shares_prohibited", "type": null, "when": "Bearer shares were requested." }, { "code": "verification_failed", "type": null, "when": "An allottee or beneficial owner fails verification, or there is a sanctions match." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent's mandate does not cover share issues or the amount." } ] } }, "Params_vg_share_consolidate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class to combine.", "examples": [ "Ordinary" ] }, "share_series": { "type": "string", "description": "Series, if any.", "examples": [ "Series A" ] }, "ratio": { "type": "object", "description": "{from, to}.", "examples": [ "{\"from\":10,\"to\":1}" ] }, "current_par_value": { "$ref": "#/components/schemas/Money", "description": "Current par value per share, or null.", "examples": [ "{\"amount\":0.1,\"currency\":\"USD\"}" ] }, "par_value": { "$ref": "#/components/schemas/Money", "description": "New par value, which keeps the aggregate par value unchanged (s.40A).", "examples": [ "{\"amount\":1,\"currency\":\"USD\"}" ] }, "fraction_handling": { "type": "string", "enum": [ "issue_fractions", "round_down", "round_up", "aggregate_and_sell", "cash_out" ], "description": "What happens to fractional entitlements. issue_fractions needs the memorandum and articles to allow fractional shares.", "examples": [ "issue_fractions" ] }, "resolution_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Body the memorandum and articles empower.", "examples": [ "members" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the register is updated.", "examples": [ "2026-11-01" ] }, "amend_memorandum": { "type": "boolean", "description": "True if the memorandum's par value or maximum must change.", "examples": [ "true" ] }, "maximum_shares": { "type": "integer", "description": "Reduced maximum, if the memorandum is to reflect the combination.", "examples": [ "5000" ] }, "certificates": { "type": "string", "enum": [ "cancel_and_reissue", "no_certificates" ], "description": "Certificate handling.", "examples": [ "cancel_and_reissue" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio.", "examples": [ "Alpha Segregated Portfolio" ] } }, "required": [ "entity_type", "share_class", "ratio", "fraction_handling", "resolution_body", "effective_date", "amend_memorandum" ], "description": "Combines shares of a class or series, including issued shares, into a smaller number of shares of the same class or series, as BCA s.40A and allow subject to the memorandum and articles. Aggregate par value must stay the same (s.40A)." }, "Create_vg_share_consolidate": { "type": "object", "properties": { "type": { "const": "vg.share.consolidate" }, "params": { "$ref": "#/components/schemas/Params_vg_share_consolidate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Combine shares into a smaller number", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "combination_resolution", "title": "Resolution to combine shares", "source": "generated", "required": true }, { "key": "fraction_consents", "title": "Holder consents for fraction treatment", "source": "generated", "required": false }, { "key": "memorandum_amendment_resolution", "title": "Resolution amending the memorandum", "source": "generated", "required": false }, { "key": "notice_of_amendment", "title": "Notice of amendment or restated memorandum", "source": "generated", "required": false }, { "key": "s40_notice", "title": "s.40 notice", "source": "generated", "required": false }, { "key": "share_certificates", "title": "Replacement share certificates", "source": "generated", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "registry_records", "title": "VIRRGIN filing records", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "combination_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "combination_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fraction_consents", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "share_certificates", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_records", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "par_value_mismatch", "type": null, "when": "Aggregate par value would change (s.40A)." }, { "code": "cross_class_combination", "type": null, "when": "The result is in a different class or series (s.40A)." }, { "code": "fractional_shares_not_permitted", "type": null, "when": "fraction_handling is issue_fractions but the memorandum and articles do not allow fractional shares." }, { "code": "fraction_consent_missing", "type": null, "when": "A required holder consent for fraction treatment is outstanding." }, { "code": "below_issued_shares", "type": null, "when": "new_maximum_shares is below the shares in issue after combination." }, { "code": "not_permitted_by_constitution", "type": null, "when": "The memorandum or articles exclude the power." } ] } }, "Params_vg_share_redeem": { "type": "object", "properties": { "acquisition_type": { "type": "string", "enum": [ "purchase", "redemption_at_option_of_member", "redemption_at_option_of_company", "other_acquisition" ], "description": "How the company acquires the shares.", "examples": [ "purchase" ] }, "shareholders": { "type": "array", "items": {}, "description": "List of {person, class, number_of_shares, price_per_share}.", "examples": [ "[{\"person\":\"per_8Kd2mQ\",\"class\":\"Ordinary\",\"number_of_shares\":2000,\"price_per_share\":{\"amount\":3,\"currency\":\"USD\"}}]" ] }, "offer_basis": { "type": "string", "enum": [ "all_shareholders", "selected_shareholders" ], "description": "Offer made to all shareholders or to selected shareholders.", "examples": [ "selected_shareholders" ] }, "treatment": { "type": "string", "enum": [ "cancel", "hold_as_treasury" ], "description": "Cancel the shares or hold as treasury shares.", "examples": [ "cancel" ] }, "total_consideration": { "$ref": "#/components/schemas/Money", "description": "Total price paid by the company.", "examples": [ "{\"amount\":6000,\"currency\":\"USD\"}" ] }, "solvency_test_confirmed": { "type": "boolean", "description": "Directors confirm the company will satisfy the solvency test immediately after the acquisition.", "examples": [ "true" ] }, "treasury_cap_check": { "type": "object", "description": "For hold_as_treasury: {class_issued_previously, treasury_after}.", "examples": [ "{\"class_issued_previously\":10000,\"treasury_after\":2000}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of acquisition and register entry.", "examples": [ "2026-11-02" ] }, "segregated_portfolio": { "type": "string", "description": "Portfolio for an SPC.", "examples": [ "Portfolio A" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "acquisition_type", "shareholders", "offer_basis", "treatment", "total_consideration", "solvency_test_confirmed", "effective_date" ], "description": "The company purchases, redeems or otherwise acquires its own shares on a directors' resolution with a solvency-test statement, then cancels the shares or holds them as treasury shares, and the registered agent files the register of members." }, "Create_vg_share_redeem": { "type": "object", "properties": { "type": { "const": "vg.share.redeem" }, "params": { "$ref": "#/components/schemas/Params_vg_share_redeem" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Purchase or redeem own shares", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution with solvency-test statement", "source": "generated", "required": true }, { "key": "offer_letter", "title": "Offer to shareholders", "source": "generated", "required": true }, { "key": "acceptance", "title": "Shareholder acceptance and share surrender", "source": "uploaded", "required": true }, { "key": "solvency_evidence", "title": "Evidence supporting solvency test", "source": "uploaded", "required": false }, { "key": "register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "offer_letter", "signer_role": "other", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "acceptance", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "register_of_members", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Registry of Corporate Affairs", "form": "Register of members change filing", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "solvency_test_not_confirmed", "type": null, "when": "Directors have not confirmed the solvency test." }, { "code": "treasury_cap_exceeded", "type": null, "when": "Treasury shares would exceed 50% of the class previously issued (s.64)." }, { "code": "insufficient_shares", "type": null, "when": "Shareholder holds fewer shares than offered." }, { "code": "wet_ink_original_missing", "type": null, "when": "Signed acceptance not received by the partner." } ] } }, "Params_vg_share_repurchase": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "method": { "type": "string", "enum": [ "offer_to_all", "selective_all_shareholders_consent", "selective_s61", "redemption_at_holder_option", "redemption_on_fixed_date", "surrender_for_no_consideration", "articles_procedure" ], "description": "Statutory route.", "examples": [ "selective_s61" ] }, "sellers": { "type": "array", "items": {}, "description": "Shares to be acquired: [{member, share_class, number_of_shares, price_per_share}].", "examples": [ "[{\"member\":\"per_7HqA2c\",\"share_class\":\"Ordinary\",\"number_of_shares\":5000,\"price_per_share\":{\"amount\":12,\"currency\":\"USD\"}}]" ] }, "payment_date": { "type": "string", "format": "date", "description": "Date consideration is paid.", "examples": [ "2026-11-15" ] }, "hold_as_treasury": { "type": "boolean", "description": "Hold the acquired shares as treasury shares.", "examples": [ "false" ] }, "solvency_statement": { "type": "object", "description": "{total_assets, total_liabilities, able_to_pay_debts_as_due, as_of, supporting_documents}.", "examples": [ "{\"total_assets\":{\"amount\":3200000,\"currency\":\"USD\"},\"total_liabilities\":{\"amount\":900000,\"currency\":\"USD\"},\"able_to_pay_debts_as_due\":true,\"as_of\":\"2026-09-30\"}" ] }, "s61_reasons": { "type": "string", "description": "Required for selective_s61: the directors' reasons why the acquisition benefits the remaining shareholders and why the terms and consideration are fair and.", "examples": [ "Exit of a departing founder at a price below the latest independent valuation; returns surplus cash and simplifies the cap table." ] }, "offer_period_days": { "type": "integer", "description": "For offer_to_all: how long the offer stays open.", "examples": [ "14" ] }, "allow_additional_acceptances": { "type": "boolean", "description": "For offer_to_all: allow acceptances beyond pro rata where others decline, scaled down rateably (s.60).", "examples": [ "false" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio whose shares are acquired.", "examples": [ "Alpha Segregated Portfolio" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "method", "sellers", "hold_as_treasury" ], "description": "The company purchases, redeems or otherwise acquires its own shares. The routes are: - an offer to all shareholders that leaves relative rights unaffected (s.60); - a selective offer, either with every shareholder's written consent (s.60)." }, "Create_vg_share_repurchase": { "type": "object", "properties": { "type": { "const": "vg.share.repurchase" }, "params": { "$ref": "#/components/schemas/Params_vg_share_repurchase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Buy back, redeem or surrender the company's own shares", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_resolution_repurchase", "title": "Directors' resolution authorising the acquisition, with the solvency statement", "source": "generated", "required": true }, { "key": "s61_resolution", "title": "Directors' s.61 resolution with reasons", "source": "generated", "required": false }, { "key": "all_shareholders_consent", "title": "Written consent of all shareholders", "source": "generated", "required": false }, { "key": "treasury_resolution", "title": "Directors' resolution to hold shares as treasury shares", "source": "generated", "required": false }, { "key": "offer_document", "title": "Offer letter and acceptance form", "source": "generated", "required": false }, { "key": "redemption_notice", "title": "Holder's redemption notice", "source": "uploaded", "required": false }, { "key": "repurchase_agreement", "title": "Share repurchase agreement", "source": "generated", "required": false }, { "key": "seller_transfer_instrument", "title": "Seller's instrument of transfer or surrender", "source": "generated", "required": true }, { "key": "solvency_support", "title": "Management accounts and cash-flow forecast supporting the solvency test", "source": "uploaded", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "register_of_members_filing_receipt", "title": "VIRRGIN filing record", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "directors_resolution_repurchase", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "s61_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "treasury_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "all_shareholders_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "repurchase_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "seller_transfer_instrument", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "redemption_notice", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_members_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "solvency_statement_missing", "type": null, "when": "s.57 applies and the directors' resolution lacks the solvency statement." }, { "code": "solvency_test_not_satisfied", "type": null, "when": "Assets would not exceed liabilities, or the company could not pay debts as they fall due (s.56)." }, { "code": "directors_ceased_satisfied", "type": null, "when": "Before payment, the directors confirm they are no longer satisfied." }, { "code": "selective_offer_not_permitted", "type": null, "when": "selective_s61 is chosen but the memorandum or articles do not permit it." }, { "code": "s61_reasons_missing", "type": null, "when": "The s.61 resolution does not set out reasons (s.61)." }, { "code": "offer_not_pro_rata", "type": null, "when": "An offer_to_all would change the relative voting or distribution rights (s.60)." }, { "code": "treasury_cap_exceeded", "type": null, "when": "Treasury shares of the class would exceed 50% of shares of that class previously issued, excluding cancelled shares (s.64)." }, { "code": "treasury_prohibited", "type": null, "when": "The memorandum or articles prohibit holding treasury shares (s.64)." }, { "code": "seller_consent_missing", "type": null, "when": "Required under s.59 and not given." }, { "code": "court_restraint", "type": null, "when": "A shareholder obtains a court order restraining a selective acquisition (s.61)." } ] } }, "Params_vg_share_subdivide": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Class to divide.", "examples": [ "Ordinary" ] }, "share_series": { "type": "string", "description": "Series, if any.", "examples": [ "Series A" ] }, "ratio": { "type": "object", "description": "{from, to}.", "examples": [ "{\"from\":1,\"to\":10}" ] }, "current_par_value": { "$ref": "#/components/schemas/Money", "description": "Current par value per share, or null for no par value shares.", "examples": [ "{\"amount\":1,\"currency\":\"USD\"}" ] }, "par_value": { "$ref": "#/components/schemas/Money", "description": "New par value.", "examples": [ "{\"amount\":0.1,\"currency\":\"USD\"}" ] }, "resolution_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Body the memorandum and articles give the power to.", "examples": [ "directors" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the register is updated.", "examples": [ "2026-11-01" ] }, "amend_memorandum": { "type": "boolean", "description": "True if the memorandum must change, for example to the stated par value or maximum.", "examples": [ "true" ] }, "maximum_shares": { "type": "integer", "description": "New authorised maximum for the class, if it rises with the split.", "examples": [ "500000" ] }, "certificates": { "type": "string", "enum": [ "cancel_and_reissue", "no_certificates" ], "description": "Certificate handling.", "examples": [ "cancel_and_reissue" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio whose shares are divided.", "examples": [ "Alpha Segregated Portfolio" ] } }, "required": [ "entity_type", "share_class", "ratio", "resolution_body", "effective_date", "amend_memorandum" ], "description": "Divides shares of a class or series, including issued shares, into a larger number of shares of the same class or series, as BCA s.40A and allow subject to the memorandum and articles. The division may not take the company above its." }, "Create_vg_share_subdivide": { "type": "object", "properties": { "type": { "const": "vg.share.subdivide" }, "params": { "$ref": "#/components/schemas/Params_vg_share_subdivide" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Divide shares into a larger number", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "division_resolution", "title": "Resolution to divide shares", "source": "generated", "required": true }, { "key": "memorandum_amendment_resolution", "title": "Resolution amending the memorandum", "source": "generated", "required": false }, { "key": "notice_of_amendment", "title": "Notice of amendment or restated memorandum", "source": "generated", "required": false }, { "key": "s40_notice", "title": "s.40 notice of change in authorised shares", "source": "generated", "required": false }, { "key": "share_certificates", "title": "Replacement share certificates", "source": "generated", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "registry_records", "title": "VIRRGIN records of the register change and any amendment", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "division_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "division_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "memorandum_amendment_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_certificates", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registry_records", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "exceeds_authorised_shares", "type": null, "when": "The division would exceed the maximum the memorandum authorises (s.40A) and no new_maximum_shares was given." }, { "code": "par_value_mismatch", "type": null, "when": "Aggregate par value after the division differs from before (s.40A)." }, { "code": "cross_class_division", "type": null, "when": "The result is in a different class or series (s.40A)." }, { "code": "not_permitted_by_constitution", "type": null, "when": "The memorandum or articles exclude or condition the power." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent's mandate does not cover share capital changes." } ] } }, "Params_vg_share_transfer": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type key of the company whose shares are transferred.", "examples": [ "bc_ltd_shares" ] }, "transferor": { "type": "string", "pattern": "^per_", "description": "Registered holder transferring the shares.", "examples": [ "per_7HqA2c" ] }, "transferee": { "type": "string", "pattern": "^per_", "description": "Individual or corporate body receiving the shares.", "examples": [ "per_2RtX9k" ] }, "transferee_address": { "$ref": "#/components/schemas/Address", "description": "Transferee address for the instrument and the register of members (s.54, s.41).", "examples": [ "{\"line1\":\"12 Harbour Road\",\"city\":\"Singapore\",\"postal_code\":\"098633\",\"country\":\"SG\"}" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Share class as named in the memorandum (s.9).", "examples": [ "Ordinary" ] }, "share_series": { "type": "string", "description": "Series within the class, if any.", "examples": [ "Series A" ] }, "number_of_shares": { "type": "integer", "description": "Number of shares transferred.", "examples": [ "20000" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the segregated portfolio the shares were issued for.", "examples": [ "Alpha Segregated Portfolio" ] }, "transfer_date": { "type": "string", "format": "date", "description": "Date the instrument of transfer is signed.", "examples": [ "2026-10-20" ] }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price paid for the shares.", "examples": [ "{\"amount\":250000,\"currency\":\"USD\"}" ] }, "consideration_type": { "type": "string", "enum": [ "money", "non_money", "nil" ], "description": "Form of consideration.", "examples": [ "money" ] }, "transferee_liability": { "type": "boolean", "description": "True if registration imposes a liability to the company on the transferee, for example unpaid or partly paid shares, or shares in an unlimited company.", "examples": [ "false" ] }, "nominee": { "type": "object", "description": "{is_nominee, nominator}.", "examples": [ "{\"is_nominee\":false}" ] }, "articles_pre_emption_status": { "type": "string", "enum": [ "not_applicable", "waived", "offered_and_declined", "consent_obtained" ], "description": "Status of any pre-emption or consent right on transfer in the articles.", "examples": [ "not_applicable" ] }, "certificate_handling": { "type": "string", "enum": [ "issue_new_certificate", "no_certificates", "issue_balance_certificate_to_transferor" ], "description": "How share certificates are handled, following the articles (s.44).", "examples": [ "issue_new_certificate" ] }, "company_holds_bvi_land": { "type": "boolean", "description": "Whether the company or any subsidiary has an interest in land in the BVI.", "examples": [ "false" ] }, "lost_instrument": { "type": "boolean", "description": "True if a signed instrument was lost or destroyed.", "examples": [ "false" ] }, "register_publicly_accessible": { "type": "boolean", "description": "Make the register filing publicly accessible (s.43A).", "examples": [ "false" ] } }, "required": [ "entity_type", "transferor", "transferee", "transferee_address", "share_class", "number_of_shares", "transfer_date", "transferee_liability", "company_holds_bvi_land" ], "description": "Transfers registered shares to a new or existing holder under BVI Business Companies Act s.54. The transferor signs a wet-ink instrument of transfer, and the transferee also signs if a liability attaches." }, "Create_vg_share_transfer": { "type": "object", "properties": { "type": { "const": "vg.share.transfer" }, "params": { "$ref": "#/components/schemas/Params_vg_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer registered shares in a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "instrument_of_transfer", "title": "Instrument of transfer", "source": "generated", "required": true }, { "key": "directors_resolution_transfer", "title": "Directors' resolution approving, refusing or delaying registration", "source": "generated", "required": false }, { "key": "notice_of_refusal_or_delay", "title": "Notice of refusal or delay of registration", "source": "generated", "required": false }, { "key": "lost_instrument_evidence", "title": "Evidence of a lost or destroyed instrument and the directors' resolution", "source": "uploaded", "required": false }, { "key": "pre_emption_waiver", "title": "Pre-emption waiver or consent under the articles", "source": "generated", "required": false }, { "key": "power_of_attorney", "title": "Power of attorney for a signing attorney", "source": "uploaded", "required": false }, { "key": "corporate_authority", "title": "Board resolution of a corporate transferor or transferee naming its signatory", "source": "uploaded", "required": false }, { "key": "kyb_pack", "title": "KYB pack for a corporate transferee holding 10% or more", "source": "uploaded", "required": false }, { "key": "source_of_funds_declaration", "title": "Source of funds and source of wealth declaration", "source": "uploaded", "required": false }, { "key": "nominee_declaration", "title": "Nominee declaration of trust", "source": "uploaded", "required": false }, { "key": "cancelled_certificate", "title": "Transferor's existing share certificate", "source": "uploaded", "required": false }, { "key": "share_certificate", "title": "New share certificate", "source": "generated", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "register_of_members_filing_receipt", "title": "VIRRGIN filing record for the register change", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "instrument_of_transfer", "signer_role": "lawyer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "instrument_of_transfer", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "directors_resolution_transfer", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_refusal_or_delay", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "pre_emption_waiver", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nominee_declaration", "signer_role": "nominee", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "share_certificate", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_members_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "transferor_not_registered_holder", "type": null, "when": "The transferor is not on the register for that class, or holds fewer shares than number_of_shares." }, { "code": "transfer_restricted_by_articles", "type": null, "when": "The memorandum or articles prohibit or restrict the transfer, and the pre-emption or consent route has not been satisfied (s.52)." }, { "code": "listed_shares_use_exchange_procedure", "type": null, "when": "The shares are listed on a recognised exchange. s.54 does not apply to them." }, { "code": "bearer_shares_prohibited", "type": null, "when": "The request refers to bearer shares, which BVI companies may no longer issue." }, { "code": "electronic_signature_not_permitted", "type": null, "when": "An e-signature is attempted on the instrument of transfer, which must be wet-ink (ETA s.4)." }, { "code": "wet_ink_original_outstanding", "type": null, "when": "A scan was accepted but the original has not reached the partner within Entiva's policy period." }, { "code": "transferee_signature_required", "type": null, "when": "transferee_liability is true and the transferee has not signed (s.54)." }, { "code": "registration_refused_by_directors", "type": null, "when": "The directors resolve to refuse registration (s.54)." }, { "code": "verification_failed", "type": null, "when": "The transferee or a beneficial owner fails verification, or there is a sanctions match." }, { "code": "land_owning_company_stamp_duty", "type": null, "when": "company_holds_bvi_land is true." }, { "code": "register_filing_overdue", "type": null, "when": "More than 30 days have passed since the register entry." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover vg.shares.transfer, this entity, or the spending limit." } ] } }, "Params_vg_share_option_grant": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "instrument_type": { "type": "string", "enum": [ "option", "warrant", "conversion_right", "other_right_to_acquire" ], "description": "Kind of right granted.", "examples": [ "option" ] }, "grants": { "type": "array", "items": {}, "description": "One item per holder: {holder, share_class, number_of_shares, exercise_price_per_share, vesting, grant_date, expiry_date}.", "examples": [ "[{\"holder\":\"per_Emp42\",\"share_class\":\"Ordinary\",\"number_of_shares\":1500,\"exercise_price_per_share\":{\"amount\":2.5,\"currency\":\"USD\"},\"vesting\":{\"cliff_months\":12,\"total_months\":48},\"grant_date\":\"2026-11-01\",\"expiry_date\":\"2036-10-31\"}]" ] }, "plan": { "type": "object", "description": "Option plan reference: {name, document, pool_size}.", "examples": [ "{\"name\":\"2026 Equity Incentive Plan\",\"pool_size\":10000}" ] }, "reserve_within_authorised": { "type": "boolean", "description": "Check that the shares under option fit within the authorised maximum.", "examples": [ "true" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio whose shares are under option.", "examples": [ "Alpha Segregated Portfolio" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "instrument_type", "grants" ], "description": "Grants options, warrants or other rights to acquire shares by directors' resolution. BCA s.45 lets directors grant options at such times, to such persons and on such terms as they determine, subject to the memorandum and articles." }, "Create_vg_share_option_grant": { "type": "object", "properties": { "type": { "const": "vg.share_option.grant" }, "params": { "$ref": "#/components/schemas/Params_vg_share_option_grant" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Grant options or warrants over shares in a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_resolution_options", "title": "Directors' resolution granting options", "source": "generated", "required": true }, { "key": "option_agreement", "title": "Option or warrant agreement", "source": "generated", "required": true }, { "key": "option_plan", "title": "Option plan rules", "source": "uploaded", "required": false }, { "key": "members_resolution", "title": "Members' resolution adopting the plan or approving the grant", "source": "generated", "required": false }, { "key": "option_register", "title": "Register of options", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "directors_resolution_options", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "option_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "option_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. Option grants are not filed with the Registrar of Corporate Affairs", "form": "Internal company records: directors' resolution and minutes", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "exceeds_authorised_shares", "type": null, "when": "reserve_within_authorised is true and the shares under option exceed the authorised headroom." }, { "code": "pool_exhausted", "type": null, "when": "The grant exceeds the plan pool." }, { "code": "class_not_authorised", "type": null, "when": "share_class is not in the memorandum." }, { "code": "articles_require_member_approval", "type": null, "when": "The articles or a shareholders' agreement need member approval that has not been obtained." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent's mandate does not cover option grants." } ] } }, "Params_vg_treasury_share_transfer": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key.", "examples": [ "bc_ltd_shares" ] }, "transfers": { "type": "array", "items": {}, "description": "[{transferee, share_class, number_of_shares, price_per_share, consideration_type}].", "examples": [ "[{\"transferee\":\"per_Inv77\",\"share_class\":\"Ordinary\",\"number_of_shares\":2000,\"price_per_share\":{\"amount\":15,\"currency\":\"USD\"},\"consideration_type\":\"money\"}]" ] }, "transfer_date": { "type": "string", "format": "date", "description": "Intended date of the register entry.", "examples": [ "2026-11-20" ] }, "non_money_consideration": { "type": "object", "description": "{description, amount_to_be_credited, present_cash_value}.", "examples": [ "{\"description\":\"Services rendered\",\"amount_to_be_credited\":{\"amount\":30000,\"currency\":\"USD\"},\"present_cash_value\":{\"amount\":30000,\"currency\":\"USD\"}}" ] }, "pre_emption_status": { "type": "string", "enum": [ "not_applicable", "offered_and_lapsed", "offered_and_accepted", "waived_by_members" ], "description": "s.46 applies through s.65 only if the articles opt in.", "examples": [ "not_applicable" ] }, "segregated_portfolio": { "type": "string", "description": "SPC only: the portfolio.", "examples": [ "Alpha Segregated Portfolio" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "transfers", "transfer_date", "pre_emption_status" ], "description": "Transfers shares the company holds in treasury to a new or existing holder. Under BCA s.65 the provisions on issuing shares apply: - directors set the terms; - pre-emption applies if the articles opt in; - consideration may not be below." }, "Create_vg_treasury_share_transfer": { "type": "object", "properties": { "type": { "const": "vg.treasury_share.transfer" }, "params": { "$ref": "#/components/schemas/Params_vg_treasury_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer treasury shares", "x-entiva": { "jurisdiction": "vg", "stage": "ownership_and_capital", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "directors_resolution_treasury_transfer", "title": "Directors' resolution to transfer treasury shares", "source": "generated", "required": true }, { "key": "non_money_consideration_resolution", "title": "Directors' s.48 resolution", "source": "generated", "required": false }, { "key": "subscription_or_purchase_agreement", "title": "Agreement with the transferee", "source": "generated", "required": true }, { "key": "liability_consent", "title": "Transferee's written agreement where a liability attaches", "source": "generated", "required": false }, { "key": "share_certificate", "title": "Share certificate", "source": "generated", "required": false }, { "key": "kyb_pack", "title": "KYB pack for a corporate transferee at 10% or more", "source": "uploaded", "required": false }, { "key": "updated_register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "register_of_members_filing_receipt", "title": "VIRRGIN filing record", "source": "registry_issued", "required": true } ], "people": [ { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "none" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "directors_resolution_treasury_transfer", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "non_money_consideration_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "subscription_or_purchase_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liability_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "share_certificate", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "register_of_members_filing_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the register of members containing the changes", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insufficient_treasury_shares", "type": null, "when": "The transfer exceeds the treasury shares held in the class." }, { "code": "issue_below_par", "type": null, "when": "The price is below par value (s.47 via s.65)." }, { "code": "non_money_resolution_missing", "type": null, "when": "There is non-money consideration and no s.48 resolution." }, { "code": "pre_emption_not_satisfied", "type": null, "when": "s.46 applies through the articles and is not satisfied." }, { "code": "verification_failed", "type": null, "when": "The transferee fails CDD." } ] } }, "Params_vg_apostille_request": { "type": "object", "properties": { "document_class": { "type": "string", "enum": [ "registrar_certificate", "private_document" ], "description": "Registrar certificates are public documents and go straight to apostille." }, "document": { "type": "string", "pattern": "^doc_", "description": "The document to be apostilled." }, "destination_country": { "type": "string", "description": "ISO 3166 country of use." }, "signer": { "type": "string", "pattern": "^per_", "description": "For private_document: the person who must appear before the notary." }, "copies": { "type": "integer", "description": "Number of apostilled originals, default 1." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Where the apostilled original is couriered." } }, "required": [ "document_class", "document", "destination_country", "delivery_address" ], "description": "Obtains an apostille from the Deputy Governor's Office for a Registrar certificate or a notarised private document, for use in an Apostille Convention country." }, "Create_vg_apostille_request": { "type": "object", "properties": { "type": { "const": "vg.apostille.request" }, "params": { "$ref": "#/components/schemas/Params_vg_apostille_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request an apostille for BVI documents", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "source_document", "title": "Document to apostille", "source": "uploaded", "required": true }, { "key": "notarised_document", "title": "Notarised private document", "source": "uploaded", "required": false }, { "key": "apostille_request", "title": "Apostille request", "source": "generated", "required": true }, { "key": "apostille_certificate", "title": "Apostille", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [], "signatures": [ { "document_key": "notarised_document", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Deputy Governor's Office, Government House, Road Town, Tortola", "form": "Apostille request", "channel": "paper", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "notarisation_required", "type": null, "when": "document_class is private_document and the notarised original has not arrived." }, { "code": "destination_not_apostille_country", "type": null, "when": "The destination is not an Apostille Convention party." }, { "code": "original_not_received", "type": null, "when": "The paper original has not reached the partner." } ] } }, "Params_vg_charge_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The chargor company's entity type." }, "charge": { "type": "string", "description": "The Registry charge reference, or the Entiva id of a charge registered with vg.charge.register." }, "variation_date": { "type": "string", "format": "date", "description": "The date of the variation." }, "variation_description": { "type": "string", "description": "What changed, for example a higher secured amount, additional property, or a new security trustee." }, "variation_instrument": { "type": "string", "pattern": "^doc_", "description": "The executed variation, supplemental deed or amendment." }, "applicant": { "type": "string", "enum": [ "company", "chargee" ], "description": "Default company (s.164)." }, "filing_route": { "type": "string", "enum": [ "registered_agent", "bvi_legal_practitioner" ], "description": "For a company application." }, "chargee_bvi_service_agent": { "type": "object", "description": "Required for a chargee application unless exempt (s.165A-)." } }, "required": [ "entity_type", "charge", "variation_date", "variation_description", "variation_instrument" ], "description": "When the terms of a charge registered under s.163 are varied, the company or the chargee may apply in the approved form to register the variation (BCA s.164-). The Registrar registers it forthwith and issues a certificate of variation." }, "Create_vg_charge_change": { "type": "object", "properties": { "type": { "const": "vg.charge.change" }, "params": { "$ref": "#/components/schemas/Params_vg_charge_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Registration of a variation of a registered charge", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "variation_instrument", "title": "Executed variation instrument", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the variation", "source": "generated", "required": true }, { "key": "register_of_charges_entry", "title": "Updated register of charges entry", "source": "generated", "required": true }, { "key": "application_register_variation", "title": "Application to register a variation (approved form, s.164)", "source": "generated", "required": true }, { "key": "certificate_of_variation", "title": "Certificate of variation of charge", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "variation_instrument", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "application_register_variation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Application to register a variation of a registered charge", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "charge_not_registered", "type": null, "when": "The charge is not on the Register of Registered Charges." }, { "code": "variation_is_new_charge", "type": null, "when": "The change creates a fresh security interest." }, { "code": "chargee_service_agent_required", "type": null, "when": "A chargee application lacks the s.165A notice." }, { "code": "wet_ink_original_required", "type": null, "when": "A deed variation was signed electronically." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the application." } ] } }, "Params_vg_charge_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The chargor company's entity type." }, "charge_type": { "type": "string", "enum": [ "fixed", "floating", "fixed_and_floating", "mortgage", "other" ], "description": "The nature of the security." }, "creation_date": { "type": "string", "format": "date", "description": "The date the company created the charge." }, "acquired_subject_to_charge": { "type": "boolean", "description": "True if the property was acquired already charged (s.160)." }, "secured_liability_description": { "type": "string", "description": "A short description of the liability secured (s.162; Regulations reg 24)." }, "charged_property_description": { "type": "string", "description": "A short description of the property charged (s.162)." }, "chargee": { "type": "object", "description": "{name, address, jurisdiction, entity_type}." }, "security_trustee": { "type": "object", "description": "{name, address} of the agent or trustee for the security (reg 24)." }, "holder": { "type": "object", "description": "{name, address} of the holder of the charge, unless it is a security to bearer (s.162)." }, "negative_pledge": { "type": "string", "description": "Details of any restriction on creating future charges ranking ahead of or equally with this one (s.162)." }, "governing_law": { "type": "string", "description": "Governing law of the charge (s.161).", "examples": [ "VG" ] }, "instrument": { "type": "string", "pattern": "^doc_", "description": "The executed charge instrument (s.161)." }, "segregated_portfolio": { "type": "string", "description": "SPCs only: the portfolio whose assets are charged." }, "register_with_registrar": { "type": "boolean", "description": "Default true." }, "applicant": { "type": "string", "enum": [ "company", "chargee" ], "description": "Default company." }, "filing_route": { "type": "string", "enum": [ "registered_agent", "bvi_legal_practitioner" ], "description": "For a company application (s.163)." }, "chargee_bvi_service_agent": { "type": "object", "description": "{name, address in BVI}." } }, "required": [ "entity_type", "charge_type", "creation_date", "secured_liability_description", "charged_property_description", "chargee", "governing_law", "instrument" ], "description": "A BVI company may create a charge over its property by written instrument, under any governing law agreed with the chargee. It must enter every charge in its own register of charges (s.162)." }, "Create_vg_charge_register": { "type": "object", "properties": { "type": { "const": "vg.charge.register" }, "params": { "$ref": "#/components/schemas/Params_vg_charge_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Registration of a charge created by a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "charge_instrument", "title": "Executed charge instrument", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving entry into the security", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution", "source": "generated", "required": false }, { "key": "register_of_charges_entry", "title": "Entry in the company's register of charges", "source": "generated", "required": true }, { "key": "application_register_charge", "title": "Application to register a charge (approved form, s.163)", "source": "generated", "required": false }, { "key": "chargee_service_agent_notice", "title": "Notice of the chargee's BVI agent for receiving documents (s.165A)", "source": "generated", "required": false }, { "key": "certificate_of_registration_of_charge", "title": "Certificate of registration of charge", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_instrument", "signer_role": "director", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "register_of_charges_entry", "signer_role": "registered_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "application_register_charge", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Application to register a charge, specifying its particulars", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "charge_not_created_by_company", "type": null, "when": "The charge is not over this company's property, for example a shareholder's mortgage over its shares in this company. s.163 covers only charges the company creates; that charge is." }, { "code": "instrument_missing", "type": null, "when": "No executed instrument is attached (s.161 requires writing)." }, { "code": "wet_ink_original_required", "type": null, "when": "A BVI-law deed was signed electronically." }, { "code": "segregated_portfolio_not_identified", "type": null, "when": "An SPC charge does not identify the portfolio (s.142)." }, { "code": "chargee_service_agent_required", "type": null, "when": "A chargee application lacks the s.165A notice and no exemption applies." }, { "code": "directors_not_authorised", "type": null, "when": "The memorandum or articles restrict the power to charge (s.161)." }, { "code": "outstanding_registry_fees", "type": null, "when": "s.239." }, { "code": "entity_struck_off", "type": null, "when": "s.215." }, { "code": "registry_rejected", "type": null, "when": "The Registrar is not satisfied the Part VIII requirements are met (s.163)." } ] } }, "Params_vg_charge_satisfy": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The chargor company's entity type." }, "charge": { "type": "string", "description": "The Registry charge reference or Entiva charge id." }, "release_type": { "type": "string", "enum": [ "paid_or_satisfied_in_full", "ceased_to_affect_all_property", "ceased_to_affect_part_of_property" ], "description": "s.165-." }, "released_property_description": { "type": "string", "description": "Required for a release of part of the property: what is released (s.165)." }, "evidence_route": { "type": "string", "enum": [ "signed_by_chargee", "signed_by_chargee_counsel_or_agent", "statutory_declaration" ], "description": "s.165, or." }, "filer": { "type": "string", "enum": [ "company", "chargee" ], "description": "Default company (s.165)." }, "deed_of_release": { "type": "string", "pattern": "^doc_", "description": "The chargee's release instrument, if any." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Required on the statutory_declaration route: usually a director." } }, "required": [ "entity_type", "charge", "release_type", "evidence_route" ], "description": "Once all liabilities secured by a registered charge are paid or satisfied, or the charge has stopped affecting all or part of the company's property, a notice of satisfaction or release in the approved form may be filed (BCA s.165). The." }, "Create_vg_charge_satisfy": { "type": "object", "properties": { "type": { "const": "vg.charge.satisfy" }, "params": { "$ref": "#/components/schemas/Params_vg_charge_satisfy" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Satisfaction or release of a registered charge", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_satisfaction_or_release", "title": "Notice of satisfaction or release (approved form, s.165-)", "source": "generated", "required": true }, { "key": "statutory_declaration", "title": "Statutory declaration verifying the notice", "source": "generated", "required": false }, { "key": "deed_of_release", "title": "Deed of release from the chargee", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Directors' resolution authorising the filing", "source": "generated", "required": false }, { "key": "register_of_charges_entry", "title": "Register of charges updated to show the satisfaction or release", "source": "generated", "required": true }, { "key": "certificate_of_satisfaction_or_release", "title": "Certificate of satisfaction, release or partial release", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_of_satisfaction_or_release", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_satisfaction_or_release", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "statutory_declaration", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "deed_of_release", "signer_role": "chargee", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "notice_of_satisfaction_or_release", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Notice of satisfaction or release", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "charge_not_registered", "type": null, "when": "There is no registered charge to release." }, { "code": "released_property_missing", "type": null, "when": "A partial release does not specify the property (s.165)." }, { "code": "chargee_signature_or_declaration_required", "type": null, "when": "A company filing has none of the s.165 authentications." }, { "code": "statutory_declaration_not_sworn", "type": null, "when": "The declaration was uploaded without a jurat from a notary or commissioner." }, { "code": "registry_rejected", "type": null, "when": "The notice is incorrectly completed (s.165)." } ] } }, "Params_vg_company_name_change": { "type": "object", "properties": { "name": { "type": "string", "description": "The new company name.", "examples": [ "Example Holdings Limited" ] }, "name_reservation": { "type": "string", "description": "Action id of a name reservation already made for this name." }, "resolution_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Members by default." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the resolution.", "examples": [ "2026-10-15" ] }, "directors": { "type": "array", "items": {}, "description": "Consenting directors when resolution_body is 'directors'." }, "members": { "type": "array", "items": {}, "description": "Consenting members when resolution_body is 'members'." }, "ptc_designation": { "type": "boolean", "description": "private_trust_company only." }, "charitable_or_non_commercial_name": { "type": "boolean", "description": "True when the name needs approval under BCA s.17A or s.17B." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The verified human who instructs Entiva." }, "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Derived from the entity." } }, "required": [ "name", "resolution_body", "resolution_date", "authorised_representative" ], "description": "Changes a BVI business company's name after a resolution. The registered agent files an application to change name, with a notice of amendment where the memorandum is amended." }, "Create_vg_company_name_change": { "type": "object", "properties": { "type": { "const": "vg.company_name.change" }, "params": { "$ref": "#/components/schemas/Params_vg_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a BVI company's name", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' written resolution approving the new name", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Directors' written resolution approving the new name", "source": "generated", "required": false }, { "key": "application_to_change_name", "title": "Application to change name", "source": "generated", "required": true }, { "key": "notice_of_amendment", "title": "Notice of amendment of the memorandum", "source": "generated", "required": false }, { "key": "certificate_of_change_of_name", "title": "Certificate of change of name", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_to_change_name", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, FSC", "form": "Application to change name", "channel": "online", "government_fee": { "amount": 150, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_unavailable", "type": null, "when": "The Registry rejects the name as taken, restricted or not approved." }, { "code": "name_ending_invalid", "type": null, "when": "The name lacks the ending required for the entity type." }, { "code": "resolution_body_not_permitted", "type": null, "when": "Directors cannot decide under the constitution." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The company is not in good standing." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a director's signature." } ] } }, "Params_vg_constitution_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The company's entity type." }, "amendments": { "type": "array", "items": {}, "description": "A list of {document: memorandum|articles, clause, new_text, summary}." }, "approval_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Directors only if the memorandum authorises them (s.12) and the change is outside s.12." }, "required_majority_percent": { "type": "number", "description": "A majority above 50% that the memorandum requires for these provisions (s.12)." }, "class_consents": { "type": "array", "items": {}, "description": "Any class meetings or consents the memorandum requires where class rights are varied: [{class, threshold}]." }, "filing_format": { "type": "string", "enum": [ "notice_of_amendment", "restated_memorandum_and_articles" ], "description": "s.13 or." }, "resolution_date": { "type": "string", "format": "date", "description": "For an already-passed resolution." }, "court_order": { "type": "string", "pattern": "^doc_", "description": "A s.13 order giving the amendment an earlier effective date." }, "changes_authorised_shares": { "type": "boolean", "description": "If the maximum number of shares changes, Entiva also creates vg.authorised_shares.change." } }, "required": [ "entity_type", "amendments", "approval_body", "filing_format" ], "description": "The members amend the memorandum or articles by resolution (BCA s.12). The directors may do so only where the memorandum authorises it (s.12)." }, "Create_vg_constitution_amend": { "type": "object", "properties": { "type": { "const": "vg.constitution.amend" }, "params": { "$ref": "#/components/schemas/Params_vg_constitution_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amendment of a BVI company's memorandum or articles", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_amend_constitution", "title": "Members' or directors' resolution amending the memorandum or articles", "source": "generated", "required": true }, { "key": "marked_up_constitution", "title": "Marked-up memorandum and articles", "source": "generated", "required": true }, { "key": "notice_of_amendment", "title": "Notice of amendment (approved form, s.13)", "source": "generated", "required": false }, { "key": "restated_constitution", "title": "Restated memorandum and articles incorporating the amendment (s.13)", "source": "generated", "required": false }, { "key": "court_order", "title": "Sealed s.13 court order", "source": "uploaded", "required": false }, { "key": "registered_amendment", "title": "Notice or restated M&A as registered by the Registrar", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution_amend_constitution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_amend_constitution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of amendment of memorandum or articles", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "amendment_prohibited", "type": null, "when": "The provision is entrenched, or a memorandum condition is not met (s.12,)." }, { "code": "directors_not_authorised", "type": null, "when": "The memorandum does not authorise directors to amend (s.12)." }, { "code": "directors_amendment_restricted", "type": null, "when": "Directors try to restrict members' amendment rights, change the amendment majority, or amend where members cannot (s.12)." }, { "code": "restricted_purposes_statement_protected", "type": null, "when": "A restricted purposes company tries to delete or modify its s.10 statement (s.14), or another company tries to add one (s.14)." }, { "code": "resolution_threshold_not_met", "type": null, "when": "The consents fall short of s.81, the memorandum majority or class consents." }, { "code": "use_name_change_action", "type": null, "when": "The only change is the company name." }, { "code": "court_order_window_expired", "type": null, "when": "The filing period in the s.13 order has passed, so the order lapses (s.13)." }, { "code": "outstanding_registry_fees", "type": null, "when": "s.239." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the filing." } ] } }, "Params_vg_foreign_character_name_change": { "type": "object", "properties": { "foreign_character_name": { "type": "string", "description": "The new name in non-Latin script." }, "script_language": { "type": "string", "description": "BCP 47 language and script tag." }, "is_translation_of_name": { "type": "boolean", "description": "Whether the new name translates, or means the same as, the company name (reg 7, applied by reg 9)." }, "meanings": { "type": "array", "items": {}, "description": "Meaning or meanings of the new name (reg 7)." }, "certified_statement": { "type": "string", "pattern": "^doc_", "description": "Statement of meaning certified under reg 29." }, "translator_status": { "type": "string", "enum": [ "certified_before_notary", "sworn_court_or_government_translator" ], "description": "As for registration (reg 29-)." }, "approval_route": { "type": "string", "enum": [ "members_resolution", "directors_resolution" ], "description": "Who amends the memorandum and articles." }, "amendment_filing": { "type": "string", "enum": [ "notice_of_amendment", "restated_memorandum_and_articles" ], "description": "How the amendment is filed." }, "registrar_direction": { "type": "string", "pattern": "^doc_", "description": "The Registrar's notice directing a change, if any (reg 11)." }, "direction_deadline": { "type": "string", "format": "date", "description": "Date in the Registrar's notice, at least 14 days after the notice (reg 11)." } }, "required": [ "foreign_character_name", "script_language", "is_translation_of_name", "meanings", "certified_statement", "translator_status", "approval_route" ], "description": "Changes a BVI company's registered foreign character name (BCA s.21; BVI Business Companies Regulations reg 9). As on first registration, the application in the approved form must come with a certified statement of the new name's meaning." }, "Create_vg_foreign_character_name_change": { "type": "object", "properties": { "type": { "const": "vg.foreign_character_name.change" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_character_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a company's foreign character name", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_meaning_statement", "title": "Certified statement of meaning of the new name", "source": "uploaded", "required": true }, { "key": "resolution", "title": "Resolution amending the memorandum and articles", "source": "generated", "required": true }, { "key": "memorandum_amendment", "title": "Notice of amendment, or restated memorandum and articles", "source": "generated", "required": true }, { "key": "change_application", "title": "Application to change foreign character name", "source": "generated", "required": true }, { "key": "certificate_of_change_of_name", "title": "Certificate of change of name", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "translator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_meaning_statement", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "change_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Application to change name or foreign character name", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_fcn_registered", "type": null, "when": "The company has no foreign character name; use vg.foreign_character_name.register." }, { "code": "fcn_unavailable", "type": null, "when": "The new name is identical or confusingly similar to another company's foreign character name (reg 6)." }, { "code": "fcn_refused", "type": null, "when": "The Registrar refuses to approve the name." }, { "code": "directors_not_authorised", "type": null, "when": "Directors cannot amend the memorandum and articles under s.12-." }, { "code": "direction_deadline_passed", "type": null, "when": "The date in the Registrar's direction has passed, and the Registrar may already have deregistered the name." } ] } }, "Params_vg_foreign_character_name_deregister": { "type": "object", "properties": { "basis": { "type": "string", "enum": [ "company_application", "registrar_deregistration_follow_up" ], "description": "company_application: the company applies to deregister. registrar_deregistration_follow_up: the Registrar has already deregistered the name, and only the." }, "approval_route": { "type": "string", "enum": [ "members_resolution", "directors_resolution" ], "description": "Who amends the memorandum and articles." }, "amendment_filing": { "type": "string", "enum": [ "notice_of_amendment", "restated_memorandum_and_articles" ], "description": "Notice of amendment removing every reference, or a restated memorandum and articles with none (reg 10, reg 11)." }, "registrar_certificate": { "type": "string", "pattern": "^doc_", "description": "Required for registrar_deregistration_follow_up: the Registrar's certificate of change of name (reg 11)." }, "registrar_certificate_date": { "type": "string", "format": "date", "description": "Required for registrar_deregistration_follow_up." }, "remove_from_common_seal": { "type": "boolean", "description": "Replace a common seal that shows the foreign character name." } }, "required": [ "basis", "approval_route" ], "description": "Removes a BVI company's foreign character name from the Register. The company applies in the approved form with a notice of amendment, or a restated memorandum and articles, removing every reference to the name." }, "Create_vg_foreign_character_name_deregister": { "type": "object", "properties": { "type": { "const": "vg.foreign_character_name.deregister" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_character_name_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a company's foreign character name", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution", "title": "Resolution amending the memorandum and articles", "source": "generated", "required": true }, { "key": "memorandum_amendment", "title": "Notice of amendment, or restated memorandum and articles", "source": "generated", "required": true }, { "key": "deregistration_application", "title": "Application to deregister a foreign character name", "source": "generated", "required": false }, { "key": "registrar_certificate", "title": "Registrar's certificate of change of name", "source": "uploaded", "required": false }, { "key": "certificate_of_deregistration_of_fcn", "title": "Certificate of deregistration of the foreign character name", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "memorandum_amendment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Application to deregister a foreign character name", "channel": "online", "government_fee": { "amount": 150, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_fcn_registered", "type": null, "when": "The company has no foreign character name to deregister." }, { "code": "registrar_certificate_required", "type": null, "when": "basis is registrar_deregistration_follow_up but the Registrar's certificate or its date is missing." }, { "code": "directors_not_authorised", "type": null, "when": "Directors cannot amend the memorandum and articles under s.12-." } ] } }, "Params_vg_foreign_character_name_register": { "type": "object", "properties": { "foreign_character_name": { "type": "string", "description": "The name in a non-Latin script." }, "script_language": { "type": "string", "description": "BCP 47 language and script tag, for example zh-Hant or ja." }, "is_translation_of_name": { "type": "boolean", "description": "Whether the foreign character name is a translation of, or means the same as, the company name (reg 7)." }, "meanings": { "type": "array", "items": {}, "description": "Meaning or meanings of the foreign character name in English (reg 7)." }, "certified_statement": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the statement of meaning, certified by a competent person before a notary or oath administrator (reg 7, reg 29)." }, "translator_status": { "type": "string", "enum": [ "certified_before_notary", "sworn_court_or_government_translator" ], "description": "A sworn court- or government-appointed translator needs no notarial certification but must state their appointment in writing (reg 29-)." }, "approval_route": { "type": "string", "enum": [ "members_resolution", "directors_resolution" ], "description": "Who amends the memorandum and articles." }, "amendment_filing": { "type": "string", "enum": [ "notice_of_amendment", "restated_memorandum_and_articles" ], "description": "How the amendment is filed (reg 7; BCA s.13)." }, "add_to_common_seal": { "type": "boolean", "description": "Also add the foreign character name to the common seal, which the Act allows (s.102)." } }, "required": [ "foreign_character_name", "script_language", "is_translation_of_name", "meanings", "certified_statement", "translator_status", "approval_route" ], "description": "Registers an additional name in a non-Latin script, such as Chinese characters, for an existing BVI company. The application, in the approved form, comes with two things: a statement of the name's meaning, certified before a notary or oath." }, "Create_vg_foreign_character_name_register": { "type": "object", "properties": { "type": { "const": "vg.foreign_character_name.register" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_character_name_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an additional foreign character name", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_meaning_statement", "title": "Certified statement of meaning", "source": "uploaded", "required": true }, { "key": "resolution", "title": "Resolution amending the memorandum and articles", "source": "generated", "required": true }, { "key": "memorandum_amendment", "title": "Notice of amendment, or restated memorandum and articles", "source": "generated", "required": true }, { "key": "fcn_application", "title": "Application for approval and registration of a foreign character name", "source": "generated", "required": true }, { "key": "certificate_of_registration_of_fcn", "title": "Certificate of registration of additional foreign character name", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "translator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_meaning_statement", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "fcn_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Application for approval and registration of a foreign character name", "channel": "online", "government_fee": { "amount": 150, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "fcn_unavailable", "type": null, "when": "The name is identical or confusingly similar to another company's foreign character name and the companies are not affiliates (reg 6-)." }, { "code": "fcn_refused", "type": null, "when": "" }, { "code": "directors_not_authorised", "type": null, "when": "approval_route is directors_resolution but the memorandum does not let directors amend it (s.12-)." }, { "code": "certified_statement_missing", "type": null, "when": "No certified statement of meaning is attached." }, { "code": "fcn_already_registered", "type": null, "when": "The company already has a foreign character name; use vg.foreign_character_name.change." } ] } }, "Params_vg_foreign_character_name_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key." }, "foreign_character_name": { "type": "string", "description": "The registered foreign character name to remove." }, "director": { "type": "string", "pattern": "^per_", "description": "Director signing the resolution." } }, "required": [ "entity_type", "foreign_character_name", "director" ], "description": "Removes an additional foreign character name from a BVI company's registration." }, "Create_vg_foreign_character_name_remove": { "type": "object", "properties": { "type": { "const": "vg.foreign_character_name.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_character_name_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deregister a foreign character name", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution approving deregistration", "source": "generated", "required": true }, { "key": "foreign_name_application", "title": "Application to deregister foreign character name", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "foreign_name_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Application to deregister a foreign character name", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_foreign_character_name_registered", "type": null, "when": "No foreign character name is registered for the entity." } ] } }, "Params_vg_foreign_company_change": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "List of {particular, previous, new}. particular is one of name, domicile, constitution, directors, members, registered_office, registered_agent, other." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect in the home jurisdiction; the 30-day clock starts here." }, "name": { "type": "string", "description": "New home-jurisdiction name, if changed." }, "domicile": { "type": "string", "description": "New home jurisdiction, if changed." }, "directors": { "type": "array", "items": {}, "description": "Full list of directors after the change, as person_refs with appointment or cessation dates." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office in the home jurisdiction." }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "Officer of the foreign company confirming the change and its authority." } }, "required": [ "changes", "effective_date", "authorised_signatory" ], "description": "Files the s.188 notice telling the Registrar of changes to a registered foreign company's name, domicile, constitution, directors, members, home registered office, registered agent or other particulars." }, "Create_vg_foreign_company_change": { "type": "object", "properties": { "type": { "const": "vg.foreign_company.change" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify change in particulars of a foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "home_registry_evidence", "title": "Evidence of the change", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified translation", "source": "uploaded", "required": false }, { "key": "change_notice", "title": "Notice of change in particulars", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "change_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "home_registry_evidence", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Notice of change in particulars of a foreign company", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_foreign_company", "type": null, "when": "The entity is not a registered foreign company." }, { "code": "change_outside_deadline", "type": null, "when": "More than 30 days have passed; a penalty is added to the quote, the action is not blocked." }, { "code": "evidence_missing", "type": null, "when": "No home registry evidence was uploaded." } ] } }, "Params_vg_foreign_company_name_change": { "type": "object", "properties": { "corporate_name": { "type": "string", "description": "The new corporate name exactly as registered in the home jurisdiction." }, "change_effective_date": { "type": "string", "format": "date", "description": "Date the name changed under home law." }, "authorisation": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the directors' resolution or other authorisation the constitution permits (s.188)." }, "home_registry_certificate": { "type": "string", "pattern": "^doc_", "description": "Home registry's certificate of change of name." }, "name_translation": { "type": "string", "pattern": "^doc_", "description": "Required if the new name has a meaning in a language other than English: a translation certified by the translator under reg 29." }, "alternate_name": { "type": "string", "description": "A name to use in the BVI if the Registrar considers the new name undesirable and requires the company to stop using it there (ss.186, 190)." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Required as true if the change is more than 30 days old." } }, "required": [ "corporate_name", "change_effective_date" ], "description": "Files the notice a registered foreign company must file within 30 days after changing its corporate name under its home law (BCA s.188). The notice must come with a resolution of directors, or another form of authorisation its constitution." }, "Create_vg_foreign_company_name_change": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_name.change" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a foreign company's change of name", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "name_change_notice", "title": "Notice of change in particulars: corporate name", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution of directors confirming the change of name", "source": "generated", "required": true }, { "key": "home_registry_certificate", "title": "Home registry certificate of change of name", "source": "uploaded", "required": false }, { "key": "name_translation", "title": "Certified translation of the new name", "source": "uploaded", "required": false }, { "key": "certificate_of_change_of_name", "title": "BVI certificate of change of name", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "translator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "name_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "name_change_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change in particulars of a foreign company: corporate name", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorisation_missing", "type": null, "when": "No authorisation is uploaded and the generated resolution has not been signed." }, { "code": "translation_required", "type": null, "when": "The new name has a non-English meaning and no certified translation is attached." }, { "code": "name_undesirable", "type": null, "when": "The Registrar considers the name undesirable." }, { "code": "late_penalty_acknowledgement_required", "type": null, "when": "The change is more than 30 days old and acknowledge_late_penalty is not true." }, { "code": "human_signature_required", "type": null, "when": "An agent key tries to sign the directors' resolution." } ] } }, "Params_vg_foreign_company_particulars_change": { "type": "object", "properties": { "changes": { "type": "array", "items": {}, "description": "One or more changes, each {kind, effective_date, details}. kind is domicile, constitution, directors, director_particulars, members, member_particulars." }, "directors": { "type": "array", "items": {}, "description": "Required for directors or director_particulars changes." }, "members": { "type": "array", "items": {}, "description": "Required for members or member_particulars changes." }, "domicile": { "type": "string", "description": "Required for a domicile change: ISO 3166 code of the new jurisdiction of domiciliation (s.188)." }, "home_registered_office": { "$ref": "#/components/schemas/Address", "description": "Required for a home_registered_office change: the new registered office address in the country of incorporation (s.186, s.188)." }, "constitution": { "type": "string", "pattern": "^doc_", "description": "Required for a constitution change: certified copy of the new or amended instrument (s.188)." }, "constitution_translation": { "type": "string", "pattern": "^doc_", "description": "Required if the instrument is not in English: translation certified under BCA Regulations reg 29 (s.188)." }, "members_list_public": { "type": "boolean", "description": "Opt in to letting the Registrar make the list of members available to the public." }, "acknowledge_late_penalty": { "type": "boolean", "description": "Required as true if any change took effect more than 30 days ago, to accept the late-filing penalty in the quote." } }, "required": [ "changes" ], "description": "Files the approved-form notice that a foreign company registered in the BVI must file within 30 days after a change in its domicile, constitution, directors, members, home registered office or other prescribed particulars (BCA s.188-,). An." }, "Create_vg_foreign_company_particulars_change": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_particulars.change" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_particulars_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File changes in a foreign company's particulars", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_notice", "title": "Notice of change in particulars of a foreign company", "source": "generated", "required": true }, { "key": "change_confirmation", "title": "Confirmation of changed particulars", "source": "generated", "required": true }, { "key": "updated_directors_list", "title": "Updated list of directors", "source": "generated", "required": false }, { "key": "updated_members_list", "title": "Updated list of members", "source": "generated", "required": false }, { "key": "certified_constitution", "title": "Certified copy of the new or amended constitution", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "domicile_evidence", "title": "Evidence of the change of domicile", "source": "uploaded", "required": false }, { "key": "home_registry_extract", "title": "Home registry extract", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "translator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "change_confirmation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "change_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change in particulars of a foreign company", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_name_change_action", "type": null, "when": "A change of corporate name is included; use vg.foreign_company_name.change." }, { "code": "use_registered_agent_change_action", "type": null, "when": "A change of registered agent is included; use vg.foreign_company_registered_agent.change." }, { "code": "translation_required", "type": null, "when": "The new constitution is not in English and no certified translation is attached (s.188)." }, { "code": "late_penalty_acknowledgement_required", "type": null, "when": "A change is more than 30 days old and acknowledge_late_penalty is not true." }, { "code": "ceased_business_use_closure_action", "type": null, "when": "The company has stopped carrying on business in the BVI; it must instead file a notice within 7 days (s.193)." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered foreign company." } ] } }, "Params_vg_foreign_company_registered_agent_change": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "transfer_in", "transfer_out" ], "description": "transfer_in moves the company to Entiva; transfer_out moves it to another licensed agent." }, "outgoing_registered_agent": { "type": "object", "description": "{name, fsc_licence_number, contact_email} of the current registered agent." }, "incoming_registered_agent": { "type": "object", "description": "Required for transfer_out: {name, fsc_licence_number, contact_email} of the new FSC-licensed agent (s.189)." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the board decision appointing the new agent." }, "principal_place_of_business_bvi": { "$ref": "#/components/schemas/Address", "description": "The company's principal place of business in the BVI, if any." } }, "required": [ "direction", "outgoing_registered_agent", "effective_date" ], "description": "Files the notice a registered foreign company must file within 30 days after changing its BVI registered agent (BCA s.188). The notice is endorsed by the new registered agent with its agreement to act (s.188)." }, "Create_vg_foreign_company_registered_agent_change": { "type": "object", "properties": { "type": { "const": "vg.foreign_company_registered_agent.change" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_registered_agent_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change a foreign company's registered agent", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution appointing the new registered agent", "source": "generated", "required": true }, { "key": "registered_agent_endorsement", "title": "New registered agent's agreement to act", "source": "generated", "required": true }, { "key": "agent_change_notice", "title": "Notice of change in particulars: registered agent", "source": "generated", "required": true }, { "key": "cdd_pack", "title": "Company CDD pack", "source": "uploaded", "required": false }, { "key": "records_from_outgoing_agent", "title": "Records from the outgoing agent", "source": "uploaded", "required": false }, { "key": "filed_agent_change_notice", "title": "Registered notice of change of registered agent", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registered_agent_endorsement", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "agent_change_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change in particulars of a foreign company: registered agent", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "incoming_agent_details_required", "type": null, "when": "direction is transfer_out and no incoming_registered_agent is given." }, { "code": "cdd_incomplete", "type": null, "when": "On a transfer-in, a director, member or beneficial owner is not yet verified, or the partner has not accepted the client." }, { "code": "entity_removed_from_register", "type": null, "when": "The foreign company has been removed from the Register of Foreign Companies; it must apply to register again." }, { "code": "late_penalty_acknowledgement_required", "type": null, "when": "The change is more than 30 days old and the penalty has not been acknowledged." } ] } }, "Params_vg_lp_agreement_amend": { "type": "object", "properties": { "amendment_type": { "type": "string", "enum": [ "amendment", "restated_agreement" ], "description": "A specific amendment, or a full restatement." }, "amendments": { "type": "string", "description": "Plain-language summary of the changes." }, "effective_date": { "type": "string", "format": "date", "description": "Date the amendment takes effect under the agreement.", "examples": [ "2026-10-15" ] }, "registered_particulars_changed": { "type": "boolean", "description": "True if any particular in the s.8 statement changes." }, "general_partners": { "type": "array", "items": {}, "description": "General partners who sign." }, "limited_partners": { "type": "array", "items": {}, "description": "Limited partners whose consent the agreement requires." }, "executed_as_deed": { "type": "boolean", "description": "True if the amendment is executed as a deed." }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The verified human who instructs Entiva." }, "entity_type": { "type": "string", "enum": [ "lp" ], "description": "Derived from the entity." } }, "required": [ "amendment_type", "effective_date", "registered_particulars_changed", "general_partners", "authorised_representative" ], "description": "Amends or restates a BVI limited partnership agreement under its own terms and lodges it with the registered agent within 15 days (LPA s.7). If particulars in the registered statement change, the agent also files a notice of change in." }, "Create_vg_lp_agreement_amend": { "type": "object", "properties": { "type": { "const": "vg.lp_agreement.amend" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_agreement_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend a BVI limited partnership agreement", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "lp_agreement_amendment", "title": "Amendment or restated partnership agreement", "source": "uploaded", "required": true }, { "key": "partners_resolution", "title": "Partner consent record", "source": "generated", "required": false }, { "key": "notice_of_change_of_particulars", "title": "Notice of change in registered particulars", "source": "generated", "required": false }, { "key": "lodgement_confirmation", "title": "Registered agent's confirmation of lodgement", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "ai_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "lp_agreement_amendment", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lp_agreement_amendment", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_change_of_particulars", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registered agent", "form": "Amendment or restated LP agreement lodged with the registered agent", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "lodgement_deadline_missed", "type": null, "when": "More than 15 days have passed since the amendment (s.7)." }, { "code": "particulars_deadline_missed", "type": null, "when": "More than 14 days have passed for the s.10 notice." }, { "code": "deed_requires_wet_ink", "type": null, "when": "executed_as_deed is true and an electronic signature is requested." }, { "code": "human_presence_required", "type": null, "when": "An agent attempts a personal step." } ] } }, "Params_vg_lp_charge_change": { "type": "object", "properties": { "registered_charge": { "type": "string", "description": "The Registrar's reference for the registered charge, or the Entiva charge id from the partnership's register of charges." }, "variation_date": { "type": "string", "format": "date", "description": "Date the variation took effect." }, "variation_summary": { "type": "string", "description": "Plain description of what changed, for example an increased facility amount, added assets or a new security trustee." }, "variation_instrument": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the executed amendment, supplemental deed or amendment and restatement." }, "updated_particulars": { "type": "object", "description": "Particulars after the variation: {liability_secured, assets_charged, chargee, holder, security_trustee, negative_pledge, negative_pledge_details}." }, "applicant": { "type": "string", "enum": [ "lp", "chargee" ], "description": "Who applies (s.60)." }, "chargee_bvi_document_agent": { "type": "object", "description": "Required when applicant is chargee, unless s.62 applies: {name, address} of the chargee's BVI document agent (s.62)." }, "authorising_general_partner": { "type": "string", "pattern": "^per_", "description": "per_ id of the general partner that approved the variation." } }, "required": [ "registered_charge", "variation_date", "variation_summary", "variation_instrument", "authorising_general_partner" ], "description": "Registers a variation in the terms of a charge already registered against a BVI limited partnership. The partnership, a general partner or BVI counsel may apply, and so may the chargee, using the approved form." }, "Create_vg_lp_charge_change": { "type": "object", "properties": { "type": { "const": "vg.lp_charge.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_charge_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a variation of a limited partnership charge", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "variation_instrument", "title": "Executed variation instrument", "source": "uploaded", "required": true }, { "key": "gp_authorisation", "title": "General partner authorisation", "source": "generated", "required": true }, { "key": "variation_application", "title": "Application for registration of variation of charge", "source": "generated", "required": true }, { "key": "chargee_agent_notice", "title": "Notice of the chargee's BVI document agent", "source": "generated", "required": false }, { "key": "certificate_of_variation", "title": "Certificate of variation of charge", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_authorisation", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "variation_instrument", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "variation_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services C", "form": "Application for registration of variation of charge", "channel": "online", "government_fee": { "amount": 300, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "charge_not_registered", "type": null, "when": "No registered charge matches registered_charge." }, { "code": "chargee_document_agent_required", "type": null, "when": "applicant is chargee and no BVI document agent is given, and no s.62 exemption applies." }, { "code": "registry_fees_outstanding", "type": null, "when": "Registry fees or penalties are unpaid (LPA s.115)." }, { "code": "sanctions_match", "type": null, "when": "A new chargee, holder or security trustee matches a sanctions list." }, { "code": "human_signature_required", "type": null, "when": "An agent key tries to sign the general partner authorisation." } ] } }, "Params_vg_lp_charge_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "The priority rules in LPA ss.63-65 apply only to a limited_partnership with legal personality." }, "charge_instrument": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the executed instrument creating the charge." }, "creation_date": { "type": "string", "format": "date", "description": "Date the charge was created, or the date the asset was acquired if the charge already existed on it (s.58)." }, "charge_type": { "type": "string", "enum": [ "fixed", "floating", "fixed_and_floating" ], "description": "Nature of the security." }, "liability_secured": { "type": "string", "description": "Short description of the liability secured, including contingent and prospective liabilities (s.56, s.58)." }, "assets_charged": { "type": "string", "description": "Short description of the assets charged." }, "chargee": { "type": "object", "description": "{name, kind: individual | corporate | limited_partnership, registration_number, jurisdiction, address}." }, "security_trustee": { "type": "object", "description": "{name, address} of the trustee for the security, if any (s.58)." }, "holder": { "type": "object", "description": "{name, address} of the holder of the charge, if different from the chargee (s.58)." }, "negative_pledge": { "type": "boolean", "description": "Whether the instrument prohibits or restricts the partnership from creating future charges ranking ahead of or equally with this one (s.58)." }, "negative_pledge_details": { "type": "string", "description": "Required when negative_pledge is true: the prohibition or restriction as worded in the instrument." }, "governing_law": { "type": "string", "description": "Law governing the charge, as a jurisdiction code such as VG, US-NY or GB-ENG." }, "applicant": { "type": "string", "enum": [ "lp", "chargee" ], "description": "Who applies (s.59)." }, "chargee_bvi_document_agent": { "type": "object", "description": "Required when applicant is chargee: {name, address} of the person in the BVI the chargee authorises to accept Registrar documents (s.62)." }, "authorising_general_partner": { "type": "string", "pattern": "^per_", "description": "per_ id of the general partner that approved the charge and authorises the filing." } }, "required": [ "charge_instrument", "creation_date", "charge_type", "liability_secured", "assets_charged", "chargee", "negative_pledge", "governing_law", "authorising_general_partner" ], "description": "Registers a charge created over the assets of a BVI limited partnership in the Registrar's Register of Registered Charges. The application, in the approved form, gives the particulars of the charge." }, "Create_vg_lp_charge_register": { "type": "object", "properties": { "type": { "const": "vg.lp_charge.register" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_charge_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a charge over limited partnership assets", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "charge_instrument", "title": "Executed charge instrument", "source": "uploaded", "required": true }, { "key": "gp_authorisation", "title": "General partner authorisation", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "charge_application", "title": "Application for registration of charge", "source": "generated", "required": true }, { "key": "chargee_agent_notice", "title": "Notice of the chargee's BVI document agent", "source": "generated", "required": false }, { "key": "certificate_of_registration_of_charge", "title": "Certificate of registration of charge", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_authorisation", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_instrument", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "charge_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services C", "form": "Application for registration of charge", "channel": "online", "government_fee": { "amount": 300, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI limited partnership." }, { "code": "negative_pledge_details_required", "type": null, "when": "negative_pledge is true but negative_pledge_details is missing." }, { "code": "chargee_document_agent_required", "type": null, "when": "applicant is chargee and no BVI document agent is given, and no s.62 exemption applies." }, { "code": "partnership_agreement_restriction", "type": null, "when": "The partnership agreement prohibits the charge or requires consents that have not been given." }, { "code": "registry_fees_outstanding", "type": null, "when": "The partnership owes Registry fees or penalties." }, { "code": "sanctions_match", "type": null, "when": "The chargee or holder matches a sanctions list." }, { "code": "human_signature_required", "type": null, "when": "An agent key tries to sign a document marked human_only_electronic or human_wet_ink." } ] } }, "Params_vg_lp_charge_satisfy": { "type": "object", "properties": { "registered_charge": { "type": "string", "description": "The Registrar's reference for the registered charge, or the Entiva charge id." }, "basis": { "type": "string", "enum": [ "paid_or_satisfied_in_full", "ceased_to_affect_assets" ], "description": "The ground for the notice (s.61,)." }, "release_scope": { "type": "string", "enum": [ "all_assets", "some_assets" ], "description": "Required when basis is ceased_to_affect_assets: whether the release covers all the partnership's assets or only some (s.61)." }, "released_assets": { "type": "string", "description": "Required when release_scope is some_assets: the assets no longer affected by the charge (s.61)." }, "release_date": { "type": "string", "format": "date", "description": "Date of payment in full or of the release." }, "release_evidence": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the deed of release, payoff letter or chargee's confirmation." }, "confirmation_route": { "type": "string", "enum": [ "chargee_signs", "chargee_professional_signs", "statutory_declaration" ], "description": "How the notice is verified when filed for the partnership (s.61): signed by the chargee; signed by BVI counsel or a registered agent acting for the chargee; or." }, "chargee_signatory": { "type": "object", "description": "Required for chargee_signs or chargee_professional_signs: {name, title, organisation, email} of the person who will sign the notice." }, "declarant": { "type": "string", "pattern": "^per_", "description": "Required for statutory_declaration: per_ id of the person who swears the declaration, normally a director or authorised signatory of the general partner." } }, "required": [ "registered_charge", "basis", "release_date", "release_evidence", "confirmation_route" ], "description": "Files a notice of satisfaction or release for a charge registered against a BVI limited partnership. It covers two cases: all secured liabilities are paid or satisfied in full, or the charge has ceased to affect some or all of the." }, "Create_vg_lp_charge_satisfy": { "type": "object", "properties": { "type": { "const": "vg.lp_charge.satisfy" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_charge_satisfy" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register satisfaction or release of a limited partnership charge", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "release_evidence", "title": "Release evidence", "source": "uploaded", "required": true }, { "key": "satisfaction_notice", "title": "Notice of satisfaction or release of charge", "source": "generated", "required": true }, { "key": "statutory_declaration", "title": "Statutory declaration verifying the notice", "source": "generated", "required": false }, { "key": "certificate_of_satisfaction_or_release", "title": "Certificate of satisfaction or release", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "chargee", "verification_level": "none" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "satisfaction_notice", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "satisfaction_notice", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "statutory_declaration", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "satisfaction_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services C", "form": "Notice of satisfaction or release of charge", "channel": "online", "government_fee": { "amount": 300, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "charge_not_registered", "type": null, "when": "No registered charge matches registered_charge." }, { "code": "released_assets_required", "type": null, "when": "basis is ceased_to_affect_assets and release_scope is some_assets, but released_assets is missing." }, { "code": "chargee_confirmation_missing", "type": null, "when": "confirmation_route needs a chargee signature but no chargee_signatory is given, or a statutory declaration route has no declarant." }, { "code": "registry_fees_outstanding", "type": null, "when": "Registry fees or penalties are unpaid (LPA s.115)." }, { "code": "human_signature_required", "type": null, "when": "An agent key tries to sign the notice for the chargee or the statutory declaration." } ] } }, "Params_vg_lp_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type." }, "name": { "type": "string", "description": "Ends with 'Limited Partnership', 'L.P.' or 'LP' (s.11).", "examples": [ "Harbour Point Fund I LP" ] }, "name_reservation_id": { "type": "string", "description": "A 90-day reservation." }, "lp_consent_required": { "type": "boolean", "description": "True if the LPA requires limited partners to consent to a name change (s.15 is subject to the LPA)." }, "restricted_word_consent": { "type": "string", "pattern": "^doc_", "description": "FSC written consent for a restricted word (s.13; LP Regulations reg 5)." }, "similar_name_consent": { "type": "string", "pattern": "^doc_", "description": "Written consent of an existing LP or BVI company with a similar name (s.13)." }, "foreign_language_meaning": { "type": "boolean", "description": "A certified translation is required (LP Regulations regs 4, 17)." }, "amend_partnership_agreement": { "type": "boolean", "description": "Default true." }, "reason": { "type": "string", "enum": [ "voluntary", "registrar_direction" ], "description": "The Registrar may direct a change, giving at least 21 days." } }, "required": [ "entity_type", "name" ], "description": "Subject to its limited partnership agreement, the LP applies to the Registrar to change its registered name (LPA s.15). The general partners file a notice of change in registered particulars within 14 days, because the name is part of the." }, "Create_vg_lp_name_change": { "type": "object", "properties": { "type": { "const": "vg.lp_name.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of name of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_resolution", "title": "General partner resolution approving the new name", "source": "generated", "required": true }, { "key": "lp_consent", "title": "Limited partners' consent", "source": "generated", "required": false }, { "key": "application_change_name", "title": "Application to change registered name (LPA s.15)", "source": "generated", "required": true }, { "key": "notice_change_registered_particulars", "title": "Notice of change in registered particulars", "source": "generated", "required": true }, { "key": "certified_translation", "title": "Certified translation of the name", "source": "uploaded", "required": false }, { "key": "fsc_restricted_word_consent", "title": "FSC consent to a restricted word", "source": "uploaded", "required": false }, { "key": "similar_name_consent", "title": "Consent of a similarly named LP or company", "source": "uploaded", "required": false }, { "key": "certificate_of_change_of_registered_name", "title": "Certificate of change of registered name", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "translator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_particulars", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lp_consent", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "application_change_name", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Application to change registered name", "channel": "online", "government_fee": { "amount": 125, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_ending_invalid", "type": null, "when": "The name lacks 'Limited Partnership', 'L.P.' or 'LP' (s.11)." }, { "code": "name_too_long", "type": null, "when": "The name has more than 100 permitted characters." }, { "code": "name_unavailable", "type": null, "when": "The name is identical or confusingly similar to an LP, existing LP or BVI company, without that entity's consent (s.13,)." }, { "code": "restricted_word_requires_fsc_consent", "type": null, "when": "s.13." }, { "code": "lpa_consent_missing", "type": null, "when": "The LPA requires LP consent and it is incomplete." }, { "code": "particulars_notice_overdue", "type": null, "when": "More than 14 days have passed since the change (s.10)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses the name." } ] } }, "Params_vg_lp_registered_agent_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type." }, "lp_number": { "type": "string", "description": "Registration number on the certificate of registration." }, "current_registered_agent": { "type": "object", "description": "{name, fsc_licence_number, contact_name, contact_email}" }, "move_registered_office": { "type": "boolean", "description": "Also move the registered office to the partner's office." }, "filing_route": { "type": "string", "enum": [ "outgoing_registered_agent", "bvi_legal_practitioner" ], "description": "Who files (s.21,)." }, "is_recognised_fund": { "type": "boolean", "description": "True if the LP is a recognised private or professional fund." } }, "required": [ "entity_type", "lp_number", "current_registered_agent", "move_registered_office", "filing_route" ], "description": "Moves an existing BVI LP to Entiva's Entiva as registered agent, usually together with the registered office. The LP may change its agent despite anything in its limited partnership agreement (LPA s.21)." }, "Create_vg_lp_registered_agent_change": { "type": "object", "properties": { "type": { "const": "vg.lp_registered_agent.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_registered_agent_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a BVI limited partnership's registered agent to Entiva's Entiva", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_registration", "title": "Certificate of registration of the LP", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Limited partnership agreement with all amendments", "source": "uploaded", "required": true }, { "key": "registers_of_partners", "title": "Registers of general and limited partners", "source": "uploaded", "required": true }, { "key": "beneficial_ownership_information", "title": "Beneficial ownership information", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": true }, { "key": "register_of_charges", "title": "Register of charges", "source": "uploaded", "required": false }, { "key": "kyb_pack", "title": "KYB pack for any corporate GP or corporate LP with 10% or more", "source": "uploaded", "required": false }, { "key": "gp_resolution", "title": "General partner resolution appointing the partner", "source": "generated", "required": true }, { "key": "notice_change_registered_agent", "title": "Notice of change of registered agent endorsed by the new agent (s.21)", "source": "generated", "required": true }, { "key": "practitioner_notice_to_outgoing_agent", "title": "Practitioner's notice with the authorising resolution (LP Regulations reg 18)", "source": "generated", "required": false }, { "key": "cdd_confirmation", "title": "CDD confirmation under LP Regulations reg 18", "source": "generated", "required": false }, { "key": "registered_notice", "title": "Notice endorsed by the Registrar with time and date of registration (s.21)", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Notice of change of registered agent endorsed", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an LPA 2017 LP." }, { "code": "already_registered_agent", "type": null, "when": "The partner is already the LP's agent." }, { "code": "client_not_accepted", "type": null, "when": "The partner declines after CDD." }, { "code": "verification_incomplete", "type": null, "when": "A GP, LP or BO has not passed verification." }, { "code": "outgoing_agent_confirmation_pending", "type": null, "when": "LP Regulations reg 18 is not yet satisfied." }, { "code": "no_registered_agent", "type": null, "when": "The previous agent has resigned." }, { "code": "outstanding_registry_fees", "type": null, "when": "Unpaid fees (LPA s.115)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_lp_registered_agent_resign": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "customer_requested", "unpaid_fees", "cdd_not_provided", "aml_relationship_terminated", "partner_ceasing_service", "other" ], "description": "Why the agent is resigning. aml_relationship_terminated makes resignation mandatory (s.23)." }, "effective_date": { "type": "string", "format": "date", "description": "The date in the notice on which the resignation takes effect, at least 60 days after the notice is given (s.23)." }, "notice_recipient": { "type": "string", "pattern": "^per_", "description": "per_ id of a general partner, or of the last instructing person if no general partner is known (s.23)." }, "recipient_address": { "$ref": "#/components/schemas/Address", "description": "The recipient's last known address." }, "delivery_method": { "type": "string", "enum": [ "courier", "registered_post", "hand", "email_with_acknowledgement" ], "description": "Defaults to courier with an email copy." }, "acknowledge_strike_off_risk": { "type": "boolean", "description": "Required as true when reason is customer_requested." } }, "required": [ "reason", "effective_date", "notice_recipient", "recipient_address" ], "description": "Entiva's Entiva resigns as registered agent of a BVI limited partnership. It gives at least 60 days' written notice of the resignation date to a general partner at their last known address, or to the last person who gave instructions." }, "Create_vg_lp_registered_agent_resign": { "type": "object", "properties": { "type": { "const": "vg.lp_registered_agent.resign" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_registered_agent_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Resign as registered agent of a limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Notice of intention to resign as registered agent", "source": "generated", "required": true }, { "key": "proof_of_delivery", "title": "Proof of delivery of the notice", "source": "generated", "required": true }, { "key": "filed_resignation_notice", "title": "Filed copy of the resignation notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "recipient", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "resignation_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "filed_resignation_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services C", "form": "Copy of the written notice of intention to resign as registered agent", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_period_too_short", "type": null, "when": "resignation_date is less than 60 days after the planned delivery date." }, { "code": "use_change_of_registered_agent", "type": null, "when": "The partnership already has a new agent; it should file a change of registered agent under LPA s.21 instead." }, { "code": "strike_off_risk_not_acknowledged", "type": null, "when": "reason is customer_requested and acknowledge_strike_off_risk is not true." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a limited partnership; use vg.registered_agent.resign." } ] } }, "Params_vg_lp_registered_agent_transfer_out": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type." }, "registered_agent": { "type": "object", "description": "{name, fsc_licence_number, principal_office_address, contact_email}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "A physical BVI address (s.18)." }, "office_at_registered_agent": { "type": "boolean", "description": "Stated in the notice if true (s.18)." }, "filing_route": { "type": "string", "enum": [ "existing_registered_agent", "bvi_legal_practitioner" ], "description": "Default existing_registered_agent." } }, "required": [ "entity_type", "registered_agent", "registered_office", "office_at_registered_agent" ], "description": "The LP appoints another licensed registered agent. The general partners decide, and the new agent endorses the notice (LPA s.21)." }, "Create_vg_lp_registered_agent_transfer_out": { "type": "object", "properties": { "type": { "const": "vg.lp_registered_agent.transfer_out" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_registered_agent_transfer_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a BVI limited partnership from Entiva to another registered agent", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_resolution", "title": "General partner resolution appointing the new agent and office", "source": "generated", "required": true }, { "key": "notice_change_registered_agent", "title": "Notice of change of registered agent endorsed by the new agent", "source": "generated", "required": true }, { "key": "cdd_confirmation", "title": "Entiva CDD confirmation", "source": "generated", "required": false }, { "key": "records_handover_package", "title": "LPA, registers, charges register, filing copies and retention statement", "source": "generated", "required": true }, { "key": "registered_notice", "title": "Registered notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Notice of change of registered agent endorsed", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "new_agent_not_licensed", "type": null, "when": "The proposed agent is not licensed (s.19)." }, { "code": "new_agent_endorsement_missing", "type": null, "when": "The notice has no new-agent endorsement (s.21)." }, { "code": "compliance_hold", "type": null, "when": "A sanctions freeze applies." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_lp_registered_agent_resignation_revoke": { "type": "object", "properties": { "resignation_action": { "type": "string", "description": "act_ id of the vg.lp_registered_agent.resign action being rescinded." }, "rescission_date": { "type": "string", "format": "date", "description": "Date the rescission takes effect, at least 14 days after the rescission notice is given (s.23)." }, "reason": { "type": "string", "enum": [ "fees_paid", "cdd_provided", "customer_request", "other" ], "description": "Why the resignation is withdrawn." }, "delivery_method": { "type": "string", "enum": [ "courier", "registered_post", "hand", "email_with_acknowledgement" ], "description": "How the rescission notice reaches the original recipient." } }, "required": [ "resignation_action", "rescission_date" ], "description": "Withdraws a notice of intention to resign as registered agent of a BVI limited partnership (LPA s.23-). The partner gives at least 14 days' written notice of the rescission date to the person who received the resignation notice, then files." }, "Create_vg_lp_registered_agent_resignation_revoke": { "type": "object", "properties": { "type": { "const": "vg.lp_registered_agent_resignation.revoke" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_registered_agent_resignation_revoke" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rescind a limited partnership registered agent resignation notice", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "rescission_notice", "title": "Notice of intention to rescind the resignation notice", "source": "generated", "required": true }, { "key": "filed_rescission_notice", "title": "Filed rescission notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "recipient", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "rescission_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "filed_rescission_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships, Registry of Corporate Affairs, BVI Financial Services C", "form": "Rescission notice", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "rescission_window_closed", "type": null, "when": "The resignation date is 14 days or less away (s.23)." }, { "code": "agent_already_changed", "type": null, "when": "The partnership has already changed its registered agent (s.23)." }, { "code": "rescission_notice_period_too_short", "type": null, "when": "rescission_date is less than 14 days after the rescission notice is given." } ] } }, "Params_vg_lp_registered_office_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Both are registered under the Limited Partnership Act 2017; legal personality does not change this procedure." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "A physical address in the Virgin Islands (s.18)." }, "office_at_registered_agent": { "type": "boolean", "description": "If true, the notice must state it (s.18)." }, "resolution": { "type": "string", "pattern": "^doc_", "description": "An already-signed general partner resolution." }, "filing_route": { "type": "string", "enum": [ "registered_agent", "bvi_legal_practitioner" ], "description": "Default registered_agent." }, "also_file_particulars_notice": { "type": "boolean", "description": "Also file a s.10 notice of change in registered particulars." } }, "required": [ "entity_type", "registered_office", "office_at_registered_agent" ], "description": "Moves a BVI limited partnership's registered office to another physical BVI address. The LP may do this despite anything to the contrary in its limited partnership agreement (LPA s.21)." }, "Create_vg_lp_registered_office_change": { "type": "object", "properties": { "type": { "const": "vg.lp_registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of registered office of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "gp_resolution", "title": "General partner resolution changing the registered office", "source": "generated", "required": true }, { "key": "notice_change_registered_office", "title": "Notice of change of registered office (LPA s.21)", "source": "generated", "required": true }, { "key": "practitioner_notice_to_registered_agent", "title": "Practitioner's prior written notice with the authorising resolution", "source": "generated", "required": false }, { "key": "registered_notice", "title": "Notice as registered by the Registrar of Limited Partnerships", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "gp_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_office", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Notice of change of registered office", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an LPA 2017 limited partnership." }, { "code": "registered_office_not_in_bvi", "type": null, "when": "The address is not a physical BVI address (s.18)." }, { "code": "legal_practitioner_filing_blocked", "type": null, "when": "LP Regulations reg 18 conditions are not met." }, { "code": "outstanding_registry_fees", "type": null, "when": "Fees are unpaid; the Registrar may refuse to act (LPA s.115)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_lp_registered_particulars_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type." }, "changes": { "type": "array", "items": {}, "description": "A list of {particular: term|other_prescribed_particular|section_8_2_d_document|registered_office|registered_agent|name|foreign_character_name, old_value." }, "effective_date": { "type": "string", "format": "date", "description": "The date the particular changed." }, "term": { "type": "object", "description": "{unlimited: boolean, end_date}." }, "supporting_amendment": { "type": "string", "pattern": "^doc_", "description": "The LPA amendment that changed the particular, if any." } }, "required": [ "entity_type", "changes", "effective_date" ], "description": "During the life of an LP, the general partners must file a notice of change in registered particulars, signed by one or more general partners, whenever information in the registration statement changes. That statement (s.8) covers the name." }, "Create_vg_lp_registered_particulars_change": { "type": "object", "properties": { "type": { "const": "vg.lp_registered_particulars.change" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_registered_particulars_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notice of change in registered particulars of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_change_registered_particulars", "title": "Notice of change in registered particulars", "source": "generated", "required": true }, { "key": "registered_notice", "title": "Notice as registered", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "notice_change_registered_particulars", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_particulars", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI FSC", "form": "Notice of change in registered particulars", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "use_dedicated_action", "type": null, "when": "Only the name, office or agent changes." }, { "code": "particulars_notice_overdue", "type": null, "when": "More than 14 days after change_date." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_name_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The company's entity type." }, "name": { "type": "string", "description": "At most 100 permitted characters, or the 'BVI Company Number' form.", "examples": [ "Harbour Point Capital Ltd" ] }, "name_reservation_id": { "type": "string", "description": "Reference of a 90-day reservation made with vg.name.reserve." }, "approval_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Who resolves, as the memorandum and articles allow (s.21 is 'subject to its memorandum and articles')." }, "reason": { "type": "string", "enum": [ "voluntary", "registrar_direction" ], "description": "registrar_direction applies when the Registrar has directed a change by a date at least 21 days after the notice (s.22)." }, "registrar_direction_deadline": { "type": "string", "format": "date", "description": "The date in the Registrar's s.22 notice." }, "foreign_language_meaning": { "type": "boolean", "description": "True if the name means something in a language other than English." }, "restricted_word_consent": { "type": "string", "pattern": "^doc_", "description": "The FSC's written consent where the name uses a restricted word, phrase or abbreviation (s.18; Regulations reg 5)." }, "omit_corporate_ending": { "type": "boolean", "description": "Apply under s.17B for a name without a s.17 ending." }, "add_ptc_designation": { "type": "boolean", "description": "Private trust companies only: include '' immediately before the corporate ending." }, "similar_name_affiliate": { "type": "string", "pattern": "^ent_", "description": "Where the name is similar to an affiliate's, the Registrar may allow it (s.18)." }, "file_restated_constitution": { "type": "boolean", "description": "Optionally file restated M&A showing the new name." } }, "required": [ "entity_type", "name", "approval_body" ], "description": "The company applies to the Registrar in the approved form to change its name, subject to its memorandum and articles (BCA s.21). The Registrar registers the change and issues a certificate of change of name if the name meets the ending." }, "Create_vg_name_change": { "type": "object", "properties": { "type": { "const": "vg.name.change" }, "params": { "$ref": "#/components/schemas/Params_vg_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of name of a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_change_name", "title": "Members' or directors' resolution approving the new name", "source": "generated", "required": true }, { "key": "application_change_name", "title": "Application to change name (approved form, s.21)", "source": "generated", "required": true }, { "key": "certified_translation", "title": "Certified translation of the name", "source": "uploaded", "required": false }, { "key": "fsc_restricted_word_consent", "title": "FSC written consent to a restricted word", "source": "uploaded", "required": false }, { "key": "s17b_application", "title": "Application to change to a name without a corporate ending", "source": "generated", "required": false }, { "key": "restated_constitution", "title": "Restated memorandum and articles with the new name", "source": "generated", "required": false }, { "key": "certificate_of_change_of_name", "title": "Certificate of change of name", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "translator", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution_change_name", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_change_name", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_change_name", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Application to change name", "channel": "online", "government_fee": { "amount": 150, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI company." }, { "code": "name_ending_invalid", "type": null, "when": "The name lacks the ending s.17 requires for this entity type." }, { "code": "name_too_long", "type": null, "when": "The name has more than 100 permitted characters, or uses non-permitted characters." }, { "code": "name_unavailable", "type": null, "when": "The name is identical or confusingly similar to a registered, former or reserved name (s.18-)." }, { "code": "restricted_word_requires_fsc_consent", "type": null, "when": "The name contains a restricted word and no FSC consent is attached (s.18; reg 5)." }, { "code": "name_contrary_to_public_interest", "type": null, "when": "The Registrar considers the name offensive, objectionable or contrary to public policy (s.18)." }, { "code": "translation_required", "type": null, "when": "The name has a non-English meaning and no certified translation is attached." }, { "code": "ptc_designation_not_allowed", "type": null, "when": "add_ptc_designation is set but the company is not a private trust company." }, { "code": "s17b_not_eligible", "type": null, "when": "omit_corporate_ending is set but the memorandum does not meet s.17B." }, { "code": "outstanding_registry_fees", "type": null, "when": "Unpaid fees." }, { "code": "entity_struck_off", "type": null, "when": "The company is struck off and dissolved (s.215)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses the name." } ] } }, "Params_vg_npo_change": { "type": "object", "properties": { "npo_registration_number": { "type": "string", "description": "NPO registration number." }, "change_types": { "type": "array", "items": {}, "description": "One or more of: name, address, contact, purpose_or_objectives, activities, executive_body, other.", "examples": [ "[\"executive_body\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; the notice is due 14 days later." }, "former_name": { "type": "string", "description": "Where the name changed." }, "details": { "type": "object", "description": "Full description of each change; executive body changes as [{person, position, date_elected}]." }, "related_action": { "type": "string", "description": "act_ id of the entity change that triggered this." } }, "required": [ "npo_registration_number", "change_types", "effective_date", "details" ], "description": "Gives the NPO Registration Board written notice, on its Notification of Change form, of any change to the information provided at registration, within 14 days (NPO Act s.22). This includes changes to the principal place of business." }, "Create_vg_npo_change": { "type": "object", "properties": { "type": { "const": "vg.npo.change" }, "params": { "$ref": "#/components/schemas/Params_vg_npo_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the NPO Registration Board of a change", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_form", "title": "Notification of Change form", "source": "generated", "required": true }, { "key": "amended_constitution", "title": "Amended constitution, if purposes or objectives changed", "source": "generated", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "change_form", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Non-Profit Organisation Registration Board", "form": "Notification of Change form", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_a_registered_npo", "type": null, "when": "No NPO registration is recorded for the entity." }, { "code": "notice_overdue", "type": null, "when": "More than 14 days since the change; not blocking, flags penalty exposure." } ] } }, "Params_vg_partnership_agreement_amend": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "LP type." }, "amendment_method": { "type": "string", "enum": [ "signed_by_all_partners", "lpa_procedure" ], "description": "s.7 or s.7." }, "lpa_procedure_description": { "type": "string", "description": "For lpa_procedure: the clause and threshold, for example 'cl.18.2: GP plus limited partners holding a majority of commitments'." }, "amendments": { "type": "array", "items": {}, "description": "A list of {clause, new_text, summary}." }, "output_format": { "type": "string", "enum": [ "amendment_agreement", "amended_and_restated_lpa" ], "description": "What is lodged under s.7." }, "amendment": { "type": "string", "pattern": "^doc_", "description": "A customer-prepared amendment." }, "effective_date": { "type": "string", "format": "date", "description": "The date the amendment is made." }, "executed_as_deed": { "type": "boolean", "description": "True if the amendment is executed as a deed." }, "creates_or_amends_power_of_attorney": { "type": "boolean", "description": "True if the amendment creates or changes a power of attorney, such as an LP-to-GP attorney clause." }, "changes_registered_particulars": { "type": "boolean", "description": "True if a s.8 particular changes, such as the term." } }, "required": [ "entity_type", "amendment_method", "amendments", "output_format", "effective_date" ], "description": "A limited partnership agreement is amended either by a written agreement signed by or on behalf of each partner, or by the procedure the agreement itself specifies (LPA s.7). The LP lodges a copy of the amendment, or the revised agreement." }, "Create_vg_partnership_agreement_amend": { "type": "object", "properties": { "type": { "const": "vg.partnership_agreement.amend" }, "params": { "$ref": "#/components/schemas/Params_vg_partnership_agreement_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amendment of a BVI limited partnership agreement", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "lpa_amendment", "title": "Amendment agreement or amended and restated LPA", "source": "generated", "required": true }, { "key": "partner_consents", "title": "Partners' signatures or consents under the LPA procedure", "source": "generated", "required": true }, { "key": "gp_resolution", "title": "General partner resolution approving the amendment", "source": "generated", "required": false }, { "key": "lodgement_record", "title": "Registered agent's record of lodgement under s.7", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "lpa_amendment", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "lpa_amendment", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "lpa_amendment", "signer_role": "general_partner", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "lpa_amendment", "signer_role": "limited_partner", "method": "wet_ink_witnessed", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Not filed with the Registrar. Lodged with the LP's registered agent, Entiva", "form": "Copy of the amendment to the limited partnership agreement, or the revised agreement", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "partner_signatures_incomplete", "type": null, "when": "Under s.7, not every partner has signed." }, { "code": "lpa_procedure_not_satisfied", "type": null, "when": "The consents fall short of the LPA amendment clause (s.7)." }, { "code": "wet_ink_original_required", "type": null, "when": "A deed or power-of-attorney amendment was signed electronically." }, { "code": "inconsistent_with_act", "type": null, "when": "The amendment conflicts with the LPA 2017, so it has no effect to that extent (s.7)." }, { "code": "lodgement_overdue", "type": null, "when": "More than 15 days have passed since the amendment (s.7)." } ] } }, "Params_vg_private_document_legalise": { "type": "object", "properties": { "document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the document to notarise." }, "document_class": { "type": "string", "enum": [ "resolution", "certificate_of_incumbency", "certified_register_extract", "certified_copy_of_constitution", "power_of_attorney", "other" ], "description": "What is being notarised." }, "notarial_act": { "type": "string", "enum": [ "signature_witnessing", "certified_true_copy" ], "description": "signature_witnessing: the signer signs before the notary and proves identity. certified_true_copy: the notary compares the copy with the original." }, "signer": { "type": "string", "pattern": "^per_", "description": "Required for signature_witnessing of customer documents: per_ id of the person who will attend the notary." }, "appointment_window": { "type": "object", "description": "{earliest, latest} dates the signer can attend a notary in Road Town, Tortola." }, "destination_country": { "type": "string", "description": "ISO 3166 code of the country of use." }, "copies": { "type": "integer", "description": "Number of notarised and apostilled originals." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Where the originals are couriered." } }, "required": [ "document_class", "notarial_act", "destination_country", "delivery_address" ], "description": "Gets a private document ready for use abroad. A BVI notary public notarises it: either the signer signs before the notary, or the notary certifies a true copy after seeing the original." }, "Create_vg_private_document_legalise": { "type": "object", "properties": { "type": { "const": "vg.private_document.legalise" }, "params": { "$ref": "#/components/schemas/Params_vg_private_document_legalise" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notarise and apostille a private document in the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "document_to_notarise", "title": "Document to notarise", "source": "uploaded", "required": false }, { "key": "certificate_of_incumbency", "title": "Registered agent's certificate of incumbency", "source": "generated", "required": false }, { "key": "notarial_certificate", "title": "Notarial certificate", "source": "generated", "required": true }, { "key": "apostille_certificate", "title": "Apostille", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "notary", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "document_to_notarise", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "certificate_of_incumbency", "signer_role": "registered_agent", "method": "wet_ink_notarised_apostilled", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "apostille_certificate", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI notary public, then the Deputy Governor's Office, Government House, Road Town, Tortola", "form": "Notarial act under the Commissioners for Oaths and Notaries Public Act 2007, then a reques", "channel": "paper", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "remote_notarisation_unavailable", "type": null, "when": "The signer cannot attend in the BVI." }, { "code": "destination_not_apostille_party", "type": null, "when": "The country of use needs consular legalisation, which this action does not cover." }, { "code": "use_public_document_apostille", "type": null, "when": "The document is Registrar-issued; use vg.public_document.apostille, which needs no notarisation." }, { "code": "signer_required", "type": null, "when": "notarial_act is signature_witnessing for a customer document and no signer is given." } ] } }, "Params_vg_public_document_legalise": { "type": "object", "properties": { "documents": { "type": "array", "items": {}, "description": "Each item is {document or certificate_request, copies}." }, "destination_country": { "type": "string", "description": "ISO 3166 code of the country where the document will be used." }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Where the apostilled originals are couriered." }, "recipient_name": { "type": "string", "description": "Recipient for the courier." } }, "required": [ "documents", "destination_country", "delivery_address", "recipient_name" ], "description": "Obtains an apostille from the Deputy Governor's Office in Road Town, Tortola, the BVI competent authority under the Hague Apostille Convention as extended by the UK. It covers BVI public documents such as Registrar certificates of." }, "Create_vg_public_document_legalise": { "type": "object", "properties": { "type": { "const": "vg.public_document.legalise" }, "params": { "$ref": "#/components/schemas/Params_vg_public_document_legalise" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apostille a BVI Registry document", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "lp", "lp_without_legal_personality", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registrar_document", "title": "Registrar-issued certificate or certified copy", "source": "registry_issued", "required": true }, { "key": "apostille_certificate", "title": "Apostille", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [], "signatures": [ { "document_key": "registrar_document", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "apostille_certificate", "signer_role": "other", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Deputy Governor's Office, Government House, Road Town, Tortola", "form": "Request for apostille, lodged in person with the original document", "channel": "paper", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "destination_not_apostille_party", "type": null, "when": "destination_country is not a party to the Apostille Convention, so consular legalisation is needed; this action does not cover it." }, { "code": "document_not_public", "type": null, "when": "The document is not Registrar-issued, for example a resolution or an incumbency certificate." }, { "code": "certificate_stale", "type": null, "when": "A good standing certificate is more than 3 months old." }, { "code": "entity_not_in_good_standing", "type": null, "when": "A certificate_request for good standing cannot be issued because fees, penalties or required filings are outstanding (BCA s.235)." } ] } }, "Params_vg_registered_agent_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The company's entity type." }, "company_number": { "type": "string", "description": "BVI company number shown on the certificate of incorporation.", "examples": [ "2109876" ] }, "current_registered_agent": { "type": "object", "description": "The outgoing agent: {name, fsc_licence_number, contact_name, contact_email}." }, "move_registered_office": { "type": "boolean", "description": "Also move the registered office to the partner's principal office." }, "approval_body": { "type": "string", "enum": [ "members", "directors" ], "description": "The members may always resolve, notwithstanding the memorandum or articles (s.92)." }, "filing_route": { "type": "string", "enum": [ "outgoing_registered_agent", "bvi_legal_practitioner" ], "description": "Who files the notice (s.92-)." }, "cdd_reliance": { "type": "string", "enum": [ "full_cdd_by_partner", "reliance_on_outgoing_agent" ], "description": "Default full_cdd_by_partner." }, "resolution": { "type": "string", "pattern": "^doc_", "description": "An already-signed resolution." } }, "required": [ "entity_type", "company_number", "current_registered_agent", "move_registered_office", "approval_body", "filing_route" ], "description": "Moves an existing BVI company to Entiva by appointing Entiva's Entiva as registered agent, and usually moves the registered office to the partner's office. The members resolve to make the change." }, "Create_vg_registered_agent_change": { "type": "object", "properties": { "type": { "const": "vg.registered_agent.change" }, "params": { "$ref": "#/components/schemas/Params_vg_registered_agent_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a BVI company's registered agent to Entiva's Entiva", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_incorporation", "title": "Certificate of incorporation", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Current memorandum and articles with every registered amendment", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Register of members, with nominee and nominator details", "source": "uploaded", "required": true }, { "key": "register_of_directors", "title": "Register of directors", "source": "uploaded", "required": true }, { "key": "beneficial_ownership_information", "title": "Beneficial ownership information held by the company", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart down to natural persons", "source": "uploaded", "required": true }, { "key": "register_of_charges", "title": "Register of charges", "source": "uploaded", "required": false }, { "key": "compliance_evidence", "title": "Evidence of the last annual financial return lodged and the last economic substance filing", "source": "uploaded", "required": false }, { "key": "kyb_pack", "title": "KYB pack for each corporate member, director or intermediate holder", "source": "uploaded", "required": false }, { "key": "resolution_change_registered_agent", "title": "Resolution appointing the partner as registered agent", "source": "generated", "required": true }, { "key": "notice_change_registered_agent", "title": "Notice of change of registered agent endorsed by the incoming agent", "source": "generated", "required": true }, { "key": "notice_change_registered_office", "title": "Notice of change of registered office", "source": "generated", "required": false }, { "key": "practitioner_notice_to_outgoing_agent", "title": "Practitioner's written notice of intention to file, with a copy of the resolution", "source": "generated", "required": false }, { "key": "cdd_confirmation", "title": "CDD confirmation for the practitioner filing", "source": "generated", "required": false }, { "key": "registered_notice", "title": "Notice endorsed by the Registrar with the time and date of registration", "source": "registry_issued", "required": true }, { "key": "records_handover", "title": "Records received from the outgoing agent", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "written_threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "resolution_change_registered_agent", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_change_registered_agent", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "lawyer", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change of registered agent", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI company." }, { "code": "already_registered_agent", "type": null, "when": "Entiva is already the company's registered agent." }, { "code": "partner_licence_insufficient", "type": null, "when": "The company is a private trust company and the partner lacks the Class I trust licence a PTC's agent needs." }, { "code": "client_not_accepted", "type": null, "when": "The Entiva compliance function declines the client after CDD." }, { "code": "verification_incomplete", "type": null, "when": "A required person or corporate party has not passed verification." }, { "code": "outgoing_agent_confirmation_pending", "type": null, "when": "On the practitioner route, reg 30 is not yet satisfied." }, { "code": "directors_not_authorised", "type": null, "when": "Directors resolved, but the memorandum and articles do not authorise them to (s.92)." }, { "code": "outstanding_registry_fees", "type": null, "when": "Unpaid annual fees or penalties block Registry action." }, { "code": "entity_struck_off", "type": null, "when": "The company is struck off and dissolved (s.215)." }, { "code": "no_registered_agent", "type": null, "when": "The previous agent has already resigned." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_registered_agent_resign": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company" ] }, "reason": { "type": "string", "enum": [ "customer_requested", "unpaid_fees", "cdd_not_provided", "aml_relationship_terminated", "partner_ceasing_service", "other" ], "description": "Why the agent is resigning. aml_relationship_terminated makes resignation mandatory (s.93, s.189A)." }, "effective_date": { "type": "string", "format": "date", "description": "The date in the notice on which the resignation takes effect." }, "notice_recipient": { "type": "string", "pattern": "^per_", "description": "per_ id of the director to receive the notice, or the person who last gave instructions if no director is known (s.93, s.189A)." }, "recipient_address": { "$ref": "#/components/schemas/Address", "description": "The recipient's last known address." }, "principal_place_of_business_bvi": { "$ref": "#/components/schemas/Address", "description": "Foreign companies only: the BVI principal place of business, which also receives the notice (s.189A)." }, "delivery_method": { "type": "string", "enum": [ "courier", "registered_post", "hand", "email_with_acknowledgement" ], "description": "Defaults to courier with an email copy." }, "acknowledge_strike_off_risk": { "type": "boolean", "description": "Required as true when reason is customer_requested: confirms the customer understands the strike-off or removal risk if no new agent is appointed." } }, "required": [ "reason", "effective_date", "notice_recipient", "recipient_address" ], "description": "Entiva's Entiva resigns as registered agent of a BVI company or a registered foreign company. The partner gives at least 60 days' written notice of the resignation date, and the notice must say that the list of approved registered." }, "Create_vg_registered_agent_resign": { "type": "object", "properties": { "type": { "const": "vg.registered_agent.resign" }, "params": { "$ref": "#/components/schemas/Params_vg_registered_agent_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Resign as registered agent of a company or foreign company", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Notice of intention to resign as registered agent", "source": "generated", "required": true }, { "key": "proof_of_delivery", "title": "Proof of delivery of the notice", "source": "generated", "required": true }, { "key": "filed_resignation_notice", "title": "Filed copy of the resignation notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "recipient", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "resignation_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "filed_resignation_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Copy of the written notice of intention to resign as registered agent", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_period_too_short", "type": null, "when": "resignation_date is less than 60 days after the planned delivery date." }, { "code": "use_change_of_registered_agent", "type": null, "when": "The customer already has a new agent lined up." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity is a limited partnership; use vg.lp_registered_agent.resign." }, { "code": "strike_off_risk_not_acknowledged", "type": null, "when": "reason is customer_requested and acknowledge_strike_off_risk is not true." }, { "code": "permission_denied_reason", "type": null, "when": "A customer key sends a reason other than customer_requested." } ] } }, "Params_vg_registered_agent_transfer_out": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The company's entity type." }, "registered_agent": { "type": "object", "description": "{name, fsc_licence_number, principal_office_address, contact_name, contact_email}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "The new registered office, a physical BVI address (s.90)." }, "office_at_registered_agent": { "type": "boolean", "description": "True if the new office is at the new agent's office (s.90)." }, "approval_body": { "type": "string", "enum": [ "members", "directors" ], "description": "As in s.92." }, "filing_route": { "type": "string", "enum": [ "existing_registered_agent", "bvi_legal_practitioner" ], "description": "Default existing_registered_agent." }, "records_delivery": { "type": "object", "description": "{format: electronic|paper, recipient_email}." } }, "required": [ "entity_type", "registered_agent", "registered_office", "office_at_registered_agent", "approval_body" ], "description": "The company appoints another FSC-licensed registered agent. The members resolve to make the change." }, "Create_vg_registered_agent_transfer_out": { "type": "object", "properties": { "type": { "const": "vg.registered_agent.transfer_out" }, "params": { "$ref": "#/components/schemas/Params_vg_registered_agent_transfer_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a BVI company from Entiva to another registered agent", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_change_registered_agent", "title": "Resolution appointing the new registered agent and registered office", "source": "generated", "required": true }, { "key": "notice_change_registered_agent", "title": "Notice of change of registered agent endorsed by the new agent", "source": "generated", "required": true }, { "key": "notice_change_registered_office", "title": "Notice of change of registered office", "source": "generated", "required": true }, { "key": "cdd_confirmation", "title": "Partner's written CDD confirmation", "source": "generated", "required": false }, { "key": "records_handover_package", "title": "Records handover package", "source": "generated", "required": true }, { "key": "registered_notice", "title": "Notice endorsed by the Registrar with time and date of registration", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "resolution_change_registered_agent", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_change_registered_agent", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_agent", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change of registered agent", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI company." }, { "code": "new_agent_not_licensed", "type": null, "when": "The proposed agent is not on the FSC list of approved agents (s.91; Regulations reg 23)." }, { "code": "new_agent_endorsement_missing", "type": null, "when": "The new agent has not endorsed its agreement to act (s.92)." }, { "code": "directors_not_authorised", "type": null, "when": "The directors resolved without authority under the memorandum and articles (s.92)." }, { "code": "compliance_hold", "type": null, "when": "The relationship is frozen under sanctions law, so the partner must report before acting." }, { "code": "outstanding_registry_fees", "type": null, "when": "Unpaid Registry fees." }, { "code": "entity_struck_off", "type": null, "when": "The company is struck off and dissolved (s.215)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_registered_agent_resignation_revoke": { "type": "object", "properties": { "resignation_action": { "type": "string", "description": "act_ id of the vg.registered_agent.resign action being rescinded." }, "rescission_date": { "type": "string", "format": "date", "description": "Date the rescission takes effect." }, "reason": { "type": "string", "enum": [ "fees_paid", "cdd_provided", "customer_request", "other" ], "description": "Why the resignation is withdrawn." }, "delivery_method": { "type": "string", "enum": [ "courier", "registered_post", "hand", "email_with_acknowledgement" ], "description": "How the rescission notice reaches the original recipient." } }, "required": [ "resignation_action", "rescission_date" ], "description": "Withdraws a notice of intention to resign as registered agent of a BVI company (BCA s.93-) or foreign company (s.189A-). The partner gives at least 14 days' written notice of the rescission, stating the date it takes effect, to the person." }, "Create_vg_registered_agent_resignation_revoke": { "type": "object", "properties": { "type": { "const": "vg.registered_agent_resignation.revoke" }, "params": { "$ref": "#/components/schemas/Params_vg_registered_agent_resignation_revoke" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rescind a registered agent resignation notice", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "rescission_notice", "title": "Notice of intention to rescind the resignation notice", "source": "generated", "required": true }, { "key": "filed_rescission_notice", "title": "Filed rescission notice", "source": "registry_issued", "required": true } ], "people": [ { "role": "recipient", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "rescission_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "filed_rescission_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs, BVI Financial Services Commission", "form": "Rescission notice", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "rescission_window_closed", "type": null, "when": "The resignation date is 14 days or less away (s.93, s.189A)." }, { "code": "agent_already_changed", "type": null, "when": "The entity has already changed its registered agent (s.93, s.189A)." }, { "code": "rescission_notice_period_too_short", "type": null, "when": "rescission_date is less than 14 days after the rescission notice is given." }, { "code": "resignation_not_found", "type": null, "when": "resignation_action is not a filed resignation for this entity." } ] } }, "Params_vg_registered_office_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "description": "The company's entity type." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "The new registered office.", "examples": [ "Unit 4, Seabreeze Plaza, Wickhams Cay I, Road Town, Tortola VG1110, VG" ] }, "office_at_registered_agent": { "type": "boolean", "description": "True if the new office is at the registered agent's office." }, "approval_body": { "type": "string", "enum": [ "members", "directors" ], "description": "Who passes the resolution." }, "resolution": { "type": "string", "pattern": "^doc_", "description": "An already-signed resolution." }, "filing_route": { "type": "string", "enum": [ "registered_agent", "bvi_legal_practitioner" ], "description": "Default registered_agent, which is Entiva. bvi_legal_practitioner files under s.92 after giving the registered agent written notice and a copy of the." } }, "required": [ "entity_type", "registered_office", "office_at_registered_agent", "approval_body" ], "description": "Moves a BVI company's registered office to another physical address in the Virgin Islands and keeps the same registered agent. The members resolve to change it." }, "Create_vg_registered_office_change": { "type": "object", "properties": { "type": { "const": "vg.registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_vg_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of registered office of a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resolution_change_registered_office", "title": "Members' or directors' written resolution changing the registered office", "source": "generated", "required": true }, { "key": "notice_change_registered_office", "title": "Notice of change of registered office", "source": "generated", "required": true }, { "key": "practitioner_notice_to_registered_agent", "title": "Legal practitioner's prior written notice to the registered agent", "source": "generated", "required": false }, { "key": "registered_notice", "title": "Notice of change of registered office as registered by the Registrar", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" } ], "signatures": [ { "document_key": "resolution_change_registered_office", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "resolution_change_registered_office", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_change_registered_office", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs, BVI Financial Services Commission", "form": "Notice of change of registered office", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a BVI company." }, { "code": "registered_office_not_in_bvi", "type": null, "when": "The address is not a physical address in the Virgin Islands (s.90)." }, { "code": "registered_office_unchanged", "type": null, "when": "The new address matches the current registered office." }, { "code": "directors_not_authorised", "type": null, "when": "approval_body is directors, but the memorandum and articles do not authorise directors to change the office (s.92)." }, { "code": "resolution_threshold_not_met", "type": null, "when": "The signed consents do not reach the majority in s.81, s.129 or the constitution." }, { "code": "legal_practitioner_filing_blocked", "type": null, "when": "On the practitioner route, the reg 30 notice or CDD confirmation conditions are not met." }, { "code": "outstanding_registry_fees", "type": null, "when": "The Registrar may refuse to act until all fees are paid." }, { "code": "entity_struck_off", "type": null, "when": "The company is struck off and dissolved, so it cannot act (s.215)." }, { "code": "registry_rejected", "type": null, "when": "The Registrar rejects the notice." } ] } }, "Params_vg_segregated_portfolio_remove": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "description": "It selects the regulations: SPC, SPC or SPC Regulations." }, "segregated_portfolio": { "type": "string", "description": "Name, identification or designation of the portfolio, as notified to the FSC." }, "termination_effective_date": { "type": "string", "format": "date", "description": "When termination took or takes effect." }, "termination_basis": { "type": "string", "enum": [ "standard", "end_of_reinstatement_purpose" ], "description": "end_of_reinstatement_purpose covers a portfolio reinstated for proceedings or claims whose purpose has ended (BC SPC reg 9-; MF and insurer reg 10-)." }, "has_assets": { "type": "boolean", "description": "Must be false: no segregated portfolio assets attributable to the portfolio on termination (reg 8 or 9)." }, "outstanding_liabilities": { "type": "string", "enum": [ "none", "paid_from_general_assets" ], "description": "Whether the portfolio has no outstanding liability, or its liabilities are paid from the company's general assets (reg 8- or 9-)." }, "never_commenced_business": { "type": "boolean", "description": "True if the portfolio never traded." }, "reasons_never_commenced": { "type": "string", "description": "Required when never_commenced_business is true." }, "creation_required_fsc_approval": { "type": "boolean", "description": "True if the FSC approved the portfolio's creation under BCA s.138; written notice is then due within 7 days of termination (s.138A)." }, "request_shorter_period": { "type": "boolean", "description": "Mutual fund and insurer SPCs only: ask the FSC to allow termination sooner than 7 days after receipt (reg 9)." } }, "required": [ "segregated_portfolio", "termination_effective_date", "has_assets", "outstanding_liabilities" ], "description": "Terminates a segregated portfolio of a BVI segregated portfolio company that has no portfolio assets or liabilities attributable to it (BCA s.138A). The company notifies the FSC in writing." }, "Create_vg_segregated_portfolio_remove": { "type": "object", "properties": { "type": { "const": "vg.segregated_portfolio.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_segregated_portfolio_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Terminate a segregated portfolio", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution terminating the portfolio", "source": "generated", "required": true }, { "key": "portfolio_statement", "title": "Statement of the portfolio's assets and liabilities", "source": "uploaded", "required": true }, { "key": "liability_payment_evidence", "title": "Evidence of liabilities paid from general assets", "source": "uploaded", "required": false }, { "key": "termination_notification", "title": "Notification of termination of a segregated portfolio", "source": "generated", "required": true }, { "key": "fsc_acknowledgement", "title": "FSC acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "termination_notification", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Written notification of termination of a segregated portfolio: SPC", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "portfolio_has_assets", "type": null, "when": "has_assets is true; a portfolio with assets cannot be terminated under s.138A." }, { "code": "portfolio_has_unpaid_liabilities", "type": null, "when": "Liabilities remain and are not paid from general assets." }, { "code": "notice_period_too_short", "type": null, "when": "Mutual fund or insurer SPC: the effective date is less than 7 days after submission and no shorter period was requested (reg 9,)." }, { "code": "portfolio_not_found", "type": null, "when": "No active portfolio with that designation is on record." }, { "code": "reasons_required", "type": null, "when": "never_commenced_business is true but no reasons are given." }, { "code": "human_signature_required", "type": null, "when": "An agent key tries to sign the directors' resolution." } ] } }, "Params_vg_segregated_portfolio_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ] }, "segregated_portfolio": { "type": "string", "description": "Designation of the terminated portfolio." }, "reinstatement_date": { "type": "string", "format": "date", "description": "Date of reinstatement; the notice period runs from it." }, "basis": { "type": "string", "enum": [ "company_resolution", "court_order" ], "description": "company_resolution: the company reinstates under s.138A. court_order: the Court reinstated on a creditor's or other person's application; Entiva files a." }, "purpose": { "type": "string", "enum": [ "proceedings_or_claims", "reuse" ], "description": "proceedings_or_claims ends automatically when the purpose ends, and the termination is then notified. reuse brings the creation rules back into play." }, "purpose_details": { "type": "string", "description": "The proceedings or claim, or the planned new use." }, "court_order": { "type": "string", "pattern": "^doc_", "description": "Required when basis is court_order: sealed copy of the order." }, "offering_document": { "type": "string", "pattern": "^doc_", "description": "Mutual fund SPC reuse: the offering document or investment warning for the portfolio (MF reg 8, applied by reg 11)." } }, "required": [ "segregated_portfolio", "reinstatement_date", "basis", "purpose" ], "description": "Reinstates a segregated portfolio that the company terminated, and notifies the FSC in writing with the prescribed fee (BCA s.138A-; BC SPC reg 11; Mutual Funds and Insurance reg 12). There are two purposes." }, "Create_vg_segregated_portfolio_restore": { "type": "object", "properties": { "type": { "const": "vg.segregated_portfolio.restore" }, "params": { "$ref": "#/components/schemas/Params_vg_segregated_portfolio_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reinstate a terminated segregated portfolio", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution reinstating the portfolio", "source": "generated", "required": true }, { "key": "reinstatement_notification", "title": "Notification of reinstatement of a segregated portfolio", "source": "generated", "required": true }, { "key": "court_order", "title": "Court order reinstating the portfolio", "source": "uploaded", "required": false }, { "key": "creation_notification", "title": "Notification of creation, on reuse", "source": "generated", "required": false }, { "key": "fsc_acknowledgement", "title": "FSC acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "reinstatement_notification", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Written notification of reinstatement: SPC", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "portfolio_not_terminated", "type": null, "when": "The portfolio is not recorded as terminated." }, { "code": "notification_overdue", "type": null, "when": "The reinstatement date is outside the 7- or 14-day window." }, { "code": "court_order_required", "type": null, "when": "basis is court_order and no order is attached." }, { "code": "offering_document_required", "type": null, "when": "A mutual fund SPC portfolio is reinstated for reuse without an offering document or investment warning." } ] } }, "Params_vg_spc_information_change": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "description": "Entity type key." }, "effective_date": { "type": "string", "format": "date", "description": "Date the information changed; the 14-day clock runs from it." }, "changes": { "type": "array", "items": {}, "description": "List of {item, previous, new} describing each changed item." }, "description": { "type": "string", "description": "Free-text explanation." }, "director": { "type": "string", "pattern": "^per_", "description": "Director confirming the information." } }, "required": [ "entity_type", "effective_date", "changes", "director" ], "description": "Notifies the FSC of a change in information previously given about an SPC or its portfolios, in the approved form, within 14 days." }, "Create_vg_spc_information_change": { "type": "object", "properties": { "type": { "const": "vg.spc_information.change" }, "params": { "$ref": "#/components/schemas/Params_vg_spc_information_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the FSC of changed SPC information", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "supporting_evidence", "title": "Evidence of the change", "source": "uploaded", "required": false }, { "key": "change_notice", "title": "Notice of change in information", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "FSC acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "change_notice", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "change_notice", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Financial Services Commission via VIRRGIN", "form": "Notice of change in information in the approved form", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "change_outside_deadline", "type": null, "when": "More than 14 days since the change; FSC penalty risk (reg 13)." }, { "code": "government_fee_unconfirmed", "type": null, "when": "The partner has not confirmed whether the US$250 fee applies." } ] } }, "Params_vg_spc_information_change_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ] }, "changes": { "type": "array", "items": {}, "description": "Each change is {kind, segregated_portfolio, effective_date, previous_value, new_value}. kind is company_name, director, portfolio_name, portfolio_director." }, "fsc_direction": { "type": "string", "pattern": "^doc_", "description": "The FSC's notice directing a portfolio name change, if any." }, "appointees": { "type": "array", "items": {}, "description": "per_ ids of new directors, or entity details of new functionaries, so they can be verified or licence-checked." } }, "required": [ "changes" ], "description": "Notifies the FSC, in the approved form, of any change in information a segregated portfolio company had to give it under the SPC regulations. This includes its name, directors, segregated portfolios and their names, and the director or." }, "Create_vg_spc_information_change_notify": { "type": "object", "properties": { "type": { "const": "vg.spc_information_change.notify" }, "params": { "$ref": "#/components/schemas/Params_vg_spc_information_change_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the FSC of changes in SPC information", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "segregated_portfolio_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "change_notice", "title": "Notice of change in information", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the change", "source": "generated", "required": false }, { "key": "functionary_appointment", "title": "Functionary appointment instrument", "source": "uploaded", "required": false }, { "key": "fsc_acknowledgement", "title": "FSC acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "change_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "BVI Financial Services Commission", "form": "Notice of change in information submitted to the Commission", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "change_kind_not_notifiable", "type": null, "when": "The change concerns the reg 3- statements, which need no update notice." }, { "code": "notification_overdue", "type": null, "when": "The change is more than 14 days old." }, { "code": "administrator_required", "type": null, "when": "A mutual fund SPC change would leave it or a portfolio without an administrator (MF reg 5)." }, { "code": "use_register_of_directors_filing", "type": null, "when": "A director change also needs the register of directors filing with the Registrar; Entiva creates vg.register_of_directors.file as a child action." } ] } }, "Params_vg_trade_licence_change": { "type": "object", "properties": { "licence_number": { "type": "string", "description": "Existing trade licence number." }, "changes": { "type": "array", "items": {}, "description": "One or more of: business_name, physical_location, activity, ownership, directors, contact_details, other.", "examples": [ "[\"physical_location\"]" ] }, "values": { "type": "object", "description": "New values for each changed field, for example {physical_location: address}." }, "effective_date": { "type": "string", "format": "date", "description": "Date the change took effect." }, "applicant": { "type": "string", "pattern": "^per_", "description": "Owner, manager, director or agent named on the form." }, "applicant_role": { "type": "string", "enum": [ "owner", "manager", "director", "agent" ], "description": "Role on the form." }, "related_action": { "type": "string", "description": "act_ id of the entity change that triggered this." } }, "required": [ "licence_number", "changes", "values", "effective_date", "applicant", "applicant_role" ], "description": "Files a change-of-details application with the Department of Trade, Investment Promotion and Consumer Affairs, using the same Trade Licence Application Form with application type 'Change of details'. Used after a change of business name." }, "Create_vg_trade_licence_change": { "type": "object", "properties": { "type": { "const": "vg.trade_licence.change" }, "params": { "$ref": "#/components/schemas/Params_vg_trade_licence_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the details on a BVI trade licence", "x-entiva": { "jurisdiction": "vg", "stage": "changes", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "foreign_company", "general_partnership", "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_form", "title": "Trade Licence Application Form, type Change of details", "source": "generated", "required": true }, { "key": "cover_letter", "title": "Cover letter explaining the change", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Updated corporate documents", "source": "generated", "required": false }, { "key": "planning_permission", "title": "Planning permission for a new location that changes building use", "source": "registry_issued", "required": false }, { "key": "updated_trade_licence", "title": "Updated trade licence", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "application_form", "signer_role": "shareholder", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "cover_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Department of Trade, Investment Promotion and Consumer Affairs, Government of the Virgin I", "form": "Trade Licence Application Form", "channel": "paper", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "licence_not_found", "type": null, "when": "No trade licence is recorded for the entity." }, { "code": "department_rejected", "type": null, "when": "The Department refuses or queries the change." } ] } }, "Params_vg_asset_dispose": { "type": "object", "properties": { "disposition_type": { "type": "string", "enum": [ "sale", "transfer", "lease", "exchange", "other" ], "description": "Kind of disposition." }, "description": { "type": "string", "description": "Description of the assets or business being disposed of." }, "asset_value_percentage": { "type": "number", "description": "Value of the assets disposed of as a percentage of the company's total assets.", "examples": [ "72.5" ] }, "counterparty": { "type": "string", "pattern": "^ent_", "description": "Buyer, transferee or lessee. person_ref or entity_ref." }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price or value of what the company receives." }, "usual_course_of_business": { "type": "boolean", "description": "Must be false." }, "approval_mode": { "type": "string", "enum": [ "meeting", "written_resolution" ], "description": "How members authorise it." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the members' meeting." }, "members_outline_sent_on": { "type": "string", "format": "date", "description": "Date notice with an outline or the outline itself was given to every member, whether or not they can vote (s.175-)." }, "dissent_exclusion": { "type": "string", "enum": [ "none", "court_order", "proceeds_distributed_within_one_year", "section_28_power" ], "description": "Set if the disposition is excluded from dissenters' rights under s.179: by court order, for money with all or substantially all net proceeds distributed to." }, "effective_date": { "type": "string", "format": "date", "description": "Planned completion date." }, "directors": { "type": "array", "items": {}, "description": "Directors who approve the disposition (s.175).", "examples": [ "[\"per_01JB6D1\"]" ] }, "members_resolution": { "type": "string", "pattern": "^doc_", "description": "Members' resolution once passed." } }, "required": [ "disposition_type", "description", "asset_value_percentage", "counterparty", "usual_course_of_business", "approval_mode", "members_outline_sent_on", "directors" ], "description": "Runs the BCA s.175 process for a sale, transfer, lease, exchange or other disposition of more than 50% in value of the company's assets outside the usual course of business. Directors approve, members authorise by resolution after." }, "Create_vg_asset_dispose": { "type": "object", "properties": { "type": { "const": "vg.asset.dispose" }, "params": { "$ref": "#/components/schemas/Params_vg_asset_dispose" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Approve a sale or disposition of more than 50% of a BVI company's assets", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' approval of the disposition", "source": "generated", "required": true }, { "key": "disposition_outline", "title": "Outline of the disposition for members", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution authorising the disposition", "source": "generated", "required": true }, { "key": "dissent_notice", "title": "Notice of authorisation to members entitled to dissent", "source": "generated", "required": false }, { "key": "disposition_agreement", "title": "Sale, transfer or lease agreement", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "dissent_notice", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "disposition_agreement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. The disposition is not filed with the Registrar", "form": "None", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "below_threshold", "type": null, "when": "asset_value_percentage is 50 or less, so s.175 does not apply." }, { "code": "usual_course_of_business", "type": null, "when": "The disposition is within the company's usual or regular business." }, { "code": "outline_not_sent", "type": null, "when": "Members' resolution is requested before the outline went to every member (s.175-)." }, { "code": "segregated_portfolio_transfer_excluded", "type": null, "when": "The transfer is of segregated portfolio assets made under the SPC transfer provisions, to which s.175 does not apply (BCA SPC provisions, subsection of the transfer section)." }, { "code": "articles_conflict", "type": null, "when": "The memorandum or articles set a different procedure or threshold." } ] } }, "Params_vg_company_consolidate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the new consolidated company." }, "constituents": { "type": "array", "items": {}, "description": "Every constituent company." }, "consolidated_company_name": { "type": "string", "description": "Name of the new company (s.170).", "examples": [ "Meridian Group Holdings Ltd" ] }, "authorised_shares": { "type": "object", "description": "For a company authorised to issue shares: the maximum number, or 'unlimited', and each class with its rights (s.9)." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "For a company limited by guarantee: the amount each guarantee member must contribute on liquidation (s.9)." }, "consolidated_share_band": { "type": "string", "enum": [ "no_shares", "up_to_50000", "over_50000" ], "description": "Sets the Registry fee (BCA Schedule 1, s.171)." }, "conversion_terms": { "type": "string", "description": "The manner and basis of converting shares in each constituent into shares, debt obligations or other securities of the consolidated company, or into money or." }, "proposed_directors": { "type": "array", "items": {}, "description": "person_ref ids of the consolidated company's intended directors." }, "memorandum_template": { "type": "string", "enum": [ "entiva_standard", "entiva_standard_with_preferred", "custom" ], "description": "Template for the memorandum and articles annexed to the plan (ss.170, 171)." }, "member_approval_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "How each constituent's members authorise the plan (s.170)." }, "effective_date": { "type": "string", "format": "date", "description": "Takes effect on registration, or on a stated date up to 30 days later (s.173)." }, "foreign_law_permits": { "type": "boolean", "description": "Required when a constituent is foreign (s.174)." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "constituents", "consolidated_company_name", "consolidated_share_band", "conversion_terms", "proposed_directors", "member_approval_method" ], "description": "A statutory consolidation of two or more constituent companies into a new consolidated BVI company. The plan of consolidation has the new company's memorandum and articles annexed (s.170)." }, "Create_vg_company_consolidate": { "type": "object", "properties": { "type": { "const": "vg.company.consolidate" }, "params": { "$ref": "#/components/schemas/Params_vg_company_consolidate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Consolidate BVI companies into a new BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_consolidation", "title": "Plan of consolidation with the new memorandum and articles annexed", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution of each BVI constituent", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution of each BVI constituent", "source": "generated", "required": true }, { "key": "notice_to_members", "title": "Notice or consent pack with a copy of the plan", "source": "generated", "required": true }, { "key": "articles_of_consolidation", "title": "Articles of consolidation", "source": "generated", "required": true }, { "key": "memorandum_and_articles", "title": "Memorandum and articles of the consolidated company", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act as director", "source": "generated", "required": true }, { "key": "foreign_constituent_evidence", "title": "Evidence for each foreign constituent", "source": "uploaded", "required": false }, { "key": "fair_value_offer", "title": "Fair value offer to each dissenting member", "source": "generated", "required": false }, { "key": "certificate_of_consolidation", "title": "Certificate of consolidation", "source": "registry_issued", "required": false }, { "key": "certificate_of_incorporation", "title": "Certificate of incorporation of the consolidated company", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_members", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_consolidation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "memorandum_and_articles", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Articles of consolidation", "channel": "online", "government_fee": { "amount": 1400, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "A constituent is not a company." }, { "code": "plan_incomplete", "type": null, "when": "The plan lacks an item that s.170 requires, or the memorandum and articles are not annexed (s.170)." }, { "code": "member_approval_insufficient", "type": null, "when": "A constituent's members' resolution did not pass (s.81)." }, { "code": "name_unavailable", "type": null, "when": "The consolidated company's name fails ss.17-20 or s.18." }, { "code": "fsc_approval_missing", "type": null, "when": "entity_type is segregated_portfolio_company and no FSC approval is on file (s.135)." }, { "code": "effective_date_out_of_range", "type": null, "when": "More than 30 days after registration (s.173)." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not register the articles." }, { "code": "partner_compliance_declined", "type": null, "when": "requirement_error: Entiva compliance team does not accept the new company as a client." } ] } }, "Params_vg_company_continue_in": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "private_trust_company" ], "description": "The BVI company type it will continue as (s.9)." }, "foreign_jurisdiction": { "type": "string", "description": "ISO 3166 code of the jurisdiction where the company is incorporated, with a subdivision where relevant (s.181).", "examples": [ "HK" ] }, "current_name": { "type": "string", "description": "Name at the date of the application (s.181)." }, "name": { "type": "string", "description": "Name under which it will continue, with a BVI ending (ss.17, 181)." }, "foreign_registration_number": { "type": "string", "description": "Registration number in the home registry." }, "incorporation_date": { "type": "string", "format": "date", "description": "Date of incorporation, registration or formation (s.181)." }, "authorised_shares": { "type": "object", "description": "For a company with shares: the maximum number, or unlimited, and each class with its rights (s.9)." }, "share_band": { "type": "string", "enum": [ "no_shares", "up_to_50000", "over_50000" ], "description": "Sets the continuation fee (Schedule 1, s.182) and the annual fee." }, "guarantee_amount": { "$ref": "#/components/schemas/Money", "description": "For a company limited by guarantee: each guarantee member's liability on liquidation (s.9)." }, "approval_method": { "type": "string", "enum": [ "majority_of_directors", "other_established_manner" ], "description": "How the application and the proposed memorandum and articles were approved: by a majority of the directors or equivalent persons, or in another manner the." }, "disqualification_confirmations": { "type": "object", "description": "Booleans for each s.180 ground: - not_in_liquidation; - no_receiver_or_manager; - no_unconcluded_creditor_arrangement; - no_pending_winding_up_application." }, "directors": { "type": "array", "items": {}, "description": "person_ref ids of the directors at continuation, for the register of directors due within 15 days (s.118B)." }, "members": { "type": "array", "items": {}, "description": "Members and holdings at continuation: {person_id, class, number, nominee, nominator_person_id}." }, "foreign_deregistration": { "type": "string", "enum": [ "automatic_on_bvi_certificate", "separate_home_filing", "unknown" ], "description": "How the company leaves its home register." }, "purpose_and_activity": { "type": "string", "description": "Purpose, intended business, countries and expected activity, for Entiva CDD (AML/TF Code s.19)." } }, "required": [ "entity_type", "foreign_jurisdiction", "current_name", "name", "foreign_registration_number", "incorporation_date", "share_band", "approval_method", "disqualification_confirmations", "directors", "members", "purpose_and_activity" ], "description": "Redomiciles a foreign company into the BVI as a BVI business company. The company's home law must permit continuation, and the company must not be disqualified." }, "Create_vg_company_continue_in": { "type": "object", "properties": { "type": { "const": "vg.company.continue_in" }, "params": { "$ref": "#/components/schemas/Params_vg_company_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a foreign company into the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_certificate_of_incorporation", "title": "Certified copy of the foreign certificate of incorporation", "source": "uploaded", "required": true }, { "key": "memorandum_and_articles", "title": "BVI memorandum and articles", "source": "generated", "required": true }, { "key": "approval_resolution", "title": "Foreign board resolution approving continuation and the memorandum and articles", "source": "generated", "required": true }, { "key": "director_certificate", "title": "Director's certificate in the approved form", "source": "generated", "required": true }, { "key": "foreign_law_extract", "title": "Extract of the foreign law permitting continuation", "source": "uploaded", "required": true }, { "key": "foreign_good_standing", "title": "Home registry certificate of good standing", "source": "uploaded", "required": false }, { "key": "registered_agent_consent", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart to natural persons", "source": "uploaded", "required": true }, { "key": "kyb_pack", "title": "KYB pack for each corporate member or director", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "certificate_of_continuation", "title": "Certificate of continuation", "source": "registry_issued", "required": false } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "approval_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "director_certificate", "signer_role": "director", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "memorandum_and_articles", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "certificate_of_continuation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Application to continue under the BVI Business Companies Act", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_law_does_not_permit", "type": null, "when": "The home law does not permit continuation to another jurisdiction (s.180)." }, { "code": "disqualified_from_continuing", "type": null, "when": "Any s.180 ground applies: liquidation, a receiver or manager, an unconcluded creditor arrangement, or an undetermined winding-up application." }, { "code": "director_certificate_not_notarised", "type": null, "when": "requirement_error: the director's certificate is not notarised or legalised under the home law, or the law extract is missing (s.180-)." }, { "code": "bearer_shares_outstanding", "type": null, "when": "The company has bearer shares in issue. s.38 bars bearer shares, and Entiva requires them to be converted to registered shares before filing." }, { "code": "name_unavailable", "type": null, "when": "proposed_name fails ss.17-20, or is reserved or in use." }, { "code": "entity_type_not_supported", "type": null, "when": "entity_type is segregated_portfolio_company, or the company is a partnership." }, { "code": "public_interest_refusal", "type": null, "when": "registry_error: the Registrar refuses on public-interest grounds (s.182)." }, { "code": "partner_compliance_declined", "type": null, "when": "requirement_error: Entiva compliance team does not accept the client." } ] } }, "Params_vg_company_continue_out": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the BVI company." }, "target_jurisdiction": { "type": "string", "description": "ISO 3166 code of the jurisdiction it will continue to, with a subdivision where relevant.", "examples": [ "SG" ] }, "target_entity_name": { "type": "string", "description": "Name and legal form the company will have under the foreign law." }, "approval_body": { "type": "string", "enum": [ "directors", "members" ], "description": "Continuation is by resolution of directors or resolution of members, subject to the memorandum and articles (s.184)." }, "gazette_notice_date": { "type": "string", "format": "date", "description": "Date the Gazette notice is published." }, "website_url": { "type": "string", "description": "The company's website, if it has one, where the notice must also appear (s.184)." }, "notice_to_members_and_creditors_date": { "type": "string", "format": "date", "description": "Date written notice went to all members and creditors (s.184)." }, "creditors": { "type": "array", "items": {}, "description": "Known creditors to notify, as {name, address or email}." }, "registered_charges": { "type": "array", "items": {}, "description": "Registered charges not yet released or satisfied." }, "declarations": { "type": "object", "description": "Booleans for the notice of intention (s.184): - notices_given; - no_pending_competent_authority_request; - no_receiver_appointed; - no_known_proceedings." }, "foreign_law_compliance": { "type": "boolean", "description": "Confirms the foreign law permits the continuation and has been complied with (s.184,)." }, "provisional_foreign_certificate": { "type": "boolean", "description": "True if the foreign registry issues a provisional certificate and needs the BVI certificate of discontinuance first." } }, "required": [ "entity_type", "target_jurisdiction", "target_entity_name", "approval_body", "creditors", "declarations" ], "description": "Redomiciles a BVI company to a foreign jurisdiction under BCA s.184. The company must qualify for a certificate of good standing." }, "Create_vg_company_continue_out": { "type": "object", "properties": { "type": { "const": "vg.company.continue_out" }, "params": { "$ref": "#/components/schemas/Params_vg_company_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a BVI company out to a foreign jurisdiction", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "continuation_resolution", "title": "Resolution of directors or members to continue", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette and website notice of intention to continue", "source": "generated", "required": true }, { "key": "notice_to_members_and_creditors", "title": "Written notice to members and creditors", "source": "generated", "required": true }, { "key": "notice_of_intention", "title": "Notice of intention to continue with declarations", "source": "generated", "required": true }, { "key": "charge_declaration", "title": "Declaration to the Registrar on registered charges", "source": "generated", "required": false }, { "key": "chargee_consent", "title": "Chargee notification and consent or non-objection", "source": "uploaded", "required": false }, { "key": "foreign_law_declaration", "title": "Declaration in the approved form on the foreign law", "source": "generated", "required": true }, { "key": "foreign_certificate_of_continuance", "title": "Foreign certificate of continuance or registration", "source": "uploaded", "required": true }, { "key": "notice_of_continuance", "title": "Notice of continuance", "source": "generated", "required": true }, { "key": "certificate_of_good_standing", "title": "BVI certificate of good standing", "source": "registry_issued", "required": false }, { "key": "certificate_of_discontinuance", "title": "Certificate of discontinuance", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "chargee", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "continuation_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_to_members_and_creditors", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_intention", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "chargee_consent", "signer_role": "chargee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "foreign_law_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_continuance", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of intention to continue", "channel": "online", "government_fee": { "amount": 2750, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_in_good_standing", "type": null, "when": "The Registrar would not issue a certificate of good standing, for example because of unpaid fees or penalties, missing register or BO filings, or an annual-return default (s.184)." }, { "code": "notice_period_not_elapsed", "type": null, "when": "Fewer than 14 days have passed since the Gazette or website advertisement or the notices to members and creditors (s.184)." }, { "code": "charge_declaration_missing", "type": null, "when": "A registered charge is outstanding and no s.184 declaration route is supported, or the charge prohibits continuation outside the BVI." }, { "code": "declaration_cannot_be_given", "type": null, "when": "A director cannot truthfully make a s.184 declaration: a pending competent-authority request, a receiver, or known proceedings." }, { "code": "foreign_law_not_confirmed", "type": null, "when": "The s.184 declaration or the foreign certificate is missing." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar is not satisfied and does not issue the certificate of discontinuance (s.184)." } ] } }, "Params_vg_company_convert_to_spc": { "type": "object", "properties": { "portfolios": { "type": "array", "items": {}, "description": "One object per segregated portfolio: {name, assets, director}.", "examples": [ "[{\"name\":\"Portfolio A\",\"assets\":\"Cash and listed equities\",\"director\":\"per_8Qk2Lm\"}]" ] }, "directors": { "type": "array", "items": {}, "description": "All current directors.", "examples": [ "[\"per_8Qk2Lm\",\"per_3Zr9Tn\"]" ] }, "balance_sheet_date": { "type": "string", "format": "date", "description": "Date of the balance sheet uploaded as financial_statements.", "examples": [ "2026-08-31" ] }, "name": { "type": "string", "description": "New company name if the SPC will be renamed.", "examples": [ "Aster Holdings SPC" ] }, "business_purpose": { "type": "string", "description": "Description of the SPC's intended business and portfolios, used for Entiva CDD file and the FSC application.", "examples": [ "Proprietary investment portfolios for two family branches" ] }, "members_notice_date": { "type": "string", "format": "date", "description": "Date the notice of the conversion is given to members.", "examples": [ "2026-10-20" ] }, "solvency_confirmed": { "type": "boolean", "description": "Director confirms the solvency matters in the SPC Director Declaration (Form BC-2) are true.", "examples": [ "true" ] }, "restated_constitution": { "type": "string", "pattern": "^doc_", "description": "Restated memorandum and articles with SPC provisions.", "examples": [ "doc_5TqPz1" ] } }, "required": [ "portfolios", "directors", "balance_sheet_date", "members_notice_date", "solvency_confirmed" ], "description": "Converts an existing BVI company limited by shares into a non-regulated segregated portfolio company (BCA s.135; SPC Regulations reg 3). The FSC approves first, then the Registrar registers the SPC." }, "Create_vg_company_convert_to_spc": { "type": "object", "properties": { "type": { "const": "vg.company.convert_to_spc" }, "params": { "$ref": "#/components/schemas/Params_vg_company_convert_to_spc" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an existing BVI company as a segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Balance sheet dated within 6 months", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Restated memorandum and articles", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving registration as an SPC and the portfolio allocation", "source": "generated", "required": true }, { "key": "members_notice", "title": "Notice to members of the conversion", "source": "generated", "required": true }, { "key": "spc_director_statement", "title": "SPC Director Statement (Form BC-1)", "source": "generated", "required": true }, { "key": "spc_director_declaration", "title": "SPC Director Declaration, solvency (Form BC-2)", "source": "generated", "required": true }, { "key": "portfolio_allocation", "title": "Schedule allocating assets and a director to each portfolio", "source": "generated", "required": true }, { "key": "fsc_approval_letter", "title": "FSC approval to register as an SPC", "source": "registry_issued", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration as a segregated portfolio company", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "spc_director_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "spc_director_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "members_notice", "signer_role": "authorised_signatory", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs and Financial Services Commission", "form": "VIRRGIN transaction 'Application to Register a Non-Regulated SPC' with Forms BC", "channel": "online", "government_fee": { "amount": 3100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a bc_ltd_shares company." }, { "code": "balance_sheet_too_old", "type": null, "when": "balance_sheet_date is more than 6 months before the application date." }, { "code": "portfolio_director_missing", "type": null, "when": "A portfolio has no director assigned." }, { "code": "fsc_approval_pending", "type": null, "when": "Registration cannot be submitted until the FSC approves." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The company has unpaid annual fees or overdue register or BO filings." }, { "code": "person_not_verified", "type": null, "when": "" }, { "code": "sanctions_alert_open", "type": null, "when": "An open screening alert involves a director, BO or signatory." }, { "code": "registry_rejected", "type": null, "when": "The Registry or FSC refuses the application." } ] } }, "Params_vg_company_merge": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the surviving company." }, "this_entity_role": { "type": "string", "enum": [ "surviving_company", "merging_company" ], "description": "Whether the entity in the path survives or merges away." }, "constituents": { "type": "array", "items": {}, "description": "Every constituent company, including the survivor." }, "surviving_company_name": { "type": "string", "description": "Name of the surviving company (s.170).", "examples": [ "Northwind Holdings Limited" ] }, "conversion_terms": { "type": "string", "description": "Terms and conditions of the merger." }, "consideration": { "type": "array", "items": {}, "description": "Structured form of conversion_terms, one item per constituent and class: {constituent, class, consideration_type, ratio_or_amount}." }, "survivor_memorandum_amendments": { "type": "string", "description": "Statement of any amendment to the survivor's memorandum or articles that the merger brings about (s.170)." }, "survivor_share_band": { "type": "string", "enum": [ "no_shares", "up_to_50000", "over_50000" ], "description": "The survivor's authorised shares after the merger." }, "member_approval_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "How each constituent's members authorise the plan (s.170)." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the members' meeting, if member_approval_method is meeting." }, "effective_date": { "type": "string", "format": "date", "description": "Leave empty for the merger to take effect on registration." }, "foreign_law_permits": { "type": "boolean", "description": "Required when any constituent is foreign." }, "board_changes": { "type": "array", "items": {}, "description": "Changes to the survivor's directors that take effect on the merger, as {person_id, change: appoint or remove}." } }, "required": [ "entity_type", "this_entity_role", "constituents", "surviving_company_name", "conversion_terms", "survivor_share_band", "member_approval_method" ], "description": "A statutory merger of two or more constituent companies into one surviving BVI company. The steps are: 1." }, "Create_vg_company_merge": { "type": "object", "properties": { "type": { "const": "vg.company.merge" }, "params": { "$ref": "#/components/schemas/Params_vg_company_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge BVI companies into a surviving BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Plan of merger", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution of each BVI constituent", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution of each BVI constituent", "source": "generated", "required": true }, { "key": "notice_to_members", "title": "Notice of meeting or written-consent pack with a copy of the plan", "source": "generated", "required": true }, { "key": "articles_of_merger", "title": "Articles of merger", "source": "generated", "required": true }, { "key": "survivor_amendment_resolution", "title": "Resolution amending the survivor's memorandum and articles", "source": "generated", "required": false }, { "key": "foreign_constituent_evidence", "title": "Evidence for each foreign constituent", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "dissent_notice", "title": "Notice of authorisation to objecting members", "source": "generated", "required": false }, { "key": "fair_value_offer", "title": "Written fair value offer to each dissenting member", "source": "generated", "required": false }, { "key": "certificate_of_merger", "title": "Certificate of merger", "source": "registry_issued", "required": false }, { "key": "registered_articles_of_merger", "title": "Registered articles of merger and survivor amendments", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_members", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_articles_of_merger", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "fair_value_offer", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Articles of merger", "channel": "online", "government_fee": { "amount": 1400, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "A BVI constituent is not a company, for example a limited partnership." }, { "code": "plan_incomplete", "type": null, "when": "The plan lacks an item that s.170 requires." }, { "code": "member_approval_insufficient", "type": null, "when": "A constituent's members' resolution did not reach the s.81 or articles majority." }, { "code": "class_vote_missing", "type": null, "when": "A class entitled to vote separately under s.170 has not approved." }, { "code": "effective_date_out_of_range", "type": null, "when": "effective_date is more than 30 days after the expected registration date (s.173)." }, { "code": "survivor_name_unavailable", "type": null, "when": "" }, { "code": "foreign_law_not_confirmed", "type": null, "when": "A constituent is foreign and foreign_law_permits or foreign_constituent_evidence is missing (s.174)." }, { "code": "survivor_is_foreign", "type": null, "when": "The survivor is incorporated outside the BVI." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar is not satisfied that the Act has been complied with and does not register the articles." }, { "code": "partner_compliance_hold", "type": null, "when": "requirement_error: CDD on the survivor's incoming members, beneficial owners or signatories has not been cleared." } ] } }, "Params_vg_company_merge_into_foreign": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the BVI constituent in the path." }, "form": { "type": "string", "enum": [ "merger", "consolidation" ], "description": "Merger into an existing foreign company, or consolidation into a new foreign company (s.174)." }, "foreign_survivor_name": { "type": "string", "description": "Name of the foreign surviving or consolidated company." }, "foreign_survivor_jurisdiction": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the foreign company's jurisdiction, with a subdivision where relevant, for example 'US-DE' or 'KY'.", "examples": [ "KY" ] }, "foreign_survivor_registration_number": { "type": "string", "description": "Registration number of the foreign survivor." }, "foreign_law_permits": { "type": "boolean", "description": "Confirms the foreign law permits the merger or consolidation (s.174)." }, "constituents": { "type": "array", "items": {}, "description": "Every constituent, BVI and foreign." }, "conversion_terms": { "type": "string", "description": "How shares of each BVI constituent are cancelled, reclassified or converted into shares, debt or other securities of the foreign survivor, or into money or." }, "member_approval_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "How the BVI constituent's members authorise the plan (s.170)." }, "process_agent": { "type": "string", "description": "The registered agent the foreign survivor irrevocably appoints to accept service of process in the BVI (s.174)." }, "foreign_effective_date": { "type": "string", "format": "date", "description": "Expected effective date under the foreign law (s.174)." } }, "required": [ "entity_type", "form", "foreign_survivor_name", "foreign_survivor_jurisdiction", "foreign_law_permits", "constituents", "conversion_terms", "member_approval_method", "process_agent" ], "description": "Cross-border merger or consolidation under BCA s.174 in which the surviving or consolidated company is incorporated outside the BVI. It is allowed only if the foreign law permits it." }, "Create_vg_company_merge_into_foreign": { "type": "object", "properties": { "type": { "const": "vg.company.merge_into_foreign" }, "params": { "$ref": "#/components/schemas/Params_vg_company_merge_into_foreign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge or consolidate a BVI company into a foreign survivor", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Plan of merger or consolidation", "source": "generated", "required": true }, { "key": "board_resolution", "title": "BVI constituent's directors' resolution", "source": "generated", "required": true }, { "key": "members_resolution", "title": "BVI constituent's members' resolution", "source": "generated", "required": true }, { "key": "notice_to_members", "title": "Notice or consent pack with a copy of the plan", "source": "generated", "required": true }, { "key": "articles_of_merger", "title": "Articles of merger or consolidation", "source": "generated", "required": true }, { "key": "service_of_process_agreement", "title": "Foreign survivor's agreement to accept service in the BVI", "source": "generated", "required": true }, { "key": "process_agent_appointment", "title": "Irrevocable appointment of a registered agent for service of process", "source": "generated", "required": true }, { "key": "dissenter_payment_undertaking", "title": "Undertaking to pay dissenting members promptly", "source": "generated", "required": true }, { "key": "foreign_certificate_of_merger", "title": "Foreign certificate of merger or consolidation", "source": "uploaded", "required": true }, { "key": "foreign_law_evidence", "title": "Evidence that the foreign law permits the merger", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "fair_value_offer", "title": "Fair value offer to dissenting members", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_members", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "service_of_process_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "process_agent_appointment", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "dissenter_payment_undertaking", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "foreign_certificate_of_merger", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Documents under BCA s.174", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_law_not_confirmed", "type": null, "when": "foreign_law_permits is false, or foreign_law_evidence is missing (s.174)." }, { "code": "foreign_certificate_missing", "type": null, "when": "There is no foreign certificate of merger and no other evidence the Registrar accepts (s.174)." }, { "code": "survivor_is_bvi", "type": null, "when": "The survivor is a BVI company." }, { "code": "wet_ink_original_not_received", "type": null, "when": "requirement_error: the partner has not received the original paper process agent appointment." }, { "code": "member_approval_insufficient", "type": null, "when": "The BVI constituent's members' resolution did not pass (s.81)." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not accept the filing." } ] } }, "Params_vg_company_merge_out": { "type": "object", "properties": { "survivor": { "type": "object", "description": "Foreign surviving company: {name, jurisdiction, registration_number, registered_office, legal_form}.", "examples": [ "{\"name\":\"Aster Holdings Pte. Ltd.\",\"jurisdiction\":\"SG\",\"registration_number\":\"202612345K\",\"legal_form\":\"private company limited by shares\"}" ] }, "service_agent": { "type": "object", "description": "The survivor's irrevocably appointed agent for service of process in the BVI: {name, address}.", "examples": [ "{\"name\":\"Partner RA Ltd\",\"address\":{\"line1\":\"Road Town, Tortola\",\"country\":\"VG\"}}" ] }, "share_conversion_terms": { "type": "object", "description": "How members' shares convert or are exchanged into survivor shares or cash.", "examples": [ "{\"basis\":\"1 survivor share for each BVI share\",\"cash\":null}" ] }, "dissenter_payment_undertaking": { "type": "boolean", "description": "The survivor undertakes to pay dissenting members.", "examples": [ "true" ] }, "effective_date": { "type": "string", "format": "date", "description": "Intended effective date, subject to the foreign law and the Registrar's acceptance of the foreign evidence.", "examples": [ "2026-12-15" ] }, "foreign_merger_evidence": { "type": "string", "pattern": "^doc_", "description": "Foreign certificate of merger or other evidence the Registrar accepts.", "examples": [ "doc_9Hd4Rw" ] }, "dissenters_notice_date": { "type": "string", "format": "date", "description": "Date notice of dissent rights is given.", "examples": [ "2026-11-02" ] } }, "required": [ "survivor", "service_agent", "share_conversion_terms", "dissenter_payment_undertaking" ], "description": "Merges a BVI company into a company incorporated outside the BVI that survives. The BVI company ceases." }, "Create_vg_company_merge_out": { "type": "object", "properties": { "type": { "const": "vg.company.merge_out" }, "params": { "$ref": "#/components/schemas/Params_vg_company_merge_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge a BVI company into a foreign survivor", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Plan of merger", "source": "generated", "required": true }, { "key": "articles_of_merger", "title": "Articles of merger", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution of the BVI company", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution of the BVI company", "source": "generated", "required": true }, { "key": "service_agreement", "title": "Survivor's agreement to accept service in the BVI and irrevocable appointment of its registered.", "source": "generated", "required": true }, { "key": "dissenters_undertaking", "title": "Survivor's undertaking to pay dissenting members", "source": "generated", "required": true }, { "key": "foreign_merger_certificate", "title": "Foreign certificate of merger or other evidence acceptable to the Registrar", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified translation of foreign documents", "source": "uploaded", "required": false }, { "key": "certificate_of_merger", "title": "Registry notice or certificate of merger", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "plan_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "service_agreement", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "dissenters_undertaking", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "foreign_merger_certificate", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registry_receipt", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Articles of merger with the foreign survivor's service agreement, appointment of registere", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_evidence_missing", "type": null, "when": "No foreign certificate of merger or equivalent evidence is attached at filing." }, { "code": "service_agent_missing", "type": null, "when": "The survivor has no appointed agent for service in the BVI." }, { "code": "dissenter_undertaking_required", "type": null, "when": "dissenter_payment_undertaking is false." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The BVI company cannot get a certificate of good standing." }, { "code": "person_not_verified", "type": null, "when": "" }, { "code": "sanctions_alert_open", "type": null, "when": "An open alert involves the BVI company, the survivor or their owners." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses the filing." } ] } }, "Params_vg_company_merge_with_subsidiary": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the surviving company. s.172 needs 'outstanding shares of each class', so each subsidiary must have shares in issue." }, "parent_entity_id": { "type": "string", "pattern": "^ent_", "description": "The parent company." }, "subsidiaries": { "type": "array", "items": {}, "description": "One item per BVI subsidiary to be merged." }, "surviving_company": { "type": "string", "enum": [ "parent", "subsidiary" ], "description": "Which constituent survives." }, "surviving_company_name": { "type": "string", "description": "Name of the survivor (s.172)." }, "conversion_terms": { "type": "string", "description": "Terms and conditions, including the manner and basis of converting shares of each company being merged into shares, debt obligations or other securities of the." }, "minority_consideration": { "$ref": "#/components/schemas/Money", "description": "Cash per share for minority members of a subsidiary, if any." }, "survivor_memorandum_amendments": { "type": "string", "description": "Statement of any amendment to the survivor's memorandum or articles brought about by the merger (s.172)." }, "survivor_share_band": { "type": "string", "enum": [ "no_shares", "up_to_50000", "over_50000" ], "description": "Sets the Registry fee (BCA Schedule 1, ss.171 and 172)." }, "plan_delivery_date": { "type": "string", "format": "date", "description": "Date the plan or an outline was given to the subsidiary members." }, "effective_date": { "type": "string", "format": "date", "description": "Takes effect on registration, or on a stated date up to 30 days later (s.173)." } }, "required": [ "entity_type", "parent_entity_id", "subsidiaries", "surviving_company", "surviving_company_name", "conversion_terms", "survivor_share_band" ], "description": "Short-form merger under BCA s.172. A parent company that owns at least 90% of the outstanding shares of each class of a BVI subsidiary merges with one or more such subsidiaries, and no company's members need to authorise it." }, "Create_vg_company_merge_with_subsidiary": { "type": "object", "properties": { "type": { "const": "vg.company.merge_with_subsidiary" }, "params": { "$ref": "#/components/schemas/Params_vg_company_merge_with_subsidiary" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge a parent company with its 90%-owned BVI subsidiaries", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_with_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Plan of merger", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Parent's directors' resolution", "source": "generated", "required": true }, { "key": "plan_to_subsidiary_members", "title": "Copy or outline of the plan to subsidiary members", "source": "generated", "required": true }, { "key": "member_waiver", "title": "Member waiver of the plan copy", "source": "generated", "required": false }, { "key": "articles_of_merger", "title": "Articles of merger executed by the parent", "source": "generated", "required": true }, { "key": "survivor_amendment_resolution", "title": "Resolution amending the survivor's memorandum and articles", "source": "generated", "required": false }, { "key": "fair_value_offer", "title": "Fair value offer to each dissenting minority member", "source": "generated", "required": false }, { "key": "certificate_of_merger", "title": "Certificate of merger", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "plan_to_subsidiary_members", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "member_waiver", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_merger", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Articles of merger", "channel": "online", "government_fee": { "amount": 1400, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "parent_ownership_below_threshold", "type": null, "when": "The parent owns less than 90% of the outstanding shares of some class of a subsidiary." }, { "code": "foreign_constituent_not_supported", "type": null, "when": "A constituent is foreign." }, { "code": "parent_share_conversion_invalid", "type": null, "when": "The parent does not survive, and its shares would convert into something other than similar shares of the survivor (s.172)." }, { "code": "plan_not_delivered", "type": null, "when": "The articles cannot be executed until every member of a subsidiary the parent does not wholly own has been given the plan or outline, or has waived it (s.172,)." }, { "code": "survivor_name_unavailable", "type": null, "when": "The survivor's name fails ss.17-20 (s.172)." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not register the articles." } ] } }, "Params_vg_company_as_spc_register": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares" ], "description": "Type of the company being registered as an SPC." }, "name": { "type": "string", "description": "Name after registration.", "examples": [ "Harbour Assets SPC Ltd" ] }, "portfolios": { "type": "array", "items": {}, "description": "The initial segregated portfolios (reg 3-)." }, "general_assets": { "type": "string", "description": "Assets that will remain general assets of the company and are not attributed to any portfolio (reg 3; s.140)." }, "liabilities_settlement": { "type": "string", "description": "How the company's existing liabilities will be satisfied (reg 3)." }, "balance_sheet_date": { "type": "string", "format": "date", "description": "Date of the balance sheet and the statement of assets and liabilities.", "examples": [ "2026-09-30" ] }, "material_events": { "type": "string", "description": "Transactions, events or other matters that are not reflected in the statement of assets and liabilities but that the directors consider have materially." }, "memorandum_amendment_authority": { "type": "string", "enum": [ "members_resolution", "directors_resolution" ], "description": "Who amends the memorandum and articles to state SPC status (s.9) and adopt the new name." }, "members_notice_date": { "type": "string", "format": "date", "description": "Date the company notified its members that it intends to apply for registration as an SPC." }, "management_expertise": { "type": "string", "description": "How the company has, or has available to it, the knowledge and expertise to manage segregated portfolios." }, "non_regulated_confirmation": { "type": "boolean", "description": "Confirms that the company is not, and will not be, licensed in any of these ways (s.135): - as an investment business under SIBA; - as an insurance manager or." }, "planned_filing_date": { "type": "string", "format": "date", "description": "Date the partner plans to submit on VIRRGIN." } }, "required": [ "entity_type", "name", "portfolios", "general_assets", "liabilities_settlement", "balance_sheet_date", "memorandum_amendment_authority", "members_notice_date", "management_expertise", "non_regulated_confirmation" ], "description": "Converts an existing BVI company limited by shares into a non-regulated BVI business company SPC (BCA s.135). The FSC must give written approval before the Registrar registers it (ss.135, 136-137)." }, "Create_vg_company_as_spc_register": { "type": "object", "properties": { "type": { "const": "vg.company_as_spc.register" }, "params": { "$ref": "#/components/schemas/Params_vg_company_as_spc_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an existing BVI company as a segregated portfolio company", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "balance_sheet", "title": "Balance sheet dated no more than 6 months before filing", "source": "uploaded", "required": true }, { "key": "spc_director_statement", "title": "SPC Director Statement (Form BC-1)", "source": "generated", "required": true }, { "key": "spc_director_declaration", "title": "SPC Director Declaration (Form BC-2)", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving registration as an SPC", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution amending the memorandum and articles", "source": "generated", "required": false }, { "key": "notice_to_members", "title": "Notice to members of the intention to apply", "source": "generated", "required": true }, { "key": "restated_memorandum_and_articles", "title": "Restated memorandum and articles", "source": "generated", "required": true }, { "key": "virrgin_spc_application", "title": "VIRRGIN 'Application to Register a Non-Regulated SPC'", "source": "generated", "required": true }, { "key": "fsc_approval", "title": "FSC written approval", "source": "registry_issued", "required": false }, { "key": "certificate_of_change_of_name", "title": "Certificate of change of name", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_members", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "spc_director_statement", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "spc_director_declaration", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "restated_memorandum_and_articles", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "virrgin_spc_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Financial Services Commission", "form": "VIRRGIN post-incorporation transaction 'Application to Register a Non-Regulated SPC', with", "channel": "online", "government_fee": { "amount": 3100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a company limited by shares (s.135)." }, { "code": "regulated_spc_route_required", "type": null, "when": "The company is or will be a mutual fund or an insurer, or is licensed under an Act listed in s.135." }, { "code": "name_missing_spc_designation", "type": null, "when": "new_name lacks 'Segregated Portfolio Company' or 'SPC' before the ending (s.17), or lacks '' for a restricted purposes company (s.17)." }, { "code": "portfolio_designation_invalid", "type": null, "when": "A portfolio designation lacks the words 'Segregated Portfolio' (s.138)." }, { "code": "balance_sheet_too_old", "type": null, "when": "balance_sheet_date is more than 6 months before planned_filing_date, or before the date the partner submits." }, { "code": "portfolio_director_not_on_register", "type": null, "when": "A portfolio's director is not on the register of directors filed at the Registry." }, { "code": "solvency_declaration_refused", "type": null, "when": "No director will sign Form BC-2 confirming solvency (reg 3)." }, { "code": "fsc_application_refused", "type": null, "when": "registry_error: the FSC refuses approval or asks for information that is not supplied (ss.136, 137)." }, { "code": "partner_compliance_hold", "type": null, "when": "requirement_error: the partner registered agent's compliance team has not cleared CDD on the directors and beneficial owners." } ] } }, "Params_vg_continuance_notice_file": { "type": "object", "properties": { "continuation_intention": { "type": "string", "description": "ID of the completed vg.company.continue_out action that filed the notice of intention.", "examples": [ "act_8Mb2Ho6Vk" ] }, "foreign_registration_number": { "type": "string", "description": "Registration number in the destination registry.", "examples": [ "MC-412345" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the company continued under the foreign law, shown on the foreign certificate.", "examples": [ "2026-11-20" ] }, "foreign_name": { "type": "string", "description": "Name registered in the destination jurisdiction.", "examples": [ "Aster Holdings Ltd" ] }, "declarations_unchanged": { "type": "boolean", "description": "A director confirms the declarations in the notice of intention remain true at filing.", "examples": [ "true" ] }, "directors": { "type": "array", "items": {}, "description": "Directors confirming the declarations.", "examples": [ "[\"per_8Qk2Lm\"]" ] } }, "required": [ "continuation_intention", "foreign_registration_number", "effective_date", "foreign_name", "declarations_unchanged", "directors" ], "description": "Step 2 of continuing out (BCA s.184,). After the notice of intention and the 14-day period, and once the company is registered in the destination jurisdiction, the registered agent files the notice of continuance." }, "Create_vg_continuance_notice_file": { "type": "object", "properties": { "type": { "const": "vg.continuance_notice.file" }, "params": { "$ref": "#/components/schemas/Params_vg_continuance_notice_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File notice of continuance for a BVI company continuing out", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_registration_certificate", "title": "Destination-jurisdiction certificate of registration or continuation", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified translation", "source": "uploaded", "required": false }, { "key": "good_standing_certificate", "title": "BVI certificate of good standing", "source": "registry_issued", "required": true }, { "key": "notice_of_continuance", "title": "Notice of continuance", "source": "generated", "required": true }, { "key": "certificate_of_discontinuance", "title": "Certificate of discontinuance", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true }, { "key": "declarations_confirmation", "title": "Declarations confirmation", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "declarations_confirmation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "notice_of_continuance", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Notice of continuance", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "intention_not_filed", "type": null, "when": "The referenced notice of intention has not completed." }, { "code": "notice_period_not_met", "type": null, "when": "Fewer than 14 days passed between the advertisement and the notice of intention." }, { "code": "foreign_registration_missing", "type": null, "when": "No destination-registry evidence is attached." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The company no longer qualifies for a certificate of good standing." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses the notice." } ] } }, "Params_vg_continuation_intention_withdraw": { "type": "object", "properties": { "continuation_intention": { "type": "string", "description": "ID of the completed vg.company.continue_out action whose notice is rescinded.", "examples": [ "act_8Mb2Ho6Vk" ] }, "reason": { "type": "string", "description": "Reason for rescinding, for the audit trail.", "examples": [ "Destination registration was refused" ] }, "directors": { "type": "array", "items": {}, "description": "Directors authorising the rescission.", "examples": [ "[\"per_8Qk2Lm\"]" ] } }, "required": [ "continuation_intention", "directors" ], "description": "Withdraws a filed notice of intention to continue a BVI company out of the BVI, before the notice of continuance is filed. The batch gives a Registry fee of US$100 for rescinding the intention." }, "Create_vg_continuation_intention_withdraw": { "type": "object", "properties": { "type": { "const": "vg.continuation_intention.withdraw" }, "params": { "$ref": "#/components/schemas/Params_vg_continuation_intention_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rescind a notice of intention to continue out", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution rescinding the intention to continue out", "source": "generated", "required": true }, { "key": "notice_of_rescission", "title": "Notice rescinding the intention to continue out", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_rescission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Notice rescinding the intention to continue out", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "intention_not_found", "type": null, "when": "The referenced continue_out action has no filed notice of intention." }, { "code": "continuance_already_filed", "type": null, "when": "The notice of continuance has been filed; rescission is no longer possible." }, { "code": "registry_rejected", "type": null, "when": "The Registrar refuses the rescission." } ] } }, "Params_vg_continuation_notice_revoke": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type of the BVI company." }, "continue_out_action_id": { "type": "string", "description": "The act_ id of the vg.company.continue_out action whose notice of intention is being rescinded." }, "notice_of_intention_filing_date": { "type": "string", "format": "date", "description": "Date the notice of intention was filed." }, "reason": { "type": "string", "description": "Internal reason, kept in the minutes." } }, "required": [ "entity_type", "notice_of_intention_filing_date" ], "description": "Withdraws a filed notice of intention to continue as a foreign company. The registered agent files a notice of rescission in the approved form at any time before the Registrar acts under s.184, that is, before a certificate of." }, "Create_vg_continuation_notice_revoke": { "type": "object", "properties": { "type": { "const": "vg.continuation_notice.revoke" }, "params": { "$ref": "#/components/schemas/Params_vg_continuation_notice_revoke" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rescind a notice of intention to continue out of the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' resolution to rescind", "source": "generated", "required": true }, { "key": "notice_of_rescission", "title": "Notice of rescission", "source": "generated", "required": true }, { "key": "registered_notice_of_rescission", "title": "Registered notice of rescission", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_rescission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of rescission of intention to continue", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "discontinuance_already_issued", "type": null, "when": "The Registrar has already issued a certificate of discontinuance (s.184,)." }, { "code": "no_notice_of_intention_on_file", "type": null, "when": "No notice of intention has been filed for the entity." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not register the rescission." } ] } }, "Params_vg_limited_partnership_consolidate": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "A consolidated LP always has legal personality (s.72)." }, "constituents": { "type": "array", "items": {}, "description": "Every constituent LP, as {entity_id or name, registration_number, jurisdiction, has_legal_personality}." }, "consolidated_partnership_name": { "type": "string", "description": "Name ending with 'Limited Partnership', 'L.P.' or 'LP'." }, "foreign_character_name": { "type": "string", "description": "Optional foreign character name, with a certified statement of its meaning." }, "interest_conversion_terms": { "type": "string", "description": "How each constituent's partnership interests convert into interests, debt or other securities of the new LP, or into money or other assets (s.73,)." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref ids of the new LP's general partners (s.74)." }, "term": { "type": "string", "description": "An end date, or 'unlimited' (s.74)." }, "lp_approval_threshold_percent": { "type": "number", "description": "More than 50% of limited partner capital contributions, or more if the LPA requires (s.73)." }, "approval_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "How partners vote (s.80-)." }, "is_recognised_fund": { "type": "boolean", "description": "If the new LP will be a recognised fund, only the general partner register is filed (s.53A)." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "entity_type", "constituents", "consolidated_partnership_name", "interest_conversion_terms", "general_partners", "term", "approval_method" ], "description": "Statutory consolidation of two or more limited partnerships with legal personality into a new consolidated BVI LP, which has legal personality. Each constituent approves the plan of consolidation, with the proposed partnership agreement." }, "Create_vg_limited_partnership_consolidate": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.consolidate" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_consolidate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Consolidate BVI limited partnerships into a new BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_consolidation", "title": "Plan of consolidation with the proposed partnership agreement attached", "source": "generated", "required": true }, { "key": "general_partners_resolution", "title": "Resolution of all general partners of each constituent", "source": "generated", "required": true }, { "key": "limited_partners_resolution", "title": "Limited partners' resolution of each constituent", "source": "generated", "required": true }, { "key": "notice_to_limited_partners", "title": "Notice to limited partners with dissent rights", "source": "generated", "required": true }, { "key": "gp_declaration", "title": "Declaration that each constituent approved the plan", "source": "generated", "required": true }, { "key": "gp_statement", "title": "Statement of the new LP's particulars", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Proposed registered agent's consent to act", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement of the consolidated LP", "source": "generated", "required": true }, { "key": "certificate_of_consolidation", "title": "Certificate of consolidation and certificate of registration", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "majority", "percent": 50, "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "limited_partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gp_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "gp_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partnership_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "certificate_of_consolidation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships", "form": "Application to register the consolidated limited partnership", "channel": "online", "government_fee": { "amount": 2100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lp_without_legal_personality", "type": null, "when": "A BVI constituent has no legal personality (s.72)." }, { "code": "partner_approval_insufficient", "type": null, "when": "s.73 approvals are not met." }, { "code": "name_invalid", "type": null, "when": "" }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not register the consolidated LP." }, { "code": "partner_compliance_declined", "type": null, "when": "requirement_error: the partner does not accept the new LP as a client." } ] } }, "Params_vg_limited_partnership_continue_in": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp", "lp_without_legal_personality" ], "description": "Choose lp_without_legal_personality to file the general partners' election of no legal personality (s.67)." }, "foreign_jurisdiction": { "type": "string", "description": "ISO 3166 code of the jurisdiction where the LP is registered.", "examples": [ "KY" ] }, "foreign_name": { "type": "string", "description": "Current registered name." }, "foreign_registration_number": { "type": "string", "description": "Home registration number." }, "name": { "type": "string", "description": "BVI name ending with 'Limited Partnership', 'L.P.' or 'LP', given in the s.8 statement." }, "foreign_character_name": { "type": "string", "description": "Optional, with a certified statement of its meaning." }, "term": { "type": "string", "description": "An end date, or 'unlimited' (s.8)." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref ids of each general partner." }, "limited_partners": { "type": "array", "items": {}, "description": "Limited partners and their interests, as {person_id, capital_contribution, percentage}, for the register due within 30 days (s.53A)." }, "disqualification_confirmations": { "type": "object", "description": "Booleans for each s.66 ground: - not_being_wound_up; - no_receiver_or_manager; - no_pending_liquidation_application; - not_deregistered." }, "gp_approval_date": { "type": "string", "format": "date", "description": "Date the general partners approved the application (s.67)." }, "is_recognised_fund": { "type": "boolean", "description": "A recognised fund files only the general partner register (s.53A)." }, "purpose_and_activity": { "type": "string", "description": "Purpose, strategy and investor profile, for Entiva CDD (AML/TF Code s.19)." } }, "required": [ "entity_type", "foreign_jurisdiction", "foreign_name", "foreign_registration_number", "name", "term", "general_partners", "limited_partners", "disqualification_confirmations", "gp_approval_date", "purpose_and_activity" ], "description": "Redomiciles a foreign limited partnership into the BVI under the Limited Partnership Act 2017. The home law must permit continuation, and the LP must not be: - being wound up; - under a receiver or manager; - subject to an undetermined." }, "Create_vg_limited_partnership_continue_in": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.continue_in" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a foreign limited partnership into the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_certificate_of_registration", "title": "Certified copy of the foreign certificate of registration or formation", "source": "uploaded", "required": true }, { "key": "gp_statement", "title": "Statement complying with s.8", "source": "generated", "required": true }, { "key": "no_legal_personality_declaration", "title": "Declaration that the LP will not have legal personality", "source": "generated", "required": false }, { "key": "registered_agent_consent", "title": "Proposed registered agent's written consent to act", "source": "generated", "required": true }, { "key": "gp_approval", "title": "Evidence of the general partners' approval", "source": "generated", "required": true }, { "key": "gp_certificate", "title": "General partner's certificate in the approved form", "source": "generated", "required": true }, { "key": "foreign_law_extract", "title": "Extract of the foreign law permitting continuation", "source": "uploaded", "required": true }, { "key": "partnership_agreement", "title": "Limited partnership agreement as continued", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership and control chart", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "certificate_of_continuation", "title": "Certificate of continuation", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "enhanced" }, { "role": "applicant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "gp_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "no_legal_personality_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "gp_approval", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "gp_certificate", "signer_role": "general_partner", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "certificate_of_continuation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships", "form": "Application", "channel": "online", "government_fee": { "amount": 1100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_law_does_not_permit", "type": null, "when": "The home law does not permit continuation (s.66)." }, { "code": "disqualified_from_continuing", "type": null, "when": "Any s.66 ground applies: being wound up, a receiver or manager, an undetermined liquidation application, or de-registration." }, { "code": "gp_certificate_not_notarised", "type": null, "when": "requirement_error: the general partner's certificate is not notarised or legalised, or the law extract is missing (s.66-)." }, { "code": "legal_personality_election_unconfirmed", "type": null, "when": "entity_type is lp_without_legal_personality but not every general partner has expressly approved the irrevocable election." }, { "code": "name_invalid", "type": null, "when": "proposed_name lacks the s.11 ending, or is unavailable." }, { "code": "public_interest_refusal", "type": null, "when": "registry_error: the Registrar refuses (s.68)." }, { "code": "partner_compliance_declined", "type": null, "when": "requirement_error: the partner does not accept the client." } ] } }, "Params_vg_limited_partnership_continue_out": { "type": "object", "properties": { "jurisdiction_of_continuation": { "type": "string", "description": "Country or territory whose law the LP will continue under.", "examples": [ "Cayman Islands" ] }, "foreign_entity_form": { "type": "string", "description": "Legal form the LP takes under the foreign law.", "examples": [ "Exempted limited partnership" ] }, "foreign_name": { "type": "string", "description": "Name under the foreign law if it differs from the BVI name." }, "effective_date": { "type": "string", "format": "date", "description": "Intended date of continuance." }, "partners_resolution": { "type": "string", "pattern": "^doc_", "description": "Approval of the continuation in the manner the limited partnership agreement requires." }, "gazette_publication_date": { "type": "string", "format": "date", "description": "Date the notice of intention was advertised in the Gazette (s.70)." }, "website_notice_url": { "type": "string", "description": "URL of the notice on the LP's website, if it has one (s.70)." }, "limited_partners_notified_on": { "type": "string", "format": "date", "description": "Date every limited partner was notified in writing (s.70)." }, "creditors_notified_on": { "type": "string", "format": "date", "description": "Date creditors were notified in writing (s.70)." }, "charges": { "type": "object", "description": "Position on registered charges (s.70)." }, "declarations": { "type": "object", "description": "Booleans, all of which must be true, with the signing general partner. no_pending_competent_authority_request, no_receiver_appointed, no_known_proceedings." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref or entity_ref for every general partner of the LP.", "examples": [ "[\"per_01JB3M\"]" ] }, "provisional_certificate": { "type": "string", "pattern": "^doc_", "description": "Provisional certificate of continuance issued under the foreign law." }, "certificate_of_good_standing": { "type": "string", "pattern": "^doc_", "description": "Optional evidence that the LP is in good standing." } }, "required": [ "jurisdiction_of_continuation", "partners_resolution", "gazette_publication_date", "limited_partners_notified_on", "creditors_notified_on", "charges", "declarations", "general_partners" ], "description": "Moves a BVI limited partnership to another jurisdiction under LPA s.70. The LP advertises and notifies partners and creditors at least 14 days ahead, files a notice of intention with declarations, completes the foreign-law steps, and its." }, "Create_vg_limited_partnership_continue_out": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.continue_out" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a BVI limited partnership under foreign law", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_resolution", "title": "Partners' approval of the continuation", "source": "generated", "required": true }, { "key": "notice_of_intention", "title": "Notice of intention to continue outside the Virgin Islands", "source": "generated", "required": true }, { "key": "gazette_notice", "title": "Gazette advertisement and website notice", "source": "generated", "required": true }, { "key": "partner_and_creditor_notices", "title": "Written notices to limited partners and creditors", "source": "generated", "required": true }, { "key": "charge_declaration", "title": "Written declaration on registered charges", "source": "generated", "required": false }, { "key": "foreign_law_declaration", "title": "Declaration that foreign law permits continuation and has been complied with", "source": "generated", "required": true }, { "key": "provisional_certificate", "title": "Provisional certificate of continuance under foreign law", "source": "uploaded", "required": false }, { "key": "notice_of_continuance", "title": "Notice of the limited partnership's continuance", "source": "generated", "required": true }, { "key": "certificate_of_discontinuance", "title": "Certificate of discontinuance", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipts", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "limited_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "general_partners", "threshold": "each", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_intention", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "charge_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "foreign_law_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_continuance", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_intention", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of intention to continue", "channel": "online", "government_fee": { "amount": 1750, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_in_good_standing", "type": null, "when": "The Registrar would not issue a s.112 certificate of good standing. s.70." }, { "code": "notice_period_not_elapsed", "type": null, "when": "The Gazette advertisement and written notices are less than 14 days before the planned notice of intention." }, { "code": "charge_declaration_required", "type": null, "when": "A registered charge is still in effect and no s.70 position is given." }, { "code": "charge_prohibits_continuation", "type": null, "when": "The charge contains a covenant against continuing outside the BVI." }, { "code": "declaration_not_available", "type": null, "when": "The competent-authority, receiver or proceedings declaration cannot be made true." }, { "code": "foreign_law_does_not_permit", "type": null, "when": "Foreign-law counsel confirms the destination does not allow inbound continuation of this LP." }, { "code": "limited_partnership_agreement_prohibits", "type": null, "when": "The LP agreement bars continuation or the approval threshold is not met (s.70)." } ] } }, "Params_vg_limited_partnership_convert": { "type": "object", "properties": { "legal_personality": { "type": "boolean", "description": "true elects legal personality." }, "name": { "type": "string", "description": "Name of the limited partnership.", "examples": [ "Harbour Ventures LP" ] }, "foreign_character_name": { "type": "string", "description": "Foreign character name, if any (para 4)." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office address (para 4)." }, "registered_agent": { "type": "string", "pattern": "^ent_", "description": "Registered agent on re-registration (para 4)." }, "general_partners": { "type": "array", "items": {}, "description": "Name and address of each general partner (para 4). person_ref or entity_ref." }, "term": { "type": "object", "description": "Duration: {type: unlimited | fixed, end_date: date}." }, "existing_registration_number": { "type": "string", "description": "Number under the Partnership Act 1996." }, "partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "Written agreement complying with LPA s.7." }, "arrears_cleared": { "type": "boolean", "description": "Confirms no unpaid Partnership Act fees or penalties." } }, "required": [ "legal_personality", "name", "registered_office", "registered_agent", "general_partners", "term", "existing_registration_number", "partnership_agreement", "arrears_cleared" ], "description": "Re-registers an existing local or international LP under the LPA 2017. The existing registered agent files a statement signed by or for each general partner, an optional irrevocable declaration electing legal personality, and its own." }, "Create_vg_limited_partnership_convert": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.convert" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a Partnership Act 1996 limited partnership under the Limited Partnership Act 2017", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "existing_lp_partnership_act_1996" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "re_registration_statement", "title": "Re-registration statement", "source": "generated", "required": true }, { "key": "legal_personality_declaration", "title": "Declaration electing legal personality", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement complying with s.7", "source": "uploaded", "required": true }, { "key": "certificate_of_re_registration", "title": "Certificate of re-registration", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "re_registration_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "legal_personality_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "partnership_agreement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "re_registration_statement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Re-registration statement, optional legal-personality declaration, registered agent consen", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "transition_period_ended", "type": null, "when": "The transition period has expired." }, { "code": "not_registered_agent", "type": null, "when": "The filing agent is not the LP's existing registered agent (para 4)." }, { "code": "partnership_agreement_non_compliant", "type": null, "when": "The agreement does not satisfy LPA s.7." }, { "code": "arrears_outstanding", "type": null, "when": "Fees or penalties under the Partnership Act 1996 are unpaid (para 5)." }, { "code": "legal_personality_election_unconfirmed", "type": null, "when": "The general partners have not given explicit approval of the irrevocable election." } ] } }, "Params_vg_limited_partnership_merge": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "Entity type of the surviving LP." }, "this_entity_role": { "type": "string", "enum": [ "surviving_partnership", "merging_partnership" ], "description": "Whether the LP in the path survives or merges away." }, "constituents": { "type": "array", "items": {}, "description": "Every constituent LP." }, "surviving_partnership_name": { "type": "string", "description": "Name of the survivor, ending with 'Limited Partnership', 'L.P.' or 'LP' (ss.11, 74)." }, "foreign_character_name": { "type": "string", "description": "The survivor's foreign character name, if any (s.74)." }, "interest_conversion_terms": { "type": "string", "description": "The manner and basis of cancelling, reclassifying or converting partnership interests in each constituent into interests, debt obligations or other securities." }, "survivor_lpa_amendments": { "type": "string", "description": "Amendments to the survivor's limited partnership agreement brought about by the merger." }, "general_partners": { "type": "array", "items": {}, "description": "person_ref ids of each general partner of the survivor." }, "term": { "type": "string", "description": "The survivor's term: an end date, or 'unlimited' (s.74)." }, "plan_approval_dates": { "type": "array", "items": {}, "description": "Date each constituent approved the plan, as {constituent, date} (s.74)." }, "lp_approval_threshold_percent": { "type": "number", "description": "The share of total limited partner capital contributions that must approve." }, "approval_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "How partners vote." }, "registered_particulars_changes": { "type": "object", "description": "Any change to the survivor's name, registered office or registered agent on registration." }, "foreign_law_permits": { "type": "boolean", "description": "Required when a constituent is a foreign LP (s.77-)." } }, "required": [ "entity_type", "this_entity_role", "constituents", "surviving_partnership_name", "interest_conversion_terms", "general_partners", "term", "approval_method" ], "description": "Statutory merger of two or more limited partnerships with legal personality into a surviving BVI LP. A foreign LP may also merge into a BVI survivor (ss.77-78)." }, "Create_vg_limited_partnership_merge": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.merge" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge BVI limited partnerships into a surviving BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Plan of merger with the proposed survivor LPA attached", "source": "generated", "required": true }, { "key": "general_partners_resolution", "title": "Resolution of all general partners of each constituent", "source": "generated", "required": true }, { "key": "limited_partners_resolution", "title": "Limited partners' resolution of each constituent", "source": "generated", "required": true }, { "key": "notice_to_limited_partners", "title": "Notice of meeting or resolution to limited partners", "source": "generated", "required": true }, { "key": "gp_declaration", "title": "Declaration that each constituent approved the plan", "source": "generated", "required": true }, { "key": "gp_statement", "title": "Statement of the survivor's particulars", "source": "generated", "required": true }, { "key": "notice_of_change_of_particulars", "title": "Notification of change of name, registered office or registered agent", "source": "generated", "required": false }, { "key": "foreign_constituent_evidence", "title": "Evidence for each foreign constituent LP", "source": "uploaded", "required": false }, { "key": "dissent_notice", "title": "Notice to objecting limited partners", "source": "generated", "required": false }, { "key": "fair_value_offer", "title": "Fair value offer to dissenting limited partners", "source": "generated", "required": false }, { "key": "certificate_of_merger", "title": "Certificate of merger", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "limited_partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "gp_declaration", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "gp_statement", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_limited_partners", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_merger", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships", "form": "Application to register the surviving limited partnership", "channel": "online", "government_fee": { "amount": 2100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lp_without_legal_personality", "type": null, "when": "A BVI constituent elected to have no legal personality." }, { "code": "entity_type_not_supported", "type": null, "when": "A constituent is a company or a Partnership Act 1996 partnership." }, { "code": "partner_approval_insufficient", "type": null, "when": "Not every general partner approved, or approving limited partners do not exceed the s.73 or LPA threshold." }, { "code": "lpa_prohibits_merger", "type": null, "when": "A constituent's partnership agreement excludes or conditions the merger (ss.72, 73)." }, { "code": "name_invalid", "type": null, "when": "" }, { "code": "survivor_is_foreign", "type": null, "when": "The survivor is a foreign LP." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not register the merger." } ] } }, "Params_vg_limited_partnership_merge_into_foreign": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "The BVI constituent." }, "form": { "type": "string", "enum": [ "merger", "consolidation" ], "description": "Merger into an existing foreign LP, or consolidation into a new foreign LP." }, "foreign_survivor_name": { "type": "string", "description": "Name of the foreign surviving or consolidated LP." }, "foreign_survivor_jurisdiction": { "type": "string", "description": "ISO 3166 code of the foreign LP's jurisdiction.", "examples": [ "KY" ] }, "foreign_survivor_registration_number": { "type": "string", "description": "Registration number, once it exists." }, "foreign_law_permits": { "type": "boolean", "description": "Confirms the foreign law permits the merger (s.77)." }, "constituents": { "type": "array", "items": {}, "description": "Every constituent LP, as {entity_id or name, registration_number, jurisdiction, has_legal_personality}." }, "interest_conversion_terms": { "type": "string", "description": "How the BVI LP's interests convert (s.73-)." }, "approval_method": { "type": "string", "enum": [ "written_resolution", "meeting" ], "description": "How partners vote (s.80-)." }, "lp_approval_threshold_percent": { "type": "number", "description": "More than 50% of limited partner capital contributions, or more if the LPA requires (s.73)." }, "process_agent": { "type": "string", "description": "The registered agent the foreign survivor irrevocably appoints to accept service (s.78)." } }, "required": [ "entity_type", "form", "foreign_survivor_name", "foreign_survivor_jurisdiction", "foreign_law_permits", "constituents", "interest_conversion_terms", "approval_method", "process_agent" ], "description": "A BVI limited partnership with legal personality merges or consolidates with one or more foreign limited partnerships, and the survivor is a foreign LP (LPA ss.77, 78). This is allowed only if the foreign law permits it." }, "Create_vg_limited_partnership_merge_into_foreign": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.merge_into_foreign" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_merge_into_foreign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merge or consolidate a BVI limited partnership into a foreign limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_merger", "title": "Plan of merger stating the survivor is a foreign LP", "source": "generated", "required": true }, { "key": "general_partners_resolution", "title": "Resolution of all general partners of the BVI LP", "source": "generated", "required": true }, { "key": "limited_partners_resolution", "title": "Limited partners' resolution of the BVI LP", "source": "generated", "required": true }, { "key": "notice_to_limited_partners", "title": "Notice to limited partners with dissent rights", "source": "generated", "required": true }, { "key": "service_of_process_agreement", "title": "Foreign survivor's agreement to accept service in the BVI", "source": "generated", "required": true }, { "key": "process_agent_appointment", "title": "Irrevocable appointment of a registered agent for service", "source": "generated", "required": true }, { "key": "dissenter_payment_undertaking", "title": "Undertaking to pay dissenting limited partners promptly", "source": "generated", "required": true }, { "key": "foreign_certificate_of_merger", "title": "Foreign certificate of merger or consolidation", "source": "uploaded", "required": true }, { "key": "foreign_law_evidence", "title": "Evidence that the foreign law permits the merger", "source": "uploaded", "required": true }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "general_partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "limited_partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_to_limited_partners", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "service_of_process_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "process_agent_appointment", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "dissenter_payment_undertaking", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "foreign_certificate_of_merger", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Limited Partnerships", "form": "Documents under LPA s.78", "channel": "online", "government_fee": { "amount": 1000, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lp_without_legal_personality", "type": null, "when": "The BVI LP has no legal personality (s.77)." }, { "code": "foreign_law_not_confirmed", "type": null, "when": "foreign_law_permits is false, or evidence is missing (s.77)." }, { "code": "foreign_certificate_missing", "type": null, "when": "There is no foreign certificate and no other evidence the Registrar accepts (s.78)." }, { "code": "partner_approval_insufficient", "type": null, "when": "s.73 approvals are not met." }, { "code": "wet_ink_original_not_received", "type": null, "when": "requirement_error: the original process agent appointment has not arrived." }, { "code": "registry_rejected", "type": null, "when": "registry_error: the Registrar does not accept the filing." } ] } }, "Params_vg_limited_partnership_continuation_revoke": { "type": "object", "properties": { "continuation": { "type": "string", "description": "ID of the vg.limited_partnership.continue_out action whose notice of intention is being rescinded.", "examples": [ "act_01JB3P5X" ] }, "reason": { "type": "string", "description": "Free-text reason, kept in the audit log." }, "general_partners": { "type": "array", "items": {}, "description": "General partners who approve the rescission.", "examples": [ "[\"per_01JB3MQ7\"]" ] } }, "required": [ "continuation", "general_partners" ], "description": "Withdraws a filed notice of intention to continue under foreign law (LPA s.70). Allowed at any time before the Registrar takes action under s.70, that is, before issuing the certificate of discontinuance." }, "Create_vg_limited_partnership_continuation_revoke": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership_continuation.revoke" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_continuation_revoke" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Rescind a notice of intention to continue a BVI LP outside the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_rescission", "title": "Notice of rescission of intention to continue", "source": "generated", "required": true }, { "key": "partners_resolution", "title": "Partners' approval of the rescission", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "as_constitution", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_rescission", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Notice of rescission in the approved form", "channel": "online", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "continuation_not_found", "type": null, "when": "The referenced action did not file a notice of intention." }, { "code": "continuation_already_effective", "type": null, "when": "The Registrar has already issued the certificate of discontinuance, so rescission is no longer possible." } ] } }, "Params_vg_lp_plan_of_arrangement_file": { "type": "object", "properties": { "arrangement_types": { "type": "array", "items": {}, "description": "Kinds of arrangement in the plan (s.82): amendment of the LP agreement, reorganisation, merger or consolidation, separation of businesses, disposal of assets.", "examples": [ "[\"reorganisation\"]" ] }, "plan_of_arrangement": { "type": "string", "pattern": "^doc_", "description": "Plan with the details of the proposed arrangement." }, "approver": { "type": "string", "enum": [ "general_partners", "liquidator" ], "description": "General partners, or the liquidator of an LP in liquidation." }, "general_partners": { "type": "array", "items": {}, "description": "All general partners. s.82 requires a resolution of all of them.", "examples": [ "[\"per_01JB9GP1\"]" ] }, "court_case_number": { "type": "string", "description": "High Court claim number." }, "interim_order": { "type": "string", "pattern": "^doc_", "description": "Interim directions on notice, approvals and hearing (s.83)." }, "final_order": { "type": "string", "pattern": "^doc_", "description": "Final order approving, with amendments, or rejecting the plan (s.83)." }, "final_order_date": { "type": "string", "format": "date", "description": "Date of the order." }, "effective_date": { "type": "string", "format": "date", "description": "The plan takes effect on the order date or the later date the order states (s.83)." }, "dissent_fair_value": { "type": "boolean", "description": "True if the Court orders a dissenting limited partner to be paid fair value (s.83)." }, "notice_of_arrangement_required": { "type": "boolean", "description": "True if the final order directs a notice of the arrangement to be filed (s.83)." }, "court_counsel": { "type": "string", "pattern": "^ent_", "description": "BVI legal practitioner on the court record." } }, "required": [ "arrangement_types", "plan_of_arrangement", "approver", "general_partners", "court_counsel" ], "description": "Handles an LPA s.82-84 plan of arrangement. All general partners approve the plan, the LP applies to the Court, and the final order takes effect on its date or a later stated date." }, "Create_vg_lp_plan_of_arrangement_file": { "type": "object", "properties": { "type": { "const": "vg.lp_plan_of_arrangement.file" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_plan_of_arrangement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Court-approved plan of arrangement of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_arrangement", "title": "Plan of arrangement", "source": "uploaded", "required": true }, { "key": "partners_resolution", "title": "Resolution of all general partners approving the plan", "source": "generated", "required": true }, { "key": "court_application", "title": "Court application and evidence", "source": "uploaded", "required": true }, { "key": "final_order", "title": "Final order of the Court", "source": "uploaded", "required": true }, { "key": "notice_of_arrangement", "title": "Notice of the arrangement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_application", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "notice_of_arrangement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court Commercial Division", "form": "Court final order", "channel": "online", "government_fee": { "amount": 1500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "general_partners_not_unanimous", "type": null, "when": "Not every general partner has consented (s.82)." }, { "code": "court_order_required", "type": null, "when": "The notice or follow-up filings are requested before a final order exists." }, { "code": "plan_rejected", "type": null, "when": "The Court rejects the plan (s.83)." }, { "code": "scheme_route_required", "type": null, "when": "The proposal is a compromise with creditors or partners that needs a scheme under s.85." } ] } }, "Params_vg_lp_scheme_of_arrangement_file": { "type": "object", "properties": { "applicant": { "type": "string", "enum": [ "lp", "creditor", "partner", "liquidator", "insolvency_liquidator" ], "description": "Who applies (s.85)." }, "scheme_with": { "type": "string", "enum": [ "creditors", "partners", "both" ], "description": "Counterparties to the compromise or arrangement." }, "classes": { "type": "array", "items": {}, "description": "Classes for the meetings: [{name, type, meeting_date}]." }, "scheme_document": { "type": "string", "pattern": "^doc_", "description": "Terms of the compromise or arrangement and explanatory statement." }, "binds_creditors": { "type": "boolean", "description": "True if the scheme binds creditors or a class of them." }, "court_case_number": { "type": "string", "description": "High Court claim number." }, "meeting_results": { "type": "array", "items": {}, "description": "Per class: {class, held_on, outcome}." }, "sanction_order": { "type": "string", "pattern": "^doc_", "description": "Order sanctioning the scheme." }, "sanction_order_date": { "type": "string", "format": "date", "description": "Date of the order." }, "general_partners": { "type": "array", "items": {}, "description": "General partners; they must agree to any scheme with partners." }, "court_counsel": { "type": "string", "pattern": "^ent_", "description": "BVI legal practitioner on the court record." } }, "required": [ "applicant", "scheme_with", "classes", "scheme_document", "binds_creditors", "general_partners", "court_counsel" ], "description": "Handles an LPA s.85 scheme between an LP and its creditors or partners. The Court summons meetings; creditors need a majority in number representing 75% in value, partners need all general partners and limited partners owning more than 75%." }, "Create_vg_lp_scheme_of_arrangement_file": { "type": "object", "properties": { "type": { "const": "vg.lp_scheme_of_arrangement.file" }, "params": { "$ref": "#/components/schemas/Params_vg_lp_scheme_of_arrangement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a court-sanctioned scheme of arrangement of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "scheme_document", "title": "Scheme and explanatory statement", "source": "uploaded", "required": true }, { "key": "partners_resolution", "title": "General partners' resolution to apply and agree", "source": "generated", "required": false }, { "key": "court_application", "title": "Court application and evidence", "source": "uploaded", "required": true }, { "key": "meeting_report", "title": "Chair's report on the meetings", "source": "uploaded", "required": true }, { "key": "sanction_order", "title": "Court order sanctioning the scheme", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_application", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "sanction_order", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court Commercial Division", "form": "Copy of the Court order", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "vote_threshold_not_met", "type": null, "when": "A creditor class or the partners did not reach the s.85 thresholds." }, { "code": "sanction_order_required", "type": null, "when": "Filing requested before the Court sanctions the scheme." }, { "code": "applicant_not_eligible", "type": null, "when": "The applicant is not in the s.85 list." }, { "code": "order_has_no_effect_until_filed", "type": null, "when": "The scheme binds creditors and the copy order is not yet filed (s.85); the action warns until it is." } ] } }, "Params_vg_plan_of_arrangement_file": { "type": "object", "properties": { "arrangement_types": { "type": "array", "items": {}, "description": "Which kinds of arrangement the plan contains (s.177).", "examples": [ "[\"reorganisation\",\"merger\"]" ] }, "plan_of_arrangement": { "type": "string", "pattern": "^doc_", "description": "The plan with details of the proposed arrangement (s.177)." }, "approver": { "type": "string", "enum": [ "directors", "voluntary_liquidator" ], "description": "Who approves the plan: directors, or the voluntary liquidator if the company is in voluntary liquidation." }, "directors": { "type": "array", "items": {}, "description": "Directors who approve and later confirm the plan.", "examples": [ "[\"per_01JB7D1\",\"per_01JB7D2\"]" ] }, "court_case_number": { "type": "string", "description": "High Court claim number once the application is issued.", "examples": [ "BVIHC (COM) 0142 of 2026" ] }, "interim_order": { "type": "string", "pattern": "^doc_", "description": "Interim order on notice, approvals and dissent (s.177)." }, "final_order": { "type": "string", "pattern": "^doc_", "description": "Order approving or amending the plan (s.177)." }, "final_order_date": { "type": "string", "format": "date", "description": "Date of the final order." }, "dissent_permitted": { "type": "boolean", "description": "Whether the Court allowed holders to dissent and be paid fair value under s.179 (s.177, s.179)." }, "post_order_approvals": { "type": "object", "description": "Notice given and approvals obtained as the order requires (s.177): {notified_on: date, approval_method: string, approved_on: date}." }, "other_constituent_companies": { "type": "array", "items": {}, "description": "Other companies that are parties, where the arrangement is a merger or consolidation. entity_ref list." }, "authorised_shares_band": { "type": "string", "enum": [ "up_to_50000", "over_50000", "no_shares" ], "description": "Sets the Registry fee." }, "effective_date": { "type": "string", "format": "date", "description": "Later effective date stated in the articles." }, "court_counsel": { "type": "string", "pattern": "^ent_", "description": "BVI legal practitioner who makes the court application." } }, "required": [ "arrangement_types", "plan_of_arrangement", "approver", "directors", "authorised_shares_band", "court_counsel" ], "description": "Runs a BCA s.177 plan of arrangement from directors' approval through the High Court interim and final orders, directors' confirmation, any approvals the order requires, execution of articles of arrangement, and registration by the." }, "Create_vg_plan_of_arrangement_file": { "type": "object", "properties": { "type": { "const": "vg.plan_of_arrangement.file" }, "params": { "$ref": "#/components/schemas/Params_vg_plan_of_arrangement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register articles of arrangement after court approval of a BVI plan of arrangement", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_arrangement", "title": "Plan of arrangement", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' approval of the plan", "source": "generated", "required": true }, { "key": "court_application", "title": "Court application and supporting evidence", "source": "uploaded", "required": true }, { "key": "interim_order", "title": "Interim order of the High Court", "source": "uploaded", "required": false }, { "key": "final_order", "title": "Final order approving the plan", "source": "uploaded", "required": true }, { "key": "directors_confirmation", "title": "Directors' confirmation of the Court-approved plan", "source": "generated", "required": true }, { "key": "articles_of_arrangement", "title": "Articles of arrangement", "source": "generated", "required": true }, { "key": "certificate_of_arrangement", "title": "Certificate of arrangement", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "court", "threshold": "as_constitution", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "directors_confirmation", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_application", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "articles_of_arrangement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_arrangement", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Articles of arrangement", "channel": "online", "government_fee": { "amount": 1400, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "court_order_required", "type": null, "when": "Articles of arrangement are requested before a final order is uploaded." }, { "code": "plan_not_confirmed", "type": null, "when": "Directors have not confirmed the plan after the order (s.177)." }, { "code": "order_approvals_outstanding", "type": null, "when": "The order requires notice or approvals that have not been completed (s.177)." }, { "code": "effective_date_too_late", "type": null, "when": "effective_date is more than 30 days after the expected registration date (s.177)." }, { "code": "scheme_route_required", "type": null, "when": "The proposal is a compromise with creditors or members to be sanctioned under s.179A." }, { "code": "appeal_period_open", "type": null, "when": "A point-of-law appeal is notified within 20 days of the order." } ] } }, "Params_vg_scheme_of_arrangement_file": { "type": "object", "properties": { "applicant": { "type": "string", "enum": [ "company", "creditor", "member", "administrator", "voluntary_liquidator", "insolvency_liquidator" ], "description": "Who applies to the Court (s.179A)." }, "scheme_with": { "type": "string", "enum": [ "creditors", "members", "both" ], "description": "Counterparties to the compromise or arrangement." }, "classes": { "type": "array", "items": {}, "description": "Classes of creditors or members for the meetings: [{name, type, meeting_date}]." }, "scheme_document": { "type": "string", "pattern": "^doc_", "description": "Terms of the compromise or arrangement and explanatory statement." }, "court_case_number": { "type": "string", "description": "High Court claim number." }, "meeting_results": { "type": "array", "items": {}, "description": "Per class: {class, held_on, voting_in_favour_value_pct, majority_in_number}." }, "sanction_order": { "type": "string", "pattern": "^doc_", "description": "Order sanctioning the scheme." }, "sanction_order_date": { "type": "string", "format": "date", "description": "Date of the order." }, "includes_share_capital_reorganisation": { "type": "boolean", "description": "True if the scheme consolidates or divides shares of different classes (s.179A)." }, "court_counsel": { "type": "string", "pattern": "^ent_", "description": "BVI legal practitioner." }, "directors": { "type": "array", "items": {}, "description": "Directors who approve the company's application when the company is the applicant." } }, "required": [ "applicant", "scheme_with", "classes", "scheme_document", "court_counsel" ], "description": "Handles a BCA s.179A scheme between a company and its creditors or members. The Court convenes meetings, a majority in number representing 75% in value of those present and voting must agree, and the Court sanctions." }, "Create_vg_scheme_of_arrangement_file": { "type": "object", "properties": { "type": { "const": "vg.scheme_of_arrangement.file" }, "params": { "$ref": "#/components/schemas/Params_vg_scheme_of_arrangement_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a court-sanctioned scheme of arrangement of a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "restructuring", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "scheme_document", "title": "Scheme of arrangement and explanatory statement", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Directors' resolution to apply", "source": "generated", "required": false }, { "key": "court_application", "title": "Court application and evidence", "source": "uploaded", "required": true }, { "key": "meeting_report", "title": "Chair's report on the scheme meetings", "source": "uploaded", "required": true }, { "key": "sanction_order", "title": "Court order sanctioning the scheme", "source": "uploaded", "required": true }, { "key": "memorandum_annex", "title": "Memorandum with order annexed", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "declarant", "verification_level": "identity_address" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "special", "percent": 75, "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_application", "signer_role": "declarant", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "sanction_order", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "Copy of the sanction order", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "vote_threshold_not_met", "type": null, "when": "A class did not reach a majority in number representing 75% in value of those present and voting." }, { "code": "sanction_order_required", "type": null, "when": "Filing is requested before the Court has sanctioned the scheme." }, { "code": "applicant_not_eligible", "type": null, "when": "The applicant is not one of the persons listed in s.179A." }, { "code": "merger_route_instead", "type": null, "when": "The structure is a plan of arrangement under s.177; use vg.plan_of_arrangement.file." }, { "code": "memorandum_annex_missing", "type": null, "when": "No updated memorandum copy carrying the order has been produced (s.179A)." } ] } }, "Params_vg_company_restore": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type.", "examples": [ "bc_ltd_shares" ] }, "strike_off_notice_date": { "type": "string", "format": "date", "description": "Date of the Gazette notice of strike-off.", "examples": [ "2025-03-14" ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date of strike-off and dissolution.", "examples": [ "2025-06-12" ] }, "applicant_capacity": { "type": "string", "enum": [ "company", "creditor", "member", "liquidator" ], "description": "Who applies.", "examples": [ "member" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "The person applying.", "examples": [ "per_test_9Lm2" ] }, "in_operation_when_struck_off": { "type": "boolean", "description": "The applicant confirms the company was in operation or carrying on business when struck off, as s.217 requires.", "examples": [ "true" ] }, "records_status": { "type": "string", "enum": [ "updated", "undertaking" ], "description": "updated: the registered agent declares registers and due-diligence records are already updated. undertaking: the agent undertakes to update them within 14 days.", "examples": [ "undertaking" ] }, "directors": { "type": "array", "items": {}, "description": "Directors on restoration, as person references; the register of directors is filed on or within 14 days of restoration.", "examples": [ "[\"per_test_9Lm2\"]" ] }, "members": { "type": "array", "items": {}, "description": "Members on restoration, as person references or entity references; the register of members is filed on or within 14 days of restoration.", "examples": [ "[\"per_test_9Lm2\",\"per_test_3Dn6\"]" ] }, "bona_vacantia": { "type": "boolean", "description": "True if any company property vested in the Crown as bona vacantia; Crown consent is then required.", "examples": [ "false" ] }, "crown_consent_reference": { "type": "string", "description": "Reference of the Crown's consent where bona_vacantia is true.", "examples": [ "AGC/BV/2026/118" ] }, "outstanding_fees": { "$ref": "#/components/schemas/Money", "description": "Outstanding annual fees and penalties to be paid with the application, per the partner's VIRRGIN statement.", "examples": [ "USD 2400" ] }, "reason": { "type": "string", "description": "Reason for restoration.", "examples": [ "Company was struck off in error while holding a bank account." ] } }, "required": [ "entity_type", "strike_off_notice_date", "dissolution_date", "applicant_capacity", "applicant", "in_operation_when_struck_off", "records_status", "directors", "members", "bona_vacantia", "reason" ], "description": "The company, a creditor, member or liquidator applies in the approved form through a licensed registered agent to have the Registrar restore a company that was struck off and dissolved. Conditions: the company was in operation when struck." }, "Create_vg_company_restore": { "type": "object", "properties": { "type": { "const": "vg.company.restore" }, "params": { "$ref": "#/components/schemas/Params_vg_company_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Administrative restoration of a struck-off and dissolved BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restoration_application", "title": "Application for administrative restoration", "source": "generated", "required": true }, { "key": "registered_agent_declaration", "title": "Registered agent's declaration or undertaking", "source": "generated", "required": true }, { "key": "evidence_of_operation", "title": "Evidence the company was in operation when struck off", "source": "uploaded", "required": true }, { "key": "crown_consent", "title": "Crown consent", "source": "uploaded", "required": false }, { "key": "register_of_directors", "title": "Register of directors", "source": "generated", "required": true }, { "key": "register_of_members", "title": "Register of members", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director's consent to act", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Authorising resolution", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN receipt", "source": "registry_issued", "required": true }, { "key": "certificate_of_restoration", "title": "Certificate of restoration", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "restoration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Application for restoration in the approved form", "channel": "online", "government_fee": { "amount": 700, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_window_expired", "type": null, "when": "More than 5 years have passed since the Gazette notice of strike-off; court restoration under s.218 is required." }, { "code": "not_in_operation_when_struck_off", "type": null, "when": "in_operation_when_struck_off is false or the evidence does not support it." }, { "code": "crown_consent_required", "type": null, "when": "bona_vacantia is true and no crown_consent is on file." }, { "code": "registers_not_ready", "type": null, "when": "Directors or members are missing, so registers cannot be filed or undertaken within 14 days." }, { "code": "outstanding_fees_unpaid", "type": null, "when": "The restoration fee or outstanding annual fees and penalties have not been funded." }, { "code": "agent_not_licensed", "type": null, "when": "The partner cannot agree to act." }, { "code": "cdd_incomplete", "type": null, "when": "" }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live actions." } ] } }, "Params_vg_company_restore_by_court": { "type": "object", "properties": { "applicant": { "type": "string", "pattern": "^per_", "description": "The person applying to the Court.", "examples": [ "per_1R8kXm2eZ" ] }, "applicant_capacity": { "type": "string", "enum": [ "creditor", "former_director", "former_member", "former_liquidator", "interested_person" ], "description": "The capacity in which the applicant has standing under s.218.", "examples": [ "former_director" ] }, "interest_description": { "type": "string", "description": "Required when applicant_capacity is interested_person: why the applicant has an interest in restoration.", "examples": [ "Claimant in pending proceedings that need the company as defendant." ] }, "restoration_purpose": { "type": "string", "enum": [ "bring_or_defend_proceedings", "recover_property_vested_in_crown", "complete_liquidation_matters", "other" ], "description": "Why restoration is sought.", "examples": [ "bring_or_defend_proceedings" ] }, "purpose_detail": { "type": "string", "description": "Short narrative for the affidavit and Court application, including any conditions the applicant proposes.", "examples": [ "Restoration is needed so the company can be sued over a 2023 supply contract." ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date the company was dissolved.", "examples": [ "2024-03-12" ] }, "dissolution_cause": { "type": "string", "enum": [ "struck_off_by_registrar", "voluntary_liquidation_completed", "voluntary_liquidation_terminated", "insolvency_liquidation_completed", "other" ], "description": "How the company came off the Register.", "examples": [ "voluntary_liquidation_completed" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Required when dissolution_cause is a liquidation: the person the applicant nominates as liquidator on restoration (s.218A).", "examples": [ "per_9TqLw4vNc" ] }, "liquidator_costs_provision": { "$ref": "#/components/schemas/Money", "description": "Required with liquidator: the provision made for the expenses and remuneration of the liquidator (s.218A).", "examples": [ "{\"amount\": 15000, \"currency\": \"USD\"}" ] }, "regulated_person_before_dissolution": { "type": "boolean", "description": "True if the company was at any time before dissolution a regulated person.", "examples": [ "false" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref.", "examples": [ "[\"per_5Hs2LpDa1\"]" ] }, "registered_agent_after_restoration": { "type": "string", "enum": [ "entiva_partner", "other" ], "description": "Who will act as registered agent once the company is restored.", "examples": [ "entiva_partner" ] } }, "required": [ "applicant", "applicant_capacity", "restoration_purpose", "purpose_detail", "dissolution_date", "dissolution_cause", "regulated_person_before_dissolution" ], "description": "Applies to the High Court to restore a dissolved or struck-off BVI business company to the Register under BCA s.218. A BVI counsel on the court record makes the application and serves the Registrar, the Financial Secretary and, if the." }, "Create_vg_company_restore_by_court": { "type": "object", "properties": { "type": { "const": "vg.company.restore_by_court" }, "params": { "$ref": "#/components/schemas/Params_vg_company_restore_by_court" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a dissolved BVI company by Court order", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "court_application", "title": "Court application to restore the company", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Supporting affidavit of the applicant", "source": "uploaded", "required": true }, { "key": "evidence_of_interest", "title": "Evidence of the applicant's standing", "source": "uploaded", "required": true }, { "key": "certificate_of_dissolution", "title": "Certificate of dissolution or strike-off notice", "source": "uploaded", "required": false }, { "key": "liquidator_consent_to_act", "title": "Nominated liquidator's written consent", "source": "generated", "required": false }, { "key": "liquidator_eligibility_evidence", "title": "Evidence of the nominated liquidator's eligibility", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Resolution of a corporate applicant authorising the application", "source": "uploaded", "required": false }, { "key": "notice_of_application", "title": "Notice of the application for service", "source": "generated", "required": true }, { "key": "proof_of_service", "title": "Proof of service on the Registrar, Financial Secretary and FSC", "source": "uploaded", "required": true }, { "key": "sealed_court_order", "title": "Sealed copy of the restoration order", "source": "uploaded", "required": true }, { "key": "certificate_of_restoration", "title": "Certificate of restoration", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "court_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "sealed_court_order", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court of the Virgin Islands, Commercial Division", "form": "Court application under BCA s.218", "channel": "online", "government_fee": { "amount": 2400, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_time_limit_expired", "type": null, "when": "dissolution_date is more than 5 years ago; the partner confirms the current limit with counsel before rejecting." }, { "code": "applicant_not_eligible", "type": null, "when": "applicant_capacity is not one of the s.218 categories, or the applicant is the company's former registered agent." }, { "code": "liquidator_required", "type": null, "when": "dissolution_cause is a liquidation and no eligible, consenting liquidator with a costs provision was supplied (s.218A; requirement_error)." }, { "code": "entity_not_dissolved", "type": null, "when": "The entity is still on the Register; restoration cannot be started." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to swear the affidavit or sign the liquidator's consent." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on the applicant, nominated liquidator or a former director; the action pauses." }, { "code": "court_refused", "type": null, "when": "The Court dismisses the application; the action ends as rejected." } ] } }, "Params_vg_company_wind_up_insolvent": { "type": "object", "properties": { "route": { "type": "string", "enum": [ "members_resolution", "court_application" ], "description": "members_resolution: qualifying resolution under Insolvency Act s.159-. court_application: application under s.162 or s.163.", "examples": [ "members_resolution" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The eligible insolvency practitioner.", "examples": [ "per_9TqLw4vNc" ] }, "insolvency_basis": { "type": "string", "enum": [ "liabilities_exceed_assets", "unable_to_pay_debts_as_due", "both", "just_and_equitable" ], "description": "Why the liquidation is needed.", "examples": [ "both" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Members route: date of the properly constituted members' meeting at which the qualifying resolution is put.", "examples": [ "2026-11-10" ] }, "regulated_person": { "type": "boolean", "description": "True if the company is a regulated person.", "examples": [ "false" ] }, "fsc_notice_date": { "type": "string", "format": "date", "description": "Required when regulated_person is true on the members route: date written notice was or will be given to the FSC.", "examples": [ "2026-11-02" ] }, "applicant_capacity": { "type": "string", "enum": [ "company", "creditor", "member", "supervisor_of_creditors_arrangement" ], "description": "Required on the Court route.", "examples": [ "creditor" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "Required on the Court route: the individual or corporate applicant.", "examples": [ "per_1R8kXm2eZ" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for the current directors, who cooperate in the liquidation and in the statement of affairs.", "examples": [ "[\"per_5Hs2LpDa1\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Expected date of appointment.", "examples": [ "2026-11-10" ] }, "statement_of_position": { "type": "string", "description": "Short summary of assets, liabilities and creditors known to the directors; the detailed statement of affairs is a document.", "examples": [ "Liabilities of US$1.2m against assets of US$150k; two bank creditors and three trade creditors." ] } }, "required": [ "route", "liquidator", "insolvency_basis", "regulated_person", "directors", "statement_of_position" ], "description": "Starts an insolvency liquidation of a BVI company under the Insolvency Act 2003, either by a members' qualifying resolution appointing an eligible insolvency practitioner who has consented in writing, or by an application to the High." }, "Create_vg_company_wind_up_insolvent": { "type": "object", "properties": { "type": { "const": "vg.company.wind_up_insolvent" }, "params": { "$ref": "#/components/schemas/Params_vg_company_wind_up_insolvent" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an insolvency practitioner as liquidator of an insolvent BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "notice_of_meeting", "title": "Notice of members' meeting", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Qualifying resolution of members appointing the liquidator, with minutes and vote record", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Directors' resolution convening the meeting or authorising the Court application", "source": "generated", "required": true }, { "key": "liquidator_consent_to_act", "title": "Liquidator's written consent to act", "source": "generated", "required": true }, { "key": "liquidator_eligibility_evidence", "title": "Evidence of the liquidator's licence and eligibility", "source": "uploaded", "required": true }, { "key": "fsc_notice", "title": "Written notice to the FSC of the proposed resolution", "source": "generated", "required": false }, { "key": "statement_of_affairs", "title": "Statement of affairs / latest financial statements", "source": "uploaded", "required": true }, { "key": "court_application", "title": "Court application to appoint a liquidator", "source": "generated", "required": false }, { "key": "supporting_affidavit", "title": "Supporting affidavit", "source": "uploaded", "required": false }, { "key": "sealed_court_order", "title": "Sealed order appointing the liquidator", "source": "uploaded", "required": false }, { "key": "notice_of_appointment", "title": "Notice of appointment of liquidator", "source": "generated", "required": true }, { "key": "advertisement_proof", "title": "Proof of advertisement of the appointment", "source": "uploaded", "required": true }, { "key": "creditors_meeting_notice", "title": "Notice of first creditors' meeting", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "notice_of_meeting", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fsc_notice", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "court_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "notice_of_appointment", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs via VIRRGIN", "form": "Qualifying resolution and notice of appointment of liquidator", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "foreign_company_court_route_only", "type": null, "when": "route is members_resolution for a foreign_company; any such resolution is void (s.159; requirement_error)." }, { "code": "fsc_notice_missing", "type": null, "when": "regulated_person is true and the FSC was not given at least 5 business days' notice or an agreed shorter period; the resolution would be void (s.159-; requirement_error)." }, { "code": "liquidator_not_eligible", "type": null, "when": "The proposed liquidator is not an eligible insolvency practitioner, or is the Official Receiver on the members route (s.161; requirement_error)." }, { "code": "liquidator_consent_missing", "type": null, "when": "The proposed liquidator has not consented in writing (s.161; requirement_error)." }, { "code": "appointment_blocked", "type": null, "when": "A Court application is filed and unresolved, or the Court has already appointed a liquidator, so members cannot appoint (s.161-; requirement_error)." }, { "code": "resolution_threshold_not_met", "type": null, "when": "The recorded votes do not reach 75% of members present and entitled to vote." }, { "code": "member_leave_required", "type": null, "when": "A member applies on the Court route without leave and a prima facie case of insolvency (s.162; requirement_error)." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to swear the affidavit or give the liquidator's consent." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a person in the action." } ] } }, "Params_vg_dormancy_record": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp" ], "description": "Entity type of the entity being recorded as dormant.", "examples": [ "bc_ltd_shares" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the entity has had no trading or other business activity.", "examples": [ "2026-09-30" ] }, "reason": { "type": "string", "description": "Why the entity is inactive.", "examples": [ "Holding structure wound down; no assets or activity." ] }, "intended_outcome": { "type": "string", "enum": [ "remain_dormant", "voluntary_liquidation", "undecided" ], "description": "What the directors intend next. 'voluntary_liquidation' makes Entiva propose a vg.liquidation.commence action.", "examples": [ "remain_dormant" ] }, "review_date": { "type": "string", "format": "date", "description": "Date on which Entiva reminds the customer to revisit the decision.", "examples": [ "2027-09-30" ] }, "relevant_activities_conducted": { "type": "array", "items": {}, "description": "Economic substance relevant activities the entity conducted in the last financial period, as a list of strings.", "examples": [ "[]" ] }, "financial_year_end": { "type": "string", "format": "date", "description": "Financial year end, used to schedule the annual financial return.", "examples": [ "2026-12-31" ] }, "acknowledge_continuing_obligations": { "type": "boolean", "description": "Must be true.", "examples": [ "true" ] } }, "required": [ "entity_type", "effective_date", "reason", "intended_outcome", "acknowledge_continuing_obligations" ], "description": "The BVI has no dormant-company status and no dormancy filing. This action is an Entiva record only: it flags the entity as inactive, captures the board's intent and publishes the obligations that continue anyway: registered agent, annual." }, "Create_vg_dormancy_record": { "type": "object", "properties": { "type": { "const": "vg.dormancy.record" }, "params": { "$ref": "#/components/schemas/Params_vg_dormancy_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a BVI entity as dormant", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Directors' note of dormancy", "source": "generated", "required": false }, { "key": "dormancy_summary", "title": "Continuing obligations and deadlines summary", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dormancy_summary", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. The BVI has no dormancy filing", "form": "None", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity type is not one of the listed types." }, { "code": "acknowledgement_required", "type": null, "when": "acknowledge_continuing_obligations is false." }, { "code": "entity_not_active", "type": null, "when": "The entity is already struck off, dissolved or in liquidation." }, { "code": "liquidation_in_progress", "type": null, "when": "A voluntary liquidation is open for the entity." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a related person pauses live actions." } ] } }, "Params_vg_foreign_company_deregister": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "foreign_company" ], "description": "Entity type.", "examples": [ "foreign_company" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the foreign company ceased to carry on business in the BVI.", "examples": [ "2026-10-14" ] }, "reason": { "type": "string", "description": "Why BVI business ceased.", "examples": [ "Branch operations transferred to a local affiliate." ] }, "bvi_business_ceased_confirmed": { "type": "boolean", "description": "An authorised officer confirms the company no longer carries on business in the BVI.", "examples": [ "true" ] }, "bvi_obligations_settled": { "type": "boolean", "description": "Confirms that BVI liabilities, fees and service-of-process arrangements were dealt with.", "examples": [ "true" ] }, "authorised_representative": { "type": "string", "pattern": "^per_", "description": "The officer of the foreign company who gives the instruction.", "examples": [ "per_test_2Fc7" ] }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 country code of the foreign company's place of incorporation.", "examples": [ "SG" ] } }, "required": [ "entity_type", "effective_date", "reason", "bvi_business_ceased_confirmed", "bvi_obligations_settled", "authorised_representative" ], "description": "A foreign company registered to carry on business in the BVI files a notice in the approved form within 7 days of ceasing business. The Registrar removes it from the Register of Foreign Companies and the registered agent's appointment ends." }, "Create_vg_foreign_company_deregister": { "type": "object", "properties": { "type": { "const": "vg.foreign_company.deregister" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_deregister" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notice that a foreign company has ceased to carry on business in the BVI", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "notice_of_cessation", "title": "Notice of cessation of business in the BVI", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution or evidence of authority of the foreign company", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN receipt", "source": "registry_issued", "required": true }, { "key": "deregistration_confirmation", "title": "Registrar's confirmation of removal from the Register of Foreign Companies", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "notice_of_cessation", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "notice_of_cessation", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Notice of cessation of business", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not a registered foreign company." }, { "code": "seven_day_deadline_missed", "type": null, "when": "effective_date is more than 7 days ago." }, { "code": "business_not_ceased", "type": null, "when": "bvi_business_ceased_confirmed is false." }, { "code": "authority_not_evidenced", "type": null, "when": "The instructing person is not a director and no resolution or mandate is on file." }, { "code": "outstanding_fees", "type": null, "when": "Annual fees or penalties are unpaid for the foreign company registration." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live actions." } ] } }, "Params_vg_foreign_company_restore": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "Date the foreign company was removed from the Register of Foreign Companies.", "examples": [ "2025-11-04" ] }, "removal_reason": { "type": "string", "description": "Why the Registrar removed the company, if known.", "examples": [ "Annual fee unpaid for 2024" ] }, "traded_while_removed": { "type": "boolean", "description": "True if the company carried on business in the BVI while removed.", "examples": [ "false" ] }, "name": { "type": "string", "description": "Registered name of the foreign company, as it was on the BVI register.", "examples": [ "Aurelia Trading Holdings Ltd" ] }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 country code of the law under which the company is incorporated.", "examples": [ "SG" ] }, "home_registration_number": { "type": "string", "description": "Company number on its home register.", "examples": [ "201912345K" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for the foreign company's directors or equivalent officers.", "examples": [ "[\"per_3Xn6DkRa9\", \"per_8Gt1LsPw4\"]" ] }, "authorised_signatory": { "type": "string", "pattern": "^per_", "description": "The director or officer who authorises the re-registration and signs for the company.", "examples": [ "per_3Xn6DkRa9" ] }, "registered_agent": { "type": "string", "enum": [ "entiva_partner", "other" ], "description": "BVI registered agent that will file and act.", "examples": [ "entiva_partner" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "BVI registered office address, normally the partner's office.", "examples": [ "{\"line1\": \"Partner registered office, Road Town\", \"country\": \"VG\"}" ] }, "outstanding_fees_acknowledged": { "type": "boolean", "description": "The company accepts that all fees and penalties due at removal, plus back fees and penalties if it traded while removed, must be paid before re-registration.", "examples": [ "true" ] } }, "required": [ "effective_date", "traded_while_removed", "name", "home_jurisdiction", "home_registration_number", "directors", "authorised_signatory", "registered_agent", "outstanding_fees_acknowledged" ], "description": "Re-registers a foreign company that was removed from the Register of Foreign Companies, by a new application for registration under BCA s.186 filed by the registered agent. The application must be made within 5 years of removal, all fees." }, "Create_vg_foreign_company_restore": { "type": "object", "properties": { "type": { "const": "vg.foreign_company.restore" }, "params": { "$ref": "#/components/schemas/Params_vg_foreign_company_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Re-register a foreign company removed from the BVI Register of Foreign Companies", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registration_application", "title": "Application for registration of a foreign company", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Certified copy of certificate of incorporation or registration from the home registry", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Constitution of the foreign company", "source": "uploaded", "required": true }, { "key": "home_good_standing_certificate", "title": "Certificate of good standing from the home registry", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified translation of any non-English document", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Resolution of the foreign company authorising re-registration", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "outstanding_fees_statement", "title": "Statement of fees and penalties due", "source": "registry_issued", "required": true }, { "key": "certificate_of_registration", "title": "Certificate of registration of the foreign company", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "registration_application", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certified_translation", "signer_role": "translator", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "registration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "New application for registration of a foreign company under BCA s.186, treated as re-regis", "channel": "online", "government_fee": { "amount": 550, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "reregistration_period_expired", "type": null, "when": "More than 5 years have passed since removal." }, { "code": "outstanding_fees_unpaid", "type": null, "when": "Fees and penalties due at removal, or back fees after trading while removed, were not settled." }, { "code": "home_standing_missing", "type": null, "when": "The home registry shows the company as dissolved or not in good standing, so the foreign company cannot be re-registered." }, { "code": "name_unavailable", "type": null, "when": "The Registry rejects the name because it is no longer available." }, { "code": "translation_not_certified", "type": null, "when": "A non-English document lacks a reg 29 certified translation." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to complete a human_only_electronic signature." } ] } }, "Params_vg_general_partnership_dissolve": { "type": "object", "properties": { "dissolution_ground": { "type": "string", "enum": [ "expiry_of_term", "completion_of_undertaking", "notice_by_partner", "death_or_bankruptcy_of_partner", "charged_share", "illegality", "court_decree", "agreement_of_partners" ], "description": "The event dissolving the partnership. expiry_of_term and completion_of_undertaking: s.34-. notice_by_partner: s.34, for a partnership of undefined duration..", "examples": [ "notice_by_partner" ] }, "dissolution_date": { "type": "string", "format": "date", "description": "Date from which the partnership is dissolved.", "examples": [ "2026-12-31" ] }, "partners": { "type": "array", "items": {}, "description": "Array of person_ref for every partner at the date of the dissolution event, individual or corporate.", "examples": [ "[\"per_2Qa9WmTe5\", \"per_6Vh3YkNd1\"]" ] }, "notifying_partner": { "type": "string", "pattern": "^per_", "description": "Required for notice_by_partner: the partner giving notice.", "examples": [ "per_2Qa9WmTe5" ] }, "court_order_reference": { "type": "string", "description": "Required for court_decree: the Court's order reference.", "examples": [ "BVIHC (COM) 0123 of 2026" ] }, "event_partner": { "type": "string", "pattern": "^per_", "description": "For death_or_bankruptcy_of_partner and charged_share: the partner concerned, or the personal representative or trustee.", "examples": [ "per_6Vh3YkNd1" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Optional person the partners authorise to wind up the affairs.", "examples": [ "per_2Qa9WmTe5" ] }, "public_notice": { "type": "boolean", "description": "If true, Entiva prepares a public notification of the dissolution that any partner may publish and asks the other partners to concur in any necessary acts.", "examples": [ "true" ] }, "settlement_plan": { "type": "object", "description": "How accounts will be settled under s.46: losses paid from profits, then capital, then by the partners individually in profit-sharing proportions; assets.", "examples": [ "{\"debts_paid_confirmed\": true, \"distribution_currency\": \"USD\", \"distributions\": [{\"partner\": \"per_2Qa9WmTe5\", \"amount\": 40000}, {\"partner\": \"per_6Vh3YkNd1\", \"amount\": 40000}]}" ] }, "trade_licence_number": { "type": "string", "description": "Trade licence number if the firm held one, so Entiva can prepare the cancellation request to the Department of Trade.", "examples": [ "TL-009812" ] } }, "required": [ "dissolution_ground", "dissolution_date", "partners" ], "description": "Records the dissolution of a general partnership under the Partnership Act 1996 and manages its winding up: the dissolution event, the notice to the other partners, optional public notification, continuing authority to wind up, and the." }, "Create_vg_general_partnership_dissolve": { "type": "object", "properties": { "type": { "const": "vg.general_partnership.dissolve" }, "params": { "$ref": "#/components/schemas/Params_vg_general_partnership_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve and wind up a BVI general partnership", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "dissolution_notice", "title": "Notice of dissolution to the partners", "source": "generated", "required": true }, { "key": "dissolution_agreement", "title": "Dissolution and winding-up agreement", "source": "generated", "required": false }, { "key": "public_notice", "title": "Public notification of dissolution", "source": "generated", "required": false }, { "key": "court_order", "title": "Court order decreeing dissolution", "source": "uploaded", "required": false }, { "key": "final_account_statement", "title": "Final account and distribution statement", "source": "generated", "required": true }, { "key": "trade_licence_cancellation", "title": "Trade licence cancellation request", "source": "generated", "required": false }, { "key": "closure_record", "title": "Entiva closure record", "source": "generated", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "liquidator", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "any_one", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "dissolution_notice", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "dissolution_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "final_account_statement", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "public_notice", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. The Partnership Act 1996 requires no Registry filing", "form": "Notice of dissolution to partners", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "dissolution_ground_not_supported", "type": null, "when": "notice_by_partner is chosen for a partnership entered into for a fixed term or single undertaking, where the agreement does not allow notice." }, { "code": "continuation_vote_recorded", "type": null, "when": "After a death or bankruptcy, all remaining partners voted within 90 days to continue; dissolution does not occur." }, { "code": "partner_approval_missing", "type": null, "when": "Not every partner has approved the final account where unanimity applies." }, { "code": "liabilities_outstanding", "type": null, "when": "Settlement plan shows debts to outside creditors not provided for." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to give a partner's notice or approval." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a partner receiving a distribution." } ] } }, "Params_vg_limited_partnership_restore": { "type": "object", "properties": { "applicant_capacity": { "type": "string", "enum": [ "lp", "creditor", "partner", "liquidator" ], "description": "Who applies.", "examples": [ "lp" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "The individual instructing Entiva.", "examples": [ "per_4Lk8ZtQw2" ] }, "struck_off_date": { "type": "string", "format": "date", "description": "Date the limited partnership was struck off the Register.", "examples": [ "2025-06-30" ] }, "gazette_notice_date": { "type": "string", "format": "date", "description": "Date of the Gazette notice of strike-off.", "examples": [ "2025-07-10" ] }, "strike_off_reason": { "type": "string", "enum": [ "no_registered_agent", "failure_to_file", "ceased_business", "other" ], "description": "Reason the Registrar struck the partnership off, if known.", "examples": [ "failure_to_file" ] }, "general_partners": { "type": "array", "items": {}, "description": "Array of person_ref.", "examples": [ "[\"per_7Wc1NmHa3\"]" ] }, "limited_partners": { "type": "array", "items": {}, "description": "Array of person_ref.", "examples": [ "[\"per_2Yd5JsBx6\"]" ] }, "registered_agent": { "type": "string", "enum": [ "entiva_partner", "other" ], "description": "Who will be registered agent.", "examples": [ "entiva_partner" ] }, "reason_for_restoration": { "type": "string", "description": "Why restoration is fair and reasonable; the Registrar must be satisfied of this.", "examples": [ "The partnership still holds fund assets and a pending investor distribution." ] }, "outstanding_fees_acknowledged": { "type": "boolean", "description": "The applicant accepts that all outstanding fees and penalties must be paid with the restoration fee (s.99).", "examples": [ "true" ] } }, "required": [ "applicant_capacity", "applicant", "struck_off_date", "gazette_notice_date", "general_partners", "limited_partners", "registered_agent", "reason_for_restoration", "outstanding_fees_acknowledged" ], "description": "Applies to the Registrar of Limited Partnerships to restore a limited partnership that has been struck off the Register but not de-registered. The Registrar needs the application in approved form, the restoration fee and all outstanding." }, "Create_vg_limited_partnership_restore": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.restore" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a struck-off BVI limited partnership through the Registrar", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restoration_application", "title": "Application to restore the limited partnership", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "partnership_agreement", "title": "Partnership agreement", "source": "uploaded", "required": true }, { "key": "partners_resolution", "title": "Resolution of the general partners authorising restoration", "source": "generated", "required": true }, { "key": "outstanding_fees_statement", "title": "Statement of outstanding fees and penalties", "source": "registry_issued", "required": true }, { "key": "kyb_pack", "title": "KYB pack for any corporate general or limited partner", "source": "uploaded", "required": false }, { "key": "certificate_of_restoration", "title": "Certificate of restoration", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "restoration_application", "signer_role": "applicant", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "restoration_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Application for restoration of a limited partnership in the approved form", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_period_expired", "type": null, "when": "More than 5 years have passed since the Gazette notice; confirm the current limit with counsel." }, { "code": "partnership_deregistered", "type": null, "when": "The partnership has been de-registered; the Registrar route is closed and the action must be created as vg.limited_partnership.restore_by_court." }, { "code": "partners_missing", "type": null, "when": "No general partner or no limited partner is listed (s.99; requirement_error)." }, { "code": "outstanding_fees_unpaid", "type": null, "when": "Outstanding fees or penalties were not settled with the restoration fee." }, { "code": "registered_agent_missing", "type": null, "when": "No licensed person has agreed to act as registered agent." }, { "code": "registrar_refused", "type": null, "when": "The Registrar refuses restoration; the action is rejected and a Court appeal within 90 days is offered." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to complete a human_only_electronic signature." } ] } }, "Params_vg_limited_partnership_restore_by_court": { "type": "object", "properties": { "court_route": { "type": "string", "enum": [ "appeal_registrar_refusal", "declare_deregistration_void", "restore_deregistered" ], "description": "appeal_registrar_refusal: appeal within 90 days of a Registrar refusal (s.99). declare_deregistration_void: s.100. restore_deregistered: application under.", "examples": [ "restore_deregistered" ] }, "applicant_capacity": { "type": "string", "enum": [ "lp", "creditor", "partner", "former_partner", "liquidator", "former_liquidator", "interested_person" ], "description": "Standing of the applicant. s.100 and s.99: the partnership, a creditor, partner or liquidator. s.101: a creditor, former partner or former liquidator, or.", "examples": [ "former_partner" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "Individual or corporate applicant.", "examples": [ "per_4Lk8ZtQw2" ] }, "struck_off_date": { "type": "string", "format": "date", "description": "Date the partnership was struck off.", "examples": [ "2025-06-30" ] }, "deregistration_date": { "type": "string", "format": "date", "description": "Date of de-registration, where applicable.", "examples": [ "2026-07-01" ] }, "registrar_refusal_date": { "type": "string", "format": "date", "description": "Required for appeal_registrar_refusal; the 90-day appeal period runs from it.", "examples": [ "2026-09-20" ] }, "strike_off_followed_liquidation": { "type": "boolean", "description": "True if the partnership was de-registered after completion or termination of an Insolvency Act liquidation.", "examples": [ "false" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Required when strike_off_followed_liquidation is true: the nominated liquidator, who must consent and be eligible.", "examples": [ "per_9TqLw4vNc" ] }, "liquidator_costs_provision": { "$ref": "#/components/schemas/Money", "description": "Provision for the liquidator's expenses and remuneration (s.102).", "examples": [ "{\"amount\": 12000, \"currency\": \"USD\"}" ] }, "general_partners": { "type": "array", "items": {}, "description": "Array of person_ref for the general partners the partnership will have on restoration.", "examples": [ "[\"per_7Wc1NmHa3\"]" ] }, "limited_partners": { "type": "array", "items": {}, "description": "Array of person_ref for the limited partners on restoration.", "examples": [ "[\"per_2Yd5JsBx6\"]" ] }, "purpose_detail": { "type": "string", "description": "Why restoration is needed and any conditions proposed; used for the application and affidavit.", "examples": [ "Recover a receivable owed to the partnership before the limitation period ends." ] }, "registered_agent": { "type": "string", "enum": [ "entiva_partner", "other" ], "description": "Registered agent to be appointed immediately on restoration.", "examples": [ "entiva_partner" ] } }, "required": [ "court_route", "applicant_capacity", "applicant", "struck_off_date", "strike_off_followed_liquidation", "general_partners", "limited_partners", "purpose_detail", "registered_agent" ], "description": "Applies to the High Court to restore a limited partnership to the Register where the Registrar route is closed or has failed: an appeal against the Registrar's refusal to restore, a declaration that de-registration was void, or restoration." }, "Create_vg_limited_partnership_restore_by_court": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.restore_by_court" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_restore_by_court" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Restore a BVI limited partnership by Court order", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "court_application", "title": "Court application to restore the limited partnership", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Supporting affidavit of the applicant", "source": "uploaded", "required": true }, { "key": "evidence_of_interest", "title": "Evidence of the applicant's standing", "source": "uploaded", "required": true }, { "key": "registrar_refusal_letter", "title": "Registrar's refusal", "source": "registry_issued", "required": false }, { "key": "notice_of_application", "title": "Notice of application for service", "source": "generated", "required": true }, { "key": "proof_of_service", "title": "Proof of service", "source": "uploaded", "required": true }, { "key": "liquidator_consent_to_act", "title": "Nominated liquidator's written consent", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Registered agent's consent to act", "source": "generated", "required": true }, { "key": "sealed_court_order", "title": "Sealed restoration order", "source": "uploaded", "required": true }, { "key": "certificate_of_restoration", "title": "Certificate of restoration", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "court_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "sealed_court_order", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court, Commercial Division", "form": "Court application", "channel": "online", "government_fee": { "amount": 2500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_time_limit_expired", "type": null, "when": "The relevant time limit has passed." }, { "code": "applicant_not_eligible", "type": null, "when": "applicant_capacity does not fit the chosen court_route." }, { "code": "liquidator_required", "type": null, "when": "strike_off_followed_liquidation is true and no eligible, consenting liquidator with a costs provision is supplied (s.102; requirement_error)." }, { "code": "partners_missing", "type": null, "when": "No general or no limited partner listed for the restored partnership." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to swear the affidavit or sign the liquidator's consent." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a person in the action." }, { "code": "court_refused", "type": null, "when": "The Court dismisses the application; the action is rejected." } ] } }, "Params_vg_limited_partnership_strike_off": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "Entity type.", "examples": [ "lp" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date on which the partnership was terminated.", "examples": [ "2026-08-31" ] }, "general_partners": { "type": "array", "items": {}, "description": "All general partners, as person references.", "examples": [ "[\"per_test_5Gp1\"]" ] }, "no_assets_confirmed": { "type": "boolean", "description": "The general partners confirm the LP has no assets.", "examples": [ "true" ] }, "no_liabilities_confirmed": { "type": "boolean", "description": "The general partners confirm the LP has no liabilities.", "examples": [ "true" ] }, "liquidation_completed": { "type": "boolean", "description": "True once winding up is finished and final accounts and report were given to the partners and the registered agent.", "examples": [ "true" ] }, "final_accounts_date": { "type": "string", "format": "date", "description": "Date of the final accounts delivered to partners.", "examples": [ "2026-09-15" ] }, "reason": { "type": "string", "description": "Free-text background.", "examples": [ "Fund fully distributed and wound up." ] } }, "required": [ "entity_type", "effective_date", "general_partners", "no_assets_confirmed", "no_liabilities_confirmed", "liquidation_completed" ], "description": "After termination and winding up, the general partners apply through the registered agent to strike off a limited partnership that has no assets and no liabilities. De-registration takes effect on strike-off." }, "Create_vg_limited_partnership_strike_off": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.strike_off" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_strike_off" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Strike-off of a terminated BVI limited partnership on its own application (LPA s.95, s.88)", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "strike_off_application", "title": "Application to strike off the limited partnership", "source": "generated", "required": true }, { "key": "partners_resolution", "title": "Termination resolution or evidence of termination event", "source": "uploaded", "required": true }, { "key": "final_accounts", "title": "Final accounts and winding-up report", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN receipt", "source": "registry_issued", "required": true }, { "key": "strike_off_confirmation", "title": "Registrar's confirmation of strike-off", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "strike_off_application", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "strike_off_application", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Application to strike off a limited partnership", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "lp_not_terminated", "type": null, "when": "No termination event or resolution is on record for the LP." }, { "code": "lp_has_assets_or_liabilities", "type": null, "when": "A confirmation is false or the final accounts show assets or liabilities." }, { "code": "winding_up_not_complete", "type": null, "when": "vg.limited_partnership.wind_up is still open, or liquidation_completed is false." }, { "code": "general_partner_signature_missing", "type": null, "when": "Not every general partner has signed." }, { "code": "outstanding_fees", "type": null, "when": "Annual fees or penalties are unpaid on the partnership." }, { "code": "lp_insolvent", "type": null, "when": "The LP is insolvent; it goes to the Official Receiver under the Insolvency Act, not this route." } ] } }, "Params_vg_limited_partnership_wind_up": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "lp" ], "description": "Entity type.", "examples": [ "lp" ] }, "termination_event": { "type": "string", "enum": [ "lpa_event", "partners_resolution" ], "description": "How the LP terminated.", "examples": [ "partners_resolution" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of termination.", "examples": [ "2026-10-20" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the termination resolution, if that was the route.", "examples": [ "2026-10-20" ] }, "general_partners": { "type": "array", "items": {}, "description": "All general partners, as person references.", "examples": [ "[\"per_test_5Gp1\"]" ] }, "solvency_resolution_date": { "type": "string", "format": "date", "description": "Date of the general partners' solvency resolution.", "examples": [ "2026-10-21" ] }, "statement_date": { "type": "string", "format": "date", "description": "Date of the statement of assets and liabilities; no earlier than 7 days before the solvency resolution.", "examples": [ "2026-10-17" ] }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Total assets in the statement.", "examples": [ "USD 800000" ] }, "total_liabilities": { "$ref": "#/components/schemas/Money", "description": "Total liabilities in the statement.", "examples": [ "USD 20000" ] }, "winding_up_by": { "type": "string", "enum": [ "general_partners", "liquidator" ], "description": "Who winds up the affairs: the general partners, or an appointed liquidator.", "examples": [ "liquidator" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Required when winding_up_by is liquidator.", "examples": [ "per_test_7Lq4" ] }, "advertisement": { "type": "object", "description": "Advertisement of the liquidator's appointment: {newspaper, publication_date}.", "examples": [ "{\"newspaper\":\"BVI Beacon\",\"publication_date\":\"2026-10-26\"}" ] }, "reason": { "type": "string", "description": "Reason for termination.", "examples": [ "Fund term expired." ] } }, "required": [ "entity_type", "termination_event", "effective_date", "general_partners", "solvency_resolution_date", "statement_date", "total_assets", "total_liabilities", "winding_up_by" ], "description": "The LP terminates on an event in the partnership agreement or on a resolution passed by all general partners plus limited partners who contributed more than 50% of capital. The general partners then pass a solvency resolution with a." }, "Create_vg_limited_partnership_wind_up": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.wind_up" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_wind_up" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Terminate and wind up a solvent BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "partners_resolution", "title": "Termination resolution of the partners", "source": "generated", "required": false }, { "key": "solvency_resolution", "title": "General partners' solvency resolution", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "consent_to_act", "title": "Liquidator's consent to act", "source": "generated", "required": false }, { "key": "liquidator_qualification_evidence", "title": "Evidence of liquidator eligibility", "source": "uploaded", "required": false }, { "key": "notice_of_appointment", "title": "Notice of appointment of liquidator", "source": "generated", "required": false }, { "key": "advertisement_proof", "title": "Proof of advertisement", "source": "uploaded", "required": false }, { "key": "final_accounts", "title": "Final records, accounts and report", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "solvency_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "limited_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_appointment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Notice of appointment of liquidator of a limited partnership", "channel": "online", "government_fee": { "amount": 150, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity is not an lp." }, { "code": "lp_insolvent", "type": null, "when": "Liabilities exceed assets or a general partner cannot pass the solvency resolution; the Official Receiver route applies." }, { "code": "statement_stale", "type": null, "when": "statement_date is more than 7 days before the solvency resolution." }, { "code": "liquidator_required", "type": null, "when": "winding_up_by is liquidator and no liquidator is given." }, { "code": "liquidator_ineligible", "type": null, "when": "The liquidator fails the reg 12 test." }, { "code": "termination_vote_not_met", "type": null, "when": "The resolution lacks all general partners or limited partners with over 50% of capital." }, { "code": "liquidator_acted_before_notice", "type": null, "when": "A liquidator has acted before the notice was filed (reg 13)." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live actions." } ] } }, "Params_vg_limited_partnership_wind_up_insolvent": { "type": "object", "properties": { "ground": { "type": "string", "enum": [ "terminated_not_being_wound_up", "insolvent", "just_and_equitable" ], "description": "Ground under s.93-.", "examples": [ "insolvent" ] }, "applicant_capacity": { "type": "string", "enum": [ "partner", "creditor", "registered_agent_no_general_partner" ], "description": "Standing of the applicant under s.93.", "examples": [ "creditor" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "Individual or corporate applicant.", "examples": [ "per_1R8kXm2eZ" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The eligible insolvency practitioner proposed to the Court.", "examples": [ "per_9TqLw4vNc" ] }, "insolvency_notice_action": { "type": "string", "description": "Reference to a completed vg.limited_partnership.report_insolvency action, if notice has already been given.", "examples": [ "act_8RtZ1jUm9" ] }, "has_legal_personality": { "type": "boolean", "description": "Whether the partnership has legal personality.", "examples": [ "true" ] }, "oppression_claim": { "type": "string", "description": "For a partner relying on the just and equitable ground: the oppressive, unfairly discriminatory or prejudicial conduct alleged (s.93).", "examples": [ "Distributions withheld from limited partners while the general partner drew fees." ] }, "general_partners": { "type": "array", "items": {}, "description": "Array of person_ref for the current general partners who will be served and verified.", "examples": [ "[\"per_7Wc1NmHa3\"]" ] } }, "required": [ "ground", "applicant_capacity", "applicant", "liquidator", "has_legal_personality" ], "description": "Applies to the High Court under LPA s.93 to appoint the Official Receiver or an eligible insolvency practitioner as liquidator of a limited partnership because it has terminated but is not being wound up, is insolvent, or it is just and." }, "Create_vg_limited_partnership_wind_up_insolvent": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership.wind_up_insolvent" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_wind_up_insolvent" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply to the Court to appoint a liquidator of a BVI limited partnership", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "court_application", "title": "Court application to appoint a liquidator", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Supporting affidavit of the applicant", "source": "uploaded", "required": true }, { "key": "evidence_of_insolvency", "title": "Evidence of insolvency or other ground", "source": "uploaded", "required": true }, { "key": "liquidator_consent_to_act", "title": "Proposed liquidator's written consent", "source": "generated", "required": true }, { "key": "liquidator_eligibility_evidence", "title": "Evidence of the liquidator's licence and eligibility", "source": "uploaded", "required": true }, { "key": "partners_resolution", "title": "Resolution authorising the application", "source": "generated", "required": false }, { "key": "sealed_court_order", "title": "Sealed order appointing the liquidator", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN receipt for any resulting liquidator filing", "source": "registry_issued", "required": false } ], "people": [ { "role": "registered_agent", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "enhanced" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "liquidator_consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court of the Virgin Islands, Commercial Division", "form": "Court application under LPA s.93", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "applicant_not_eligible", "type": null, "when": "The applicant is not a partner, creditor or the registered agent." }, { "code": "ground_not_available", "type": null, "when": "The public interest ground is requested by a customer." }, { "code": "liquidator_not_eligible", "type": null, "when": "The proposed liquidator is not an eligible insolvency practitioner." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to swear the affidavit or give the liquidator's consent." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a person in the action." }, { "code": "court_refused", "type": null, "when": "The Court dismisses the application; the action is rejected." } ] } }, "Params_vg_limited_partnership_insolvency_file": { "type": "object", "properties": { "notifier_capacity": { "type": "string", "enum": [ "general_partner", "liquidator" ], "description": "Who forms the opinion and gives notice: the general partners winding up the partnership, or the liquidator if one has been appointed (s.92).", "examples": [ "general_partner" ] }, "general_partners": { "type": "array", "items": {}, "description": "Array of person_ref for the general partners at the date of the opinion; each signs, or the corporate general partner signs through an authorised director.", "examples": [ "[\"per_7Wc1NmHa3\"]" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Required when notifier_capacity is liquidator.", "examples": [ "per_9TqLw4vNc" ] }, "opinion_date": { "type": "string", "format": "date", "description": "Date the opinion of insolvency was formed.", "examples": [ "2026-10-15" ] }, "insolvency_basis": { "type": "string", "enum": [ "assets_less_than_liabilities", "unable_to_pay_debts_as_due", "both" ], "description": "Test under s.87-: the partnership is insolvent if its assets are less than its debts and liabilities, or it cannot pay its debts, excluding liabilities to.", "examples": [ "assets_less_than_liabilities" ] }, "winding_up_commenced": { "type": "boolean", "description": "True if the general partners had already begun winding up under the Act; Entiva halts the solvent winding-up steps.", "examples": [ "true" ] }, "statement_of_position": { "type": "string", "description": "Summary of assets, liabilities and creditors on which the opinion is based.", "examples": [ "Fund investments written down; creditor claims exceed remaining assets." ] } }, "required": [ "notifier_capacity", "general_partners", "opinion_date", "insolvency_basis", "winding_up_commenced", "statement_of_position" ], "description": "If the general partners winding up a limited partnership, or its liquidator, form the opinion that it is insolvent, they must forthwith send a written notice to the Official Receiver (LPA s.92). Failing to notify is an offence with a fine." }, "Create_vg_limited_partnership_insolvency_file": { "type": "object", "properties": { "type": { "const": "vg.limited_partnership_insolvency.file" }, "params": { "$ref": "#/components/schemas/Params_vg_limited_partnership_insolvency_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report the insolvency of a BVI limited partnership to the Official Receiver", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "lp", "lp_without_legal_personality" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "insolvency_notice", "title": "Written notice of insolvency to the Official Receiver", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "partners_resolution", "title": "Resolution of the general partners recording the opinion", "source": "generated", "required": true }, { "key": "official_receiver_acknowledgement", "title": "Official Receiver acknowledgement", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "enhanced" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "general_partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "insolvency_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Official Receiver", "form": "Written notice to the Official Receiver", "channel": "both", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "opinion_date_in_future", "type": null, "when": "opinion_date is after today." }, { "code": "notifier_not_authorised", "type": null, "when": "The notifier is neither a general partner nor the liquidator." }, { "code": "solvent_winding_up_in_progress", "type": null, "when": "A solvency resolution or solvent distribution is pending; Entiva blocks it once insolvency is reported." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to sign the opinion or notice." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a general partner." } ] } }, "Params_vg_liquidation_commence": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type.", "examples": [ "bc_ltd_shares" ] }, "liquidators": { "type": "array", "items": {}, "description": "One or more liquidators as person references.", "examples": [ "[\"per_test_7Lq4\"]" ] }, "directors": { "type": "array", "items": {}, "description": "All current directors, as person references.", "examples": [ "[\"per_test_9Lm2\",\"per_test_3Dn6\"]" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the resolution appointing the liquidator.", "examples": [ "2026-10-20" ] }, "appointment_resolution_type": { "type": "string", "enum": [ "members", "directors" ], "description": "Who appoints the liquidator: the members, or the directors where the articles permit.", "examples": [ "members" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the liquidation takes effect if later than resolution_date.", "examples": [ "2026-10-20" ] }, "declaration_of_solvency_date": { "type": "string", "format": "date", "description": "Date the directors made the declaration.", "examples": [ "2026-10-14" ] }, "liquidation_plan_approval_date": { "type": "string", "format": "date", "description": "Date the directors approved the plan.", "examples": [ "2026-10-14" ] }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Total assets in the attached statement of assets and liabilities.", "examples": [ "USD 52000" ] }, "total_liabilities": { "$ref": "#/components/schemas/Money", "description": "Total liabilities in the statement.", "examples": [ "USD 4000" ] }, "liquidation_plan": { "type": "object", "description": "Plan summary: {realisation_method, distribution_to_members, expected_duration_months, creditors_paid_in_full}.", "examples": [ "{\"realisation_method\":\"Sale of investments\",\"distribution_to_members\":\"Pro rata in cash\",\"expected_duration_months\":6,\"creditors_paid_in_full\":true}" ] }, "regulated_person": { "type": "boolean", "description": "True if the company is a bank, Class I-III trust licensee, company manager, category A or C insurer, insurance intermediary or manager, or money services.", "examples": [ "false" ] }, "fsc_consent_reference": { "type": "string", "description": "FSC consent reference for regulated persons.", "examples": [ "FSC-2026-0412" ] }, "advertisement": { "type": "object", "description": "Advertisement plan: {newspaper, foreign_places_of_business[]}.", "examples": [ "{\"newspaper\":\"BVI Beacon\",\"foreign_places_of_business\":[]}" ] }, "reason": { "type": "string", "description": "Reason for liquidation.", "examples": [ "Structure no longer needed." ] } }, "required": [ "entity_type", "liquidators", "directors", "resolution_date", "appointment_resolution_type", "declaration_of_solvency_date", "liquidation_plan_approval_date", "total_assets", "total_liabilities", "liquidation_plan" ], "description": "Covers steps 1 to 5 of the process: the directors' declaration of solvency, approval of a liquidation plan, the resolution appointing an eligible liquidator, and filing of the notice of appointment with the declaration of solvency and the." }, "Create_vg_liquidation_commence": { "type": "object", "properties": { "type": { "const": "vg.liquidation.commence" }, "params": { "$ref": "#/components/schemas/Params_vg_liquidation_commence" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Start a solvent voluntary liquidation of a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "declaration_of_solvency", "title": "Directors' declaration of solvency", "source": "generated", "required": true }, { "key": "statement_of_assets_and_liabilities", "title": "Statement of assets and liabilities", "source": "uploaded", "required": true }, { "key": "liquidation_plan", "title": "Liquidation plan", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Directors' resolution approving the liquidation plan and declaration of solvency", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' resolution appointing the liquidator", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Liquidator's consent to act", "source": "generated", "required": true }, { "key": "liquidator_qualification_evidence", "title": "Evidence of liquidator eligibility", "source": "uploaded", "required": true }, { "key": "notice_of_appointment", "title": "Notice of appointment of voluntary liquidator", "source": "generated", "required": true }, { "key": "certified_extract_of_declaration", "title": "Registered agent's certified extract of the declaration of solvency", "source": "generated", "required": false }, { "key": "fsc_consent", "title": "FSC consent and liquidator approval", "source": "registry_issued", "required": false }, { "key": "registry_receipt", "title": "VIRRGIN receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "liquidator", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "lawyer", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "declaration_of_solvency", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "notice_of_appointment", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certified_extract_of_declaration", "signer_role": "registered_agent", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Notice of appointment of voluntary liquidator with declaration of solvency", "channel": "online", "government_fee": { "amount": 150, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot be liquidated under Division 1." }, { "code": "declaration_of_solvency_stale", "type": null, "when": "declaration_of_solvency_date is more than 4 weeks before resolution_date." }, { "code": "liquidation_plan_stale", "type": null, "when": "liquidation_plan_approval_date is more than 6 weeks before resolution_date." }, { "code": "liquidator_ineligible", "type": null, "when": "A liquidator fails the 180-day residence, experience, qualification or independence test, or a regulated person lacks a licensed insolvency practitioner." }, { "code": "director_declaration_missing", "type": null, "when": "Not every director has signed the declaration of solvency." }, { "code": "company_insolvent", "type": null, "when": "Assets are below liabilities, or a director cannot make the declaration; the solvent route is unavailable and Entiva refers to the partner for insolvency options." }, { "code": "filing_deadline_at_risk", "type": null, "when": "More than 10 days have passed since resolution_date without a submitted filing; the appointment is void at 14 days." }, { "code": "liquidation_already_open", "type": null, "when": "A liquidation is already registered for the company." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The company is struck off or has unresolved Registry defaults; use vg.company.restore first." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live actions." } ] } }, "Params_vg_liquidation_complete": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type.", "examples": [ "bc_ltd_shares" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator who files the completion statement.", "examples": [ "per_test_7Lq4" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date on which the liquidator completed the winding up.", "examples": [ "2027-03-31" ] }, "total_distributed": { "$ref": "#/components/schemas/Money", "description": "Total distributed to members in the liquidation.", "examples": [ "USD 47500" ] }, "all_liabilities_discharged": { "type": "boolean", "description": "The liquidator confirms creditors were paid in full or provided for.", "examples": [ "true" ] }, "final_accounts_approval_date": { "type": "string", "format": "date", "description": "Date members or the liquidator approved the final accounts, if applicable.", "examples": [ "2027-03-20" ] }, "unclaimed_assets_held": { "type": "boolean", "description": "True if any assets or sums remain unclaimed.", "examples": [ "false" ] }, "bank_accounts_closed": { "type": "boolean", "description": "Entiva checklist item: all company bank accounts are closed.", "examples": [ "true" ] }, "records_custodian": { "type": "string", "description": "Where the company's records are kept after dissolution.", "examples": [ "Registered agent" ] } }, "required": [ "entity_type", "liquidator", "effective_date", "total_distributed", "all_liabilities_discharged" ], "description": "At the end of the liquidation the liquidator files a completion statement. The Registrar issues the certificate of dissolution and the liquidator publishes a notice in the Gazette." }, "Create_vg_liquidation_complete": { "type": "object", "properties": { "type": { "const": "vg.liquidation.complete" }, "params": { "$ref": "#/components/schemas/Params_vg_liquidation_complete" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Complete a solvent voluntary liquidation and dissolve the BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidator_final_report", "title": "Liquidator's final report and accounts", "source": "uploaded", "required": true }, { "key": "completion_statement", "title": "Completion statement", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN receipt", "source": "registry_issued", "required": true }, { "key": "certificate_of_dissolution", "title": "Certificate of dissolution", "source": "registry_issued", "required": true }, { "key": "gazette_notice", "title": "Gazette notice of dissolution", "source": "uploaded", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "liquidator_final_report", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "completion_statement", "signer_role": "liquidator", "method": "registry_authentication", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Registry of Corporate Affairs", "form": "Completion statement in the approved form", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liquidation_not_commenced", "type": null, "when": "No notice of appointment has been filed for the entity." }, { "code": "advertisement_missing", "type": null, "when": "The commencement advertisement was not published." }, { "code": "liabilities_not_discharged", "type": null, "when": "all_liabilities_discharged is false." }, { "code": "outstanding_fees", "type": null, "when": "Annual fees or penalties are unpaid." }, { "code": "liquidator_mismatch", "type": null, "when": "The signer is not the registered liquidator." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert pauses live actions." } ] } }, "Params_vg_liquidation_remove": { "type": "object", "properties": { "applicant_capacity": { "type": "string", "enum": [ "voluntary_liquidator", "director", "member", "creditor" ], "description": "Standing under s.207A.", "examples": [ "director" ] }, "applicant": { "type": "string", "pattern": "^per_", "description": "Individual or corporate applicant.", "examples": [ "per_5Hs2LpDa1" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The current voluntary liquidator, to be served and who may be asked for a report.", "examples": [ "per_9TqLw4vNc" ] }, "grounds": { "type": "string", "description": "Why termination is just and equitable (s.207A); used in the application and affidavit.", "examples": [ "The debts were settled in full after the liquidation began and the members wish to continue trading." ] }, "proposed_terms": { "type": "string", "description": "Terms or conditions the applicant asks the Court to attach (s.207A), for example payment of the liquidator's fees.", "examples": [ "Company pays the liquidator's fees and costs to the date of the order." ] }, "regulated_person": { "type": "boolean", "description": "True if the company is a regulated person.", "examples": [ "false" ] }, "liquidator_report_expected": { "type": "boolean", "description": "True if the applicant expects the Court to ask the liquidator for a report (s.207A); Entiva then asks the liquidator to prepare one.", "examples": [ "true" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for the directors who will resume control on termination.", "examples": [ "[\"per_5Hs2LpDa1\"]" ] }, "order_date": { "type": "string", "format": "date", "description": "Set after the Court makes its order.", "examples": [ "2026-12-15" ] } }, "required": [ "applicant_capacity", "applicant", "liquidator", "grounds", "regulated_person" ], "description": "Applies to the High Court under BCA s.207A for an order terminating a voluntary liquidation where it is just and equitable. The voluntary liquidator, a director, member or creditor may apply." }, "Create_vg_liquidation_remove": { "type": "object", "properties": { "type": { "const": "vg.liquidation.remove" }, "params": { "$ref": "#/components/schemas/Params_vg_liquidation_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Terminate a BVI voluntary liquidation by Court order", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "court_application", "title": "Court application to terminate the voluntary liquidation", "source": "generated", "required": true }, { "key": "supporting_affidavit", "title": "Supporting affidavit", "source": "uploaded", "required": true }, { "key": "liquidator_report", "title": "Voluntary liquidator's report", "source": "uploaded", "required": false }, { "key": "evidence_of_solvency", "title": "Evidence supporting termination", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Resolution of a corporate applicant or the directors", "source": "generated", "required": false }, { "key": "notice_of_application", "title": "Notice of application for service on the liquidator and, if regulated, the FSC", "source": "generated", "required": true }, { "key": "sealed_court_order", "title": "Sealed order terminating the liquidation", "source": "uploaded", "required": true }, { "key": "proof_of_service", "title": "Proof of service of the sealed order", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "court", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "supporting_affidavit", "signer_role": "applicant", "method": "wet_ink_notarised", "witness_required": true, "agent_signing": "human_wet_ink", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "liquidator_report", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "court_application", "signer_role": "lawyer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "sealed_court_order", "signer_role": "filing_agent", "method": "registry_authentication", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "High Court, Commercial Division", "form": "Court application under BCA s.207A", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_in_voluntary_liquidation", "type": null, "when": "The company is not in a voluntary liquidation under BCA s.199." }, { "code": "applicant_not_eligible", "type": null, "when": "applicant_capacity is outside s.207A." }, { "code": "order_filing_overdue", "type": null, "when": "More than 5 days have passed since order_date without service and filing (s.207A; registry_error)." }, { "code": "court_refused", "type": null, "when": "The Court refuses to terminate the liquidation; the action is rejected." }, { "code": "insolvency_reported", "type": null, "when": "The liquidator has already reported insolvency; termination under s.207A is not offered because the Insolvency Act now governs." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to swear the affidavit or sign the liquidator's report." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert exists on a person in the action." } ] } }, "Params_vg_liquidation_insolvency_file": { "type": "object", "properties": { "liquidator": { "type": "string", "pattern": "^per_", "description": "The voluntary liquidator who forms the opinion and sends the notice.", "examples": [ "per_9TqLw4vNc" ] }, "opinion_date": { "type": "string", "format": "date", "description": "Date the liquidator formed the opinion that the company is insolvent.", "examples": [ "2026-10-15" ] }, "insolvency_basis": { "type": "string", "enum": [ "liabilities_exceed_assets", "unable_to_pay_debts_as_due", "both" ], "description": "Test met under s.209: liabilities exceed or will exceed assets, or the company is or will be unable to pay debts as they fall due.", "examples": [ "liabilities_exceed_assets" ] }, "regulated_person": { "type": "boolean", "description": "True if the company is a regulated person; the notice must also go to the FSC (s.209).", "examples": [ "false" ] }, "notice_date": { "type": "string", "format": "date", "description": "Date the notice is sent.", "examples": [ "2026-10-16" ] }, "creditors_meeting_date": { "type": "string", "format": "date", "description": "Date of the creditors' meeting; must be within 21 days of the notice date (s.210).", "examples": [ "2026-11-04" ] }, "liquidator_is_licensed_insolvency_practitioner": { "type": "boolean", "description": "True if the voluntary liquidator is an eligible licensed insolvency practitioner for the company.", "examples": [ "true" ] }, "directors": { "type": "array", "items": {}, "description": "Array of person_ref for the directors, who provide the statement of affairs.", "examples": [ "[\"per_5Hs2LpDa1\"]" ] }, "statement_of_position": { "type": "string", "description": "Short summary of assets, liabilities and known creditors that led to the opinion.", "examples": [ "Tax liabilities discovered after the liquidation began exceed remaining assets." ] } }, "required": [ "liquidator", "opinion_date", "insolvency_basis", "regulated_person", "creditors_meeting_date", "liquidator_is_licensed_insolvency_practitioner", "directors", "statement_of_position" ], "description": "The voluntary liquidator of a company in voluntary liquidation who forms the opinion that the company is insolvent must forthwith send a written notice in the approved form to the Official Receiver and, for a regulated person, to the FSC." }, "Create_vg_liquidation_insolvency_file": { "type": "object", "properties": { "type": { "const": "vg.liquidation_insolvency.file" }, "params": { "$ref": "#/components/schemas/Params_vg_liquidation_insolvency_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Report insolvency in a BVI voluntary liquidation and convert it to an insolvency liquidation", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company", "mutual_fund_spc", "insurer_spc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "insolvency_notice", "title": "Notice of insolvency to the Official Receiver (approved form, BCA s.209)", "source": "generated", "required": true }, { "key": "fsc_notice", "title": "Copy of the notice for the FSC", "source": "generated", "required": false }, { "key": "statement_of_affairs", "title": "Statement of affairs / assets and liabilities", "source": "uploaded", "required": true }, { "key": "creditors_meeting_notice", "title": "Notice of creditors' meeting", "source": "generated", "required": true }, { "key": "advertisement_proof", "title": "Proof of advertisement of the creditors' meeting", "source": "uploaded", "required": true }, { "key": "creditors_meeting_minutes", "title": "Minutes of the creditors' meeting", "source": "generated", "required": false }, { "key": "official_receiver_acknowledgement", "title": "Official Receiver acknowledgement of the notice", "source": "uploaded", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "sole", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "sole", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "insolvency_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "fsc_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "creditors_meeting_notice", "signer_role": "liquidator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Official Receiver", "form": "Written notice in the approved form", "channel": "both", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liquidator_not_in_office", "type": null, "when": "The person named is not the current voluntary liquidator of the entity." }, { "code": "creditors_meeting_out_of_time", "type": null, "when": "" }, { "code": "opinion_date_in_future", "type": null, "when": "opinion_date is after today." }, { "code": "fsc_copy_missing", "type": null, "when": "regulated_person is true and no FSC notice is attached." }, { "code": "entity_not_in_voluntary_liquidation", "type": null, "when": "The entity is not in voluntary liquidation under BCA Part XII Division 1." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to sign the insolvency notice for the liquidator." } ] } }, "Params_vg_liquidation_notice_publish": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type.", "examples": [ "bc_ltd_shares" ] }, "notice_type": { "type": "string", "enum": [ "commencement", "dissolution" ], "description": "commencement: advertisement within 30 days of commencement. dissolution: Gazette notice after the certificate of dissolution.", "examples": [ "commencement" ] }, "effective_date": { "type": "string", "format": "date", "description": "Commencement date of the liquidation or date of the certificate of dissolution.", "examples": [ "2026-10-20" ] }, "publications": { "type": "array", "items": {}, "description": "Publications to use, each {medium: newspaper|gazette, name, country}.", "examples": [ "[{\"medium\":\"newspaper\",\"name\":\"BVI Beacon\",\"country\":\"VG\"}]" ] }, "liquidator": { "type": "string", "pattern": "^per_", "description": "The liquidator who publishes the notice.", "examples": [ "per_test_7Lq4" ] }, "publication_date": { "type": "string", "format": "date", "description": "Planned or actual publication date.", "examples": [ "2026-10-27" ] } }, "required": [ "entity_type", "notice_type", "effective_date", "publications", "liquidator" ], "description": "The liquidator advertises the liquidation in a BVI newspaper and, where the company has a foreign place of business, in a newspaper there; the commencement advertisement is due within 30 days of commencement (s.204). On completion the." }, "Create_vg_liquidation_notice_publish": { "type": "object", "properties": { "type": { "const": "vg.liquidation_notice.publish" }, "params": { "$ref": "#/components/schemas/Params_vg_liquidation_notice_publish" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Advertise a BVI voluntary liquidation", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "liquidator", "authorised_representative" ], "evidence": [ "register_of_directors", "appointment_document", "board_resolution" ] }, "documents": [ { "key": "liquidation_advertisement", "title": "Text of the advertisement", "source": "generated", "required": true }, { "key": "advertisement_proof", "title": "Proof of publication", "source": "uploaded", "required": true } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "liquidator", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "liquidation_advertisement", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "BVI newspaper and the BVI Gazette", "form": "Advertisement notice", "channel": "both", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "liquidation_not_commenced", "type": null, "when": "No vg.liquidation.commence action has been submitted for the entity." }, { "code": "advertisement_overdue", "type": null, "when": "More than 30 days have passed since commencement without publication." }, { "code": "bvi_publication_missing", "type": null, "when": "publications lacks a BVI newspaper or the Gazette." }, { "code": "proof_missing", "type": null, "when": "No proof of publication has been uploaded." } ] } }, "Params_vg_strike_off_notice_respond": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "description": "Entity type.", "examples": [ "bc_ltd_shares" ] }, "notice_reference": { "type": "string", "description": "Reference of the Registrar's strike-off notice or Gazette notice, if stated.", "examples": [ "GAZ-2026-1142" ] }, "notice_date": { "type": "string", "format": "date", "description": "Date of the Registrar's notice.", "examples": [ "2026-10-01" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date on which strike-off and dissolution take effect, as stated in the notice.", "examples": [ "2026-12-30" ] }, "strike_off_ground": { "type": "string", "enum": [ "no_registered_agent", "failure_to_file", "ceased_business", "unlicensed_regulated_business", "unpaid_fees_or_penalties", "cancelled_licence", "breached_restoration_undertaking" ], "description": "Ground relied on by the Registrar.", "examples": [ "unpaid_fees_or_penalties" ] }, "response": { "type": "string", "enum": [ "update_records", "cure_default", "switch_to_liquidation" ], "description": "update_records: the agent updates the registers and due-diligence records as s.213 requires and the strike-off proceeds. cure_default: as update_records, and.", "examples": [ "update_records" ] }, "outstanding_fees": { "$ref": "#/components/schemas/Money", "description": "Outstanding annual fees and penalties shown by the partner's VIRRGIN statement; they remain payable after strike-off.", "examples": [ "USD 1200" ] }, "transitional_filings_missing": { "type": "boolean", "description": "True if the Schedule 2 para 60I transitional filings were never made.", "examples": [ "false" ] }, "directors": { "type": "array", "items": {}, "description": "Current directors as person references, used to refresh the register of directors and CDD records.", "examples": [ "[\"per_test_9Lm2\"]" ] }, "reason": { "type": "string", "description": "Customer's explanation or instruction.", "examples": [ "Company has no assets and no creditors." ] } }, "required": [ "entity_type", "notice_date", "effective_date", "strike_off_ground", "response" ], "description": "Strike-off with simultaneous dissolution is started by the Registrar, not by the company, so there is no application to file. The grounds are: no registered agent; failure to file; ceasing business; unlicensed regulated business; unpaid." }, "Create_vg_strike_off_notice_respond": { "type": "object", "properties": { "type": { "const": "vg.strike_off_notice.respond" }, "params": { "$ref": "#/components/schemas/Params_vg_strike_off_notice_respond" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Respond to a Registrar strike-off notice for a BVI company", "x-entiva": { "jurisdiction": "vg", "stage": "closure", "applies_to": [ "bc_ltd_shares", "bc_guarantee_no_shares", "bc_guarantee_with_shares", "bc_unlimited_no_shares", "bc_unlimited_with_shares", "restricted_purposes_company", "segregated_portfolio_company", "private_trust_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "strike_off_notice", "title": "Registrar's strike-off notice", "source": "uploaded", "required": true }, { "key": "register_of_members", "title": "Updated register of members", "source": "generated", "required": true }, { "key": "register_of_directors", "title": "Updated register of directors", "source": "generated", "required": true }, { "key": "records_certificate", "title": "Registered agent's records-update certificate", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "VIRRGIN receipt for any cure filings or payments", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "records_certificate", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "strike_off_notice", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Registrar of Corporate Affairs", "form": "None for the company. The notice is Registrar-issued. Any cure filings use their own actio", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_type_not_supported", "type": null, "when": "The entity type is not a BVI company type that the Registrar can strike off." }, { "code": "notice_not_found", "type": null, "when": "No strike-off notice exists for the entity on VIRRGIN or in the uploaded document." }, { "code": "notice_period_expired", "type": null, "when": "effective_date has passed: the company is already struck off and dissolved." }, { "code": "liabilities_survive_strike_off", "type": null, "when": "response is update_records but the entity has known creditors or assets; Entiva warns that liabilities survive (s.215) and requires an explicit acknowledgement." }, { "code": "cdd_incomplete", "type": null, "when": "" }, { "code": "switch_not_possible", "type": null, "when": "response is switch_to_liquidation but the company has been dissolved." } ] } }, "Params_us_bank_account_package_prepare": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "Target bank, if known, so the package follows its checklist.", "examples": [ "Mercury" ] }, "authorised_signatories": { "type": "array", "items": {}, "description": "Persons who will be account signatories.", "examples": [ "[\"per_8Hd2kQw1\"]" ] }, "control_person": { "type": "string", "pattern": "^per_", "description": "The one individual with significant responsibility to control the entity, as banks require under the customer due diligence rule.", "examples": [ "per_8Hd2kQw1" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "Individuals owning 25% or more of the equity.", "examples": [ "[\"per_8Hd2kQw1\",\"per_3Lm9xPz7\"]" ] }, "expected_activity": { "type": "object", "description": "Expected account activity: {monthly_volume: money, countries: string[], purpose: string}.", "examples": [ "{\"monthly_volume\":{\"amount\":\"50000\",\"currency\":\"USD\"},\"countries\":[\"US\",\"SG\"],\"purpose\":\"Operating account for a software company\"}" ] }, "include": { "type": "array", "items": {}, "description": "Documents to include.", "examples": [ "[\"certificate_of_incorporation\",\"ein_confirmation_letter\",\"bylaws\",\"beneficial_ownership_certification\",\"secretary_certificate\"]" ] }, "foreign_owned": { "type": "boolean", "description": "True if any owner or signatory is a non-US person; adds passport copies and source-of-funds notes.", "examples": [ "false" ] } }, "required": [ "authorised_signatories", "control_person" ], "description": "Prepares the KYC package a US bank asks for when a new entity opens an account: formation certificate, EIN letter, bylaws or operating agreement, officer IDs, a beneficial-ownership certification and a secretary's certificate. Entiva." }, "Create_us_bank_account_package_prepare": { "type": "object", "properties": { "type": { "const": "us.bank_account_package.prepare" }, "params": { "$ref": "#/components/schemas/Params_us_bank_account_package_prepare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "US bank account opening support package", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "public_benefit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "certificate_of_incorporation", "title": "Certified copy of the formation certificate", "source": "registry_issued", "required": true }, { "key": "good_standing", "title": "Certificate of good standing", "source": "registry_issued", "required": false }, { "key": "ein_confirmation_letter", "title": "EIN letter", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Bylaws or operating agreement", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution authorising the account and signatories", "source": "generated", "required": true }, { "key": "beneficial_ownership_certification", "title": "Beneficial ownership certification", "source": "generated", "required": true }, { "key": "secretary_certificate", "title": "Secretary's or incumbency certificate", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart", "source": "generated", "required": false }, { "key": "kyc_package", "title": "Bank KYC package", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "beneficial_ownership_certification", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_certificate", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. Documents are delivered to the customer's chosen bank", "form": "Bank KYC package: formation certificate, EIN letter, bylaws or operating agreement, office", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "ein_missing", "type": null, "when": "No EIN letter is on file; run an EIN action first." }, { "code": "beneficial_owner_unverified", "type": null, "when": "A 25%-or-more owner or the control person has not completed verification." }, { "code": "board_resolution_missing", "type": null, "when": "No board resolution authorises the account and signatories." }, { "code": "ownership_not_resolved", "type": null, "when": "The ownership graph does not trace to natural persons; upload corporate-holder documents." }, { "code": "good_standing_stale", "type": null, "when": "Good standing certificate is older than 3 months." } ] } }, "Params_us_bea_survey_file": { "type": "object", "properties": { "form": { "type": "string", "enum": [ "be13a", "be13b", "be13d", "claim_for_exemption" ], "description": "Which BE-13 return to file.", "examples": [ "claim_for_exemption" ] }, "transaction_date": { "type": "string", "format": "date", "description": "Date the foreign person acquired or established the US business.", "examples": [ "2026-10-05" ] }, "investor": { "type": "string", "pattern": "^per_", "description": "The foreign person making the investment.", "examples": [ "per_8f2c1a" ] }, "ultimate_beneficial_owner": { "type": "string", "pattern": "^per_", "description": "Ultimate beneficial owner of the investor, if different.", "examples": [ "per_71b0aa" ] }, "ownership_percent": { "type": "number", "description": "Percentage of voting interests the foreign investor holds in the US entity after the transaction.", "examples": [ "100" ] }, "acquisition_type": { "type": "string", "enum": [ "new_formation", "acquisition_of_existing_business", "real_estate", "other" ], "description": "How the investment was made.", "examples": [ "new_formation" ] }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Total assets of the US business, needed to test the exemption thresholds.", "examples": [ "{\"amount\":250000,\"currency\":\"USD\"}" ] }, "annual_sales": { "$ref": "#/components/schemas/Money", "description": "Sales or gross operating revenues of the US business, for the exemption test.", "examples": [ "{\"amount\":0,\"currency\":\"USD\"}" ] }, "net_income": { "$ref": "#/components/schemas/Money", "description": "Net income after tax of the US business, for the exemption test.", "examples": [ "{\"amount\":0,\"currency\":\"USD\"}" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "Officer who certifies the report.", "examples": [ "per_2d9e44" ] }, "ein": { "type": "string", "description": "EIN of the US entity, if issued.", "examples": [ "12-3456789" ] } }, "required": [ "form", "transaction_date", "investor", "ownership_percent", "acquisition_type", "officer" ], "description": "Files the Bureau of Economic Analysis BE-13 report, or a claim for exemption, when a foreign person acquires or establishes a US business. Entiva prepares the form from the entity's registers and ownership graph; an authorised officer." }, "Create_us_bea_survey_file": { "type": "object", "properties": { "type": { "const": "us.bea_survey.file" }, "params": { "$ref": "#/components/schemas/Params_us_bea_survey_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File BEA BE-13 survey or claim for exemption", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "bea_report", "title": "BEA BE-13 report or claim for exemption", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart to the ultimate beneficial owner", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "BEA eFile confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "bea_report", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "US Bureau of Economic Analysis", "form": "BE-13A / BE-13B / BE-13D / BE-13 Claim for Exemption", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "investor_not_foreign", "type": null, "when": "The investor resolves to a US person, so no BE-13 duty arises." }, { "code": "form_mismatch", "type": null, "when": "The chosen form does not fit the exemption-threshold figures supplied." }, { "code": "verification_incomplete", "type": null, "when": "" } ] } }, "Params_us_board_consent_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State whose law governs.", "examples": [ "DE" ] }, "officers": { "type": "array", "items": {}, "description": "Officers to appoint.", "examples": [ "[{\"officer\":\"per_8Hd2kQw1\",\"title\":\"president\"},{\"officer\":\"per_8Hd2kQw1\",\"title\":\"secretary\"},{\"officer\":\"per_8Hd2kQw1\",\"title\":\"treasurer\"}]" ] }, "adopt_bylaws": { "type": "boolean", "description": "Adopt the bylaws in this consent.", "examples": [ "false" ] }, "bylaws": { "type": "string", "pattern": "^doc_", "description": "doc_ reference to bylaws to adopt.", "examples": [ "doc_5TqVn0aB" ] }, "authorised_signatories": { "type": "array", "items": {}, "description": "Persons who may sign contracts and open bank accounts for the company.", "examples": [ "[\"per_8Hd2kQw1\"]" ] }, "authorise_ein_application": { "type": "boolean", "description": "Authorise the EIN application and name the responsible party.", "examples": [ "true" ] }, "bank_account": { "type": "object", "description": "Authorise opening a bank account.", "examples": [ "{\"bank_name\":\"Mercury\",\"signatories\":[\"per_8Hd2kQw1\"]}" ] }, "authorise_founder_stock_issuance": { "type": "boolean", "description": "Include approval of the founder stock issuance.", "examples": [ "true" ] }, "ratify_incorporator_actions": { "type": "boolean", "description": "Ratify the incorporator's consent and the filing of the certificate.", "examples": [ "true" ] }, "fiscal_year_end": { "type": "integer", "description": "Month number of fiscal year end, if not set earlier.", "examples": [ "12" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date.", "examples": [ "2026-10-17" ] } }, "required": [ "officers" ], "description": "Unanimous written consent of the first board: adopts bylaws if not already adopted, appoints officers, sets signing authority, authorises the EIN application, bank account and founder stock issuance, and ratifies the incorporator's acts.." }, "Create_us_board_consent_adopt": { "type": "object", "properties": { "type": { "const": "us.board_consent.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_board_consent_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Initial board unanimous written consent", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "Unanimous written consent of the board of directors", "source": "generated", "required": true }, { "key": "bylaws", "title": "Bylaws", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Officer consent to act", "source": "generated", "required": true }, { "key": "incorporator_consent", "title": "Incorporator consent", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "bylaws", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. Internal minute book", "form": "Unanimous written consent of the board", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "director_consent_missing", "type": null, "when": "Not every sitting director has signed; the consent cannot take effect (141)." }, { "code": "no_sitting_directors", "type": null, "when": "No directors have been elected yet." }, { "code": "required_office_missing", "type": null, "when": "A state-required office is not filled." }, { "code": "effective_date_too_late", "type": null, "when": "effective_date is more than 60 days after signing." }, { "code": "officer_verification_incomplete", "type": null, "when": "" } ] } }, "Params_us_bylaws_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the entity." }, "adopted_by": { "type": "string", "enum": [ "incorporator", "initial_directors", "board" ], "description": "Who adopts the original bylaws: the incorporator; the initial directors named in the certificate; or the board." }, "template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "entiva_standard: Entiva's standard bylaws generated from governance; custom: upload your own, which Entiva reads into governance for review." }, "bylaws": { "type": "string", "pattern": "^doc_", "description": "Uploaded document, required when template is custom." }, "governance": { "type": "object", "description": "Rules to generate the document from: share or interest classes, signing authority, quorum, written consents, reserved matters, transfer restrictions and." }, "effective_date": { "type": "string", "format": "date", "description": "Date the document takes effect." } }, "required": [ "adopted_by" ], "description": "Adopts the original bylaws of a corporation by incorporator or board consent and records them in the governance profile. Not filed with the state." }, "Create_us_bylaws_adopt": { "type": "object", "properties": { "type": { "const": "us.bylaws.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_bylaws_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt corporate bylaws", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "bylaws", "title": "Bylaws", "source": "generated", "required": true }, { "key": "incorporator_consent", "title": "Written consent of the incorporator", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Unanimous written consent of the board", "source": "generated", "required": false }, { "key": "secretary_certificate", "title": "Secretary's certificate of bylaws", "source": "generated", "required": false } ], "people": [ { "role": "incorporator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "person_concerned", "threshold": "each", "method": "written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "written" } ], "signatures": [ { "document_key": "incorporator_consent", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_certificate", "signer_role": "company_secretary", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None: internal document, not filed with the state", "form": "Bylaws", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_active", "type": null, "when": "The entity has not been formed yet or is not in good standing in the registry." }, { "code": "document_already_in_force", "type": null, "when": "A governing document of this type is already in force; use the amendment action." }, { "code": "custom_document_unreadable", "type": null, "when": "" }, { "code": "signer_not_verified", "type": null, "when": "A signer has not completed verification." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step, such as a director's consent." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type." } ] } }, "Params_us_cooperative_form": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation." }, "entity_type": { "type": "string", "enum": [ "cooperative" ], "description": "cooperative." }, "cooperative_type": { "type": "string", "enum": [ "worker", "processing", "marketing_association", "consumer" ], "description": "Worker, processing or marketing association, or consumer." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person kept on file by the registered agent." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "directors": { "type": "array", "items": {}, "description": "Initial directors." }, "officers": { "type": "array", "items": {}, "description": "Initial officers: each {person, title}." }, "members": { "type": "array", "items": {}, "description": "Initial members: each {person or entity}." }, "patronage": { "type": "object", "description": "{distributes_patronage_dividends, membership_fee, member_capital}." }, "purpose": { "type": "string", "description": "Purpose of the cooperative." }, "governance": { "type": "object", "description": "The entity's own rules: classes or interests, signing authority, board or management, reserved matters, transfer restrictions, appointment rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "Which by-laws: model, entiva_standard or custom." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, entiva_standard, or custom upload for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "state", "entity_type", "cooperative_type", "name", "communications_contact", "directors", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Forms a worker, processing, marketing or consumer cooperative by filing its articles or accepting the Worker's Cooperative Act." }, "Create_us_cooperative_form": { "type": "object", "properties": { "type": { "const": "us.cooperative.form" }, "params": { "$ref": "#/components/schemas/Params_us_cooperative_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a cooperative", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "cooperative_filing", "title": "Cooperative articles / acceptance filing", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "state_supplement", "title": "State-specific supplement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped filing from the state", "source": "registry_issued", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "incorporator", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "cooperative_filing", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Worker's Cooperative Act acceptance", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "registered_agent_required", "type": null, "when": "No in-state agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person communications contact for the registered agent (DE 8 Del." }, { "code": "cooperative_type_not_available", "type": null, "when": "The state has no statute for this cooperative type." }, { "code": "directors_required", "type": null, "when": "No director is named." } ] } }, "Params_us_corporation_incorporate": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation." }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "description": "Type of corporation. close_corp, public_benefit_corp, professional_corp and nonprofit_corp add the conditional parameters below." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person kept on file by the registered agent." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows (DE corporations: 8 Del." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "purpose": { "type": "string", "description": "Purpose clause." }, "share_classes": { "type": "array", "items": {}, "description": "Authorised stock: each {name, authorised_shares, par_value or 'no_par', rights}." }, "incorporators": { "type": "array", "items": {}, "description": "Who signs the filing as incorporator." }, "directors": { "type": "array", "items": {}, "description": "Initial directors (natural persons: 8 Del." }, "officers": { "type": "array", "items": {}, "description": "Initial officers: each {person, title}." }, "shareholders": { "type": "array", "items": {}, "description": "Expected initial holders: each {person, shares or percent}." }, "nonstock": { "type": "boolean", "description": "True for a nonprofit with members and no stock." }, "tax_exempt_intent": { "type": "boolean", "description": "True if the nonprofit will apply for federal tax exemption afterwards." }, "public_benefit": { "type": "string", "description": "Specific public benefit to be identified in the certificate; a Delaware PBC must state at least one." }, "close_corporation": { "type": "object", "description": "{max_holders, transfer_restrictions}." }, "profession": { "type": "object", "description": "{profession, licensing_board, licensed_shareholders}." }, "governance": { "type": "object", "description": "The entity's own rules: classes or interests, signing authority, board or management, reserved matters, transfer restrictions, appointment rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "Which bylaws: model, entiva_standard or custom." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, entiva_standard, or custom upload for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "entity_type", "name", "communications_contact", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Files the certificate or articles of incorporation for a C corporation, public benefit corporation, close corporation, professional corporation or nonprofit corporation in any state or DC, with the registered agent, initial directors and." }, "Create_us_corporation_incorporate": { "type": "object", "properties": { "type": { "const": "us.corporation.incorporate" }, "params": { "$ref": "#/components/schemas/Params_us_corporation_incorporate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporate a corporation", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "incorporation_filing", "title": "Certificate / articles of incorporation", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "state_supplement", "title": "State-specific supplement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "certificate_of_incorporation", "title": "Stamped filed instrument from the state", "source": "registry_issued", "required": true }, { "key": "initial_list", "title": "Nevada initial list of officers and directors", "source": "generated", "required": false }, { "key": "professional_licence", "title": "Professional licence evidence", "source": "uploaded", "required": false } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "incorporator", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "founder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "person_concerned", "threshold": "each", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "incorporation_filing", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "incorporation_filing", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "initial_list", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Certificate of Incorporation", "channel": "online", "government_fee": { "amount": 109, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "name_designator_invalid", "type": null, "when": "Name lacks the designator the state requires [invalid_request_error]." }, { "code": "registered_agent_required", "type": null, "when": "No in-state agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person communications contact for the registered agent (DE 8 Del." }, { "code": "director_must_be_natural_person", "type": null, "when": "A director is a legal entity; corporate directors are not allowed (8 Del." }, { "code": "nv_officers_required", "type": null, "when": "Nevada state: president, secretary and treasurer are not all named." }, { "code": "professional_licence_not_found", "type": null, "when": "" }, { "code": "authorised_shares_invalid", "type": null, "when": "Authorised shares or par value are missing or inconsistent with the state form." }, { "code": "public_benefit_missing", "type": null, "when": "A public benefit corporation has no stated public benefit." } ] } }, "Params_us_ein_request": { "type": "object", "properties": { "responsible_party": { "type": "string", "pattern": "^per_", "description": "The individual named on Form SS-4.", "examples": [ "per_8Hd2kQw1" ] }, "reason_for_applying": { "type": "string", "enum": [ "started_new_business", "hired_employees", "banking_purpose", "changed_type_of_organization", "purchased_going_business", "other" ], "description": "SS-4 line 10 reason.", "examples": [ "started_new_business" ] }, "business_start_date": { "type": "string", "format": "date", "description": "Date the business started or was acquired.", "examples": [ "2026-10-12" ] }, "accounting_year_end": { "type": "integer", "description": "Month number of the accounting year end.", "examples": [ "12" ] }, "nature_of_business": { "type": "string", "description": "Principal activity and product or service.", "examples": [ "Software development: robotics control software" ] }, "expected_employees": { "type": "integer", "description": "Highest number of employees expected in the next 12 months, with first_wages_date if above zero.", "examples": [ "0" ] }, "first_wages_date": { "type": "string", "format": "date", "description": "Date wages were or will be first paid, if employees are expected.", "examples": [ "2027-01-15" ] }, "principal_business_address": { "$ref": "#/components/schemas/Address", "description": "Street address of the principal place of business.", "examples": [ "{\"line1\":\"1111 Market St\",\"city\":\"San Francisco\",\"region\":\"CA\",\"postal_code\":\"94103\",\"country\":\"US\"}" ] }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address if different from the principal business address.", "examples": [ "{\"line1\":\"PO Box 123\",\"city\":\"San Francisco\",\"region\":\"CA\",\"postal_code\":\"94103\",\"country\":\"US\"}" ] }, "llc_member_count": { "type": "integer", "description": "For LLC types: number of members.", "examples": [ "1" ] }, "foreign_owned": { "type": "boolean", "description": "True if a foreign person owns 25% or more of a corporation or all of a single-member LLC.", "examples": [ "false" ] } }, "required": [ "responsible_party", "reason_for_applying", "business_start_date", "nature_of_business", "principal_business_address" ], "description": "Applies for an Employer Identification Number through the IRS online application, for entities with a principal place of business in the US or its territories whose responsible party has an SSN, ITIN or EIN. Entiva staff apply as." }, "Create_us_ein_request": { "type": "object", "properties": { "type": { "const": "us.ein.request" }, "params": { "$ref": "#/components/schemas/Params_us_ein_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Obtain an EIN online", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "ss4_designee_authorisation", "title": "Form SS-4 third-party designee authorisation", "source": "generated", "required": true }, { "key": "ein_confirmation_letter", "title": "EIN confirmation", "source": "registry_issued", "required": true }, { "key": "board_resolution", "title": "Board approval of the EIN application", "source": "generated", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "ss4_designee_authorisation", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service: online EIN application", "form": "Form SS-4 data entered in the IRS online application", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "online_ein_unavailable", "type": null, "when": "The responsible party has no SSN, ITIN or EIN, or the entity's principal place of business is outside the US." }, { "code": "responsible_party_is_entity", "type": null, "when": "The responsible party is not a natural person." }, { "code": "responsible_party_nominee", "type": null, "when": "The named person is a nominee." }, { "code": "ein_already_assigned", "type": null, "when": "The entity already has an EIN on record." }, { "code": "irs_system_unavailable", "type": null, "when": "The IRS online application is closed or rejected the submission; retry later." }, { "code": "designee_authorisation_missing", "type": null, "when": "The responsible party has not signed the designee authorisation." } ] } }, "Params_us_ein_foreign_party_request": { "type": "object", "properties": { "responsible_party": { "type": "string", "pattern": "^per_", "description": "The individual named on Form SS-4, with no SSN or ITIN.", "examples": [ "per_6Jf1yRu4" ] }, "channel": { "type": "string", "enum": [ "fax", "mail", "phone" ], "description": "fax, mail or phone.", "examples": [ "fax" ] }, "applicant_has_us_presence": { "type": "boolean", "description": "True if the entity has a legal residence or principal place of business in the 50 states or DC.", "examples": [ "true" ] }, "reason_for_applying": { "type": "string", "enum": [ "started_new_business", "hired_employees", "banking_purpose", "changed_type_of_organization", "purchased_going_business", "other" ], "description": "SS-4 line 10 reason.", "examples": [ "started_new_business" ] }, "business_start_date": { "type": "string", "format": "date", "description": "Date business started or was acquired.", "examples": [ "2026-10-12" ] }, "accounting_year_end": { "type": "integer", "description": "Month number.", "examples": [ "12" ] }, "nature_of_business": { "type": "string", "description": "Principal activity and product or service.", "examples": [ "Holding company for a software subsidiary" ] }, "principal_business_address": { "$ref": "#/components/schemas/Address", "description": "Principal place of business.", "examples": [ "{\"line1\":\"8 The Green\",\"city\":\"Dover\",\"region\":\"DE\",\"postal_code\":\"19901\",\"country\":\"US\"}" ] }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address, where the IRS sends the EIN notice for mail or fax applications.", "examples": [ "{\"line1\":\"12 Harbour Rd\",\"city\":\"Singapore\",\"postal_code\":\"049483\",\"country\":\"SG\"}" ] }, "llc_member_count": { "type": "integer", "description": "For LLC types: number of members.", "examples": [ "1" ] }, "foreign_owned": { "type": "boolean", "description": "True if a foreign person owns 25% or more of a corporation or all of a single-member LLC.", "examples": [ "true" ] } }, "required": [ "responsible_party", "applicant_has_us_presence", "reason_for_applying", "business_start_date", "nature_of_business", "principal_business_address" ], "description": "Applies for an EIN on paper Form SS-4 when the responsible party has no SSN or ITIN, which is common for foreign founders. Line 7b is marked 'Foreign' or N/A." }, "Create_us_ein_foreign_party_request": { "type": "object", "properties": { "type": { "const": "us.ein_foreign_party.request" }, "params": { "$ref": "#/components/schemas/Params_us_ein_foreign_party_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "EIN for a responsible party without SSN or ITIN", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_ss4", "title": "Form SS-4", "source": "generated", "required": true }, { "key": "signed_form_ss4", "title": "Signed Form SS-4", "source": "uploaded", "required": true }, { "key": "ein_confirmation_letter", "title": "EIN notice", "source": "registry_issued", "required": true }, { "key": "fax_confirmation", "title": "Fax transmission confirmation", "source": "generated", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "signed_form_ss4", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form SS-4", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "online_ein_available", "type": null, "when": "The responsible party actually has an SSN, ITIN or EIN: use us.ein.request instead." }, { "code": "responsible_party_is_entity", "type": null, "when": "The responsible party is not a natural person." }, { "code": "signature_not_wet_ink", "type": null, "when": "The uploaded SS-4 carries an electronic or typed signature; the IRS needs a handwritten one." }, { "code": "ein_already_assigned", "type": null, "when": "The entity already has an EIN." }, { "code": "irs_notice_overdue", "type": null, "when": "No EIN notice has arrived after the expected turnaround; Entiva follows up with the IRS." } ] } }, "Params_us_entity_classification_elect": { "type": "object", "properties": { "classification": { "type": "string", "enum": [ "association", "partnership", "disregarded_entity" ], "description": "Requested federal classification: association, partnership or disregarded_entity.", "examples": [ "association" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the election.", "examples": [ "2026-10-12" ] }, "signer": { "type": "string", "pattern": "^per_", "description": "Member, officer, manager or other person authorised under the organisational documents or local law to sign the election.", "examples": [ "per_8Hd2kQw1" ] }, "owners": { "type": "array", "items": {}, "description": "Current owners at filing: [{owner: person_ref, percentage: number}].", "examples": [ "[{\"owner\":\"per_8Hd2kQw1\",\"percentage\":100}]" ] }, "prior_election_date": { "type": "string", "format": "date", "description": "Date of the last classification election, if any.", "examples": [ "2024-03-01" ] }, "late_election_relief": { "type": "boolean", "description": "Request late-election relief.", "examples": [ "false" ] }, "reasonable_cause_statement": { "type": "string", "pattern": "^doc_", "description": "doc_ reference to the statement.", "examples": [ "doc_4YdS7nKc" ] } }, "required": [ "classification", "effective_date", "signer", "owners" ], "description": "Files IRS Form 8832 so an eligible entity chooses to be taxed as an association, a partnership or a disregarded entity. The effective date may fall up to 75 days before or 12 months after filing." }, "Create_us_entity_classification_elect": { "type": "object", "properties": { "type": { "const": "us.entity_classification.elect" }, "params": { "$ref": "#/components/schemas/Params_us_entity_classification_elect" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Entity classification election", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_8832", "title": "Form 8832 Entity Classification Election", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' or partners' approval of the election", "source": "generated", "required": true }, { "key": "reasonable_cause_statement", "title": "Reasonable-cause statement", "source": "uploaded", "required": false }, { "key": "mailing_confirmation", "title": "Proof of mailing or fax", "source": "generated", "required": true }, { "key": "irs_acknowledgement", "title": "IRS acknowledgement of the election", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_8832", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "IRS Form 8832", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "classification_owner_mismatch", "type": null, "when": "The classification does not fit the owner count." }, { "code": "effective_date_out_of_range", "type": null, "when": "effective_date is more than 75 days before today or more than 12 months after." }, { "code": "sixty_month_limit", "type": null, "when": "prior_election_date is within the last 60 months; a further change is generally barred." }, { "code": "entity_not_eligible", "type": null, "when": "The entity is a per se corporation and cannot elect." }, { "code": "signer_authority_unproven", "type": null, "when": "The signer is not shown to be an owner or authorised under the organisational documents." } ] } }, "Params_us_expedite_request": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE", "WY", "NV" ], "description": "State whose registry will expedite.", "examples": [ "DE" ] }, "action": { "type": "string", "description": "The act_ id of the pending filing to expedite.", "examples": [ "act_3kQ9xB2" ] }, "service_level": { "type": "string", "enum": [ "one_hour", "two_hour", "same_day", "twenty_four_hour", "same_business_day", "next_business_day" ], "description": "DE: one_hour, two_hour, same_day, twenty_four_hour.", "examples": [ "twenty_four_hour" ] }, "filing_kind": { "type": "string", "enum": [ "formation", "other" ], "description": "DE prices formation and other filings differently.", "examples": [ "formation" ] } }, "required": [ "state", "action", "service_level" ], "description": "Adds expedited processing to a pending state filing. The fee is the registry's expedite charge at cost; Entiva adds nothing." }, "Create_us_expedite_request": { "type": "object", "properties": { "type": { "const": "us.expedite.request" }, "params": { "$ref": "#/components/schemas/Params_us_expedite_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request expedited handling of a state filing", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "expedite_request", "title": "Expedite request", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt showing expedite fee", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "expedite_request", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations / Wyoming Secretary of State / Nevada Secretary of State", "form": "Expedite request submitted with the filing", "channel": "online", "government_fee": { "amount": 1000, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "already_filed", "type": null, "when": "The linked filing has already been filed, so it cannot be expedited." }, { "code": "service_level_unavailable", "type": null, "when": "The service level is not offered by that state for the filing type." }, { "code": "state_mismatch", "type": null, "when": "The linked action files in a different state." } ] } }, "Params_us_foundation_form": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Wyoming only." }, "entity_type": { "type": "string", "enum": [ "wy_statutory_foundation" ], "description": "wy_statutory_foundation." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person kept on file by the registered agent (W.S. 17-28-104; not the agent itself)." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier where the Wyoming office offers one." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "founders": { "type": "array", "items": {}, "description": "Each {person or entity}." }, "directors": { "type": "array", "items": {}, "description": "Foundation council members; control persons." }, "protectors": { "type": "array", "items": {}, "description": "Protectors named in the operating agreement; control persons." }, "beneficiaries": { "type": "array", "items": {}, "description": "Named beneficiaries, or a class definition; named beneficiaries are verified before any distribution." }, "endowment": { "$ref": "#/components/schemas/Money", "description": "Initial endowment {amount, currency}; source of funds is documented." }, "purposes": { "type": "string", "description": "Purposes of the foundation." }, "reserved_powers": { "type": "object", "description": "Powers the founder keeps; recorded in the operating agreement and used to decide who has control." }, "governance": { "type": "object", "description": "The entity's own rules: classes or interests, signing authority, board or management, reserved matters, transfer restrictions, appointment rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "Which operating agreement: model, entiva_standard or custom." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, entiva_standard, or custom upload for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" } }, "required": [ "state", "entity_type", "name", "communications_contact", "founders", "directors", "endowment", "nature_of_business", "countries_of_operation", "beneficial_owners" ], "description": "Files the articles of formation of a Wyoming statutory foundation, with founders at enhanced verification and the operating agreement naming directors, protectors and beneficiaries." }, "Create_us_foundation_form": { "type": "object", "properties": { "type": { "const": "us.foundation.form" }, "params": { "$ref": "#/components/schemas/Params_us_foundation_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a Wyoming statutory foundation", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "foundation_filing", "title": "Articles of formation of a Wyoming statutory foundation", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent to appointment", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped articles from the state", "source": "registry_issued", "required": true }, { "key": "operating_agreement", "title": "Operating agreement", "source": "generated", "required": true }, { "key": "source_of_wealth", "title": "Source of wealth evidence", "source": "uploaded", "required": true }, { "key": "source_of_funds", "title": "Source of funds for the endowment", "source": "uploaded", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "founder", "verification_level": "enhanced" }, { "role": "member", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "guardian", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "foundation_filing", "signer_role": "founder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "operating_agreement", "signer_role": "founder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "member", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "WY Articles of Formation", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "registered_agent_required", "type": null, "when": "No Wyoming agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person communications contact for the registered agent (W.S. 17-28-104) [requirement_error]." }, { "code": "source_of_wealth_missing", "type": null, "when": "Founder source-of-wealth evidence is missing." }, { "code": "compliance_signoff_pending", "type": null, "when": "Compliance has not signed off the enhanced due diligence." } ] } }, "Params_us_founder_stock_issue": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Governing state.", "examples": [ "DE" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ reference to the ShareClass issued.", "examples": [ "shc_9GxV2mLa" ] }, "issuances": { "type": "array", "items": {}, "description": "One item per purchaser: {shareholder: person_ref, shares: integer, price_per_share: money, consideration.", "examples": [ "[{\"shareholder\":\"per_8Hd2kQw1\",\"shares\":6000000,\"price_per_share\":{\"amount\":\"0.00001\",\"currency\":\"USD\"},\"consideration\":\"cash_and_ip\"}]" ] }, "issue_date": { "type": "string", "format": "date", "description": "Date the shares are transferred.", "examples": [ "2026-10-14" ] }, "vesting": { "type": "object", "description": "Vesting terms applied to all issuances unless overridden per item: {vesting_start_date: date, vesting_months: integer, cliff_months: integer, acceleration.", "examples": [ "{\"vesting_start_date\":\"2026-10-14\",\"vesting_months\":48,\"cliff_months\":12,\"acceleration\":\"none\",\"repurchase_right\":true}" ] }, "ip_assignment": { "type": "string", "pattern": "^doc_", "description": "doc_ reference to an uploaded IP assignment.", "examples": [ "doc_2ZkP8qUe" ] }, "board_consent": { "type": "string", "pattern": "^doc_", "description": "Existing signed board consent that approves this issuance.", "examples": [ "doc_7TnB3xQ9" ] }, "uncertificated": { "type": "boolean", "description": "Issue uncertificated shares.", "examples": [ "true" ] }, "securities_legend": { "type": "boolean", "description": "Add restrictive legends to the agreement and ledger.", "examples": [ "true" ] }, "prepare_83b": { "type": "boolean", "description": "For vesting stock, draft a us.section_83b_election.file action per purchaser and set the 30-day deadline.", "examples": [ "true" ] }, "s_corp_planned": { "type": "boolean", "description": "Set true if an S election is planned.", "examples": [ "false" ] } }, "required": [ "issuances", "issue_date" ], "description": "Issues founder shares: board approval of the issuance and consideration, restricted stock purchase agreement, IP assignment, stock ledger entry and uncertificated-share notice. Not filed with any state." }, "Create_us_founder_stock_issue": { "type": "object", "properties": { "type": { "const": "us.founder_stock.issue" }, "params": { "$ref": "#/components/schemas/Params_us_founder_stock_issue" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Founder stock issuance", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "board_resolution", "title": "Board consent approving issuance and consideration", "source": "generated", "required": true }, { "key": "stock_purchase_agreement", "title": "Restricted stock purchase agreement", "source": "generated", "required": true }, { "key": "ip_assignment_agreement", "title": "Technology / IP assignment agreement", "source": "generated", "required": false }, { "key": "payment_receipt", "title": "Evidence of cash consideration", "source": "uploaded", "required": false }, { "key": "stock_ledger_entry", "title": "Stock ledger entry", "source": "generated", "required": true }, { "key": "uncertificated_share_notice", "title": "Notice to holder of uncertificated shares", "source": "generated", "required": false }, { "key": "share_certificate", "title": "Share certificate", "source": "generated", "required": false } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stock_purchase_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stock_purchase_agreement", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ip_assignment_agreement", "signer_role": "founder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stock_ledger_entry", "signer_role": "company_secretary", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "share_certificate", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. Stock ledger and cap table in Entiva", "form": "Board consent", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "authorised_shares_exceeded", "type": null, "when": "The issuance would exceed the shares authorised in the certificate of incorporation." }, { "code": "consideration_below_par", "type": null, "when": "Price per share is below the class's par value." }, { "code": "board_approval_missing", "type": null, "when": "No signed board approval covers this issuance." }, { "code": "s_corp_ineligible_holder", "type": null, "when": "s_corp_planned is true and a purchaser is a nonresident alien, an entity or otherwise ineligible, or a second class of stock would result." }, { "code": "professional_licence_required", "type": null, "when": "professional_corp purchaser has no verified professional licence." }, { "code": "issue_date_in_future", "type": null, "when": "issue_date is after today." }, { "code": "purchaser_not_verified", "type": null, "when": "A purchaser who needs verification has not completed it." } ] } }, "Params_us_general_partnership_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of filing." }, "entity_type": { "type": "string", "enum": [ "general_partnership" ], "description": "general_partnership." }, "name": { "type": "string", "description": "Partnership name." }, "partners": { "type": "array", "items": {}, "description": "Each {person or entity, percent}." }, "nature_of_business": { "type": "string", "description": "Business activity." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person for the state's agent records, where the state needs one." }, "effective_date": { "type": "string", "format": "date", "description": "Date the partnership began operating, recorded in the statement." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Registry expedite tier where offered." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs." } }, "required": [ "state", "entity_type", "name", "partners" ], "description": "Records a general partnership with the state by filing a statement of partnership existence. The filing is optional: a general partnership exists by agreement." }, "Create_us_general_partnership_register": { "type": "object", "properties": { "type": { "const": "us.general_partnership.register" }, "params": { "$ref": "#/components/schemas/Params_us_general_partnership_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a general partnership statement of partnership existence", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_existence_statement", "title": "Statement of partnership existence", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Partner consent", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped statement from the state", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "in_app" } ], "signatures": [ { "document_key": "partnership_existence_statement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "DE Statement of Partnership Existence", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "partner_must_be_verified", "type": null, "when": "A general partner or partner has not completed verification." }, { "code": "name_unavailable", "type": null, "when": "The partnership name conflicts with the state's records." }, { "code": "filing_not_available", "type": null, "when": "The state has no equivalent filing for a general partnership." } ] } }, "Params_us_incorporator_consent_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State whose corporation law governs the entity.", "examples": [ "DE" ] }, "directors": { "type": "array", "items": {}, "description": "Persons to elect as the first directors.", "examples": [ "[\"per_8Hd2kQw1\",\"per_3Lm9xPz7\"]" ] }, "bylaws_template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Use Entiva's standard bylaws for the entity type, or supply your own in bylaws.", "examples": [ "entiva_standard" ] }, "bylaws": { "type": "string", "pattern": "^doc_", "description": "doc_ reference to the bylaws.", "examples": [ "doc_5TqVn0aB" ] }, "fiscal_year_end": { "type": "integer", "description": "Month number in which the fiscal year ends.", "examples": [ "12" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the consent takes effect.", "examples": [ "2026-10-17" ] }, "resign_incorporator": { "type": "boolean", "description": "Record the incorporator's resignation once directors are elected.", "examples": [ "true" ] }, "incorporator": { "type": "string", "pattern": "^per_", "description": "Only if a customer individual was the incorporator named in the certificate.", "examples": [ "per_9WcT4rEy" ] } }, "required": [ "directors" ], "description": "Records the sole incorporator's action in lieu of an organisational meeting: adopts the original bylaws and elects the first board where the certificate of incorporation does not name directors. Entiva signs as incorporator in its own." }, "Create_us_incorporator_consent_adopt": { "type": "object", "properties": { "type": { "const": "us.incorporator_consent.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_incorporator_consent_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Incorporator's written consent", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "incorporator_consent", "title": "Action of sole incorporator by written consent", "source": "generated", "required": true }, { "key": "bylaws", "title": "Bylaws", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Director consent to act", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Filed certificate or articles of incorporation", "source": "registry_issued", "required": true } ], "people": [ { "role": "incorporator", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "incorporator_consent", "signer_role": "incorporator", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "incorporator_consent", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "bylaws", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "None. Internal record kept in Entiva's minute book and director register", "form": "Action of sole incorporator", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "incorporator_authority_ended", "type": null, "when": "The certificate of incorporation names the directors, or a board already exists, so the incorporator has no power to act." }, { "code": "director_not_natural_person", "type": null, "when": "A listed director is a legal entity." }, { "code": "bylaws_conflict_with_charter", "type": null, "when": "Uploaded bylaws contradict the filed certificate." }, { "code": "director_verification_incomplete", "type": null, "when": "A director has not completed identity_address verification; the action stays in requirements_pending." }, { "code": "consent_already_adopted", "type": null, "when": "An incorporator consent has already been completed for this entity." } ] } }, "Params_us_itin_apply": { "type": "object", "properties": { "applicant": { "type": "string", "pattern": "^per_", "description": "The foreign individual who needs the ITIN.", "examples": [ "per_8f2c1a" ] }, "reason": { "type": "string", "enum": [ "nonresident_alien_tax_return", "nonresident_alien_treaty_benefit", "us_resident_alien_tax_return", "dependent_or_spouse_of_us_citizen_or_resident", "other" ], "description": "Reason for needing an ITIN, as Form W-7 asks.", "examples": [ "nonresident_alien_tax_return" ] }, "submission_route": { "type": "string", "enum": [ "certifying_acceptance_agent", "irs_taxpayer_assistance_center", "mail_to_itin_operation" ], "description": "How the application reaches the IRS.", "examples": [ "certifying_acceptance_agent" ] }, "identity_documents": { "type": "array", "items": {}, "description": "Document types supplied.", "examples": [ "[\"passport\"]" ] }, "foreign_tax_id": { "type": "string", "description": "Foreign tax ID, if any.", "examples": [ "DE123456789" ] }, "country_of_citizenship": { "type": "string", "description": "ISO 3166 country code.", "examples": [ "DE" ] }, "associated_return": { "type": "string", "description": "Reference to the federal return being filed or the exception relied on.", "examples": [ "1040-NR 2026" ] }, "entity_link": { "type": "string", "description": "Role of the applicant in the entity, for the file.", "examples": [ "sole member" ] } }, "required": [ "applicant", "reason", "submission_route", "identity_documents", "country_of_citizenship" ], "description": "Prepares IRS Form W-7 for a foreign individual who needs a US taxpayer identification number and sends it, with the identity documents, through an IRS Certifying Acceptance Agent or by mail. The applicant signs on paper." }, "Create_us_itin_apply": { "type": "object", "properties": { "type": { "const": "us.itin.apply" }, "params": { "$ref": "#/components/schemas/Params_us_itin_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for an ITIN for a foreign owner or officer", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "llc_single_member", "llc_multi_member", "c_corp", "s_corp_election", "lp", "lllp", "llp", "general_partnership", "pllc", "professional_corp", "sole_proprietorship", "wy_dao_llc", "l3c", "wy_close_llc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_w7", "title": "Form W-7", "source": "generated", "required": true }, { "key": "passport", "title": "Passport", "source": "uploaded", "required": true }, { "key": "caa_certificate", "title": "Certificate of authenticity", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Proof of mailing / IRS acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "form_w7", "signer_role": "applicant", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "IRS ITIN Operation, Austin", "form": "Form W-7 with a federal tax return", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ssn_eligible", "type": null, "when": "The applicant is eligible for an SSN, so an ITIN is not allowed." }, { "code": "no_return_or_exception", "type": null, "when": "No tax return or exception supports the application." }, { "code": "document_unacceptable", "type": null, "when": "Identity documents do not meet IRS rules." }, { "code": "wet_ink_required", "type": null, "when": "The signed W-7 has not been received." } ] } }, "Params_us_llc_form": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation." }, "entity_type": { "type": "string", "enum": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "wy_dao_llc" ], "description": "LLC type. series_llc, pllc and wy_dao_llc add the conditional parameters below." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person kept on file by the registered agent." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows (DE corporations: 8 Del." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "organisers": { "type": "array", "items": {}, "description": "Who signs the filing as organiser or authorised person." }, "management": { "type": "string", "enum": [ "member_managed", "manager_managed" ], "description": "member_managed or manager_managed." }, "members": { "type": "array", "items": {}, "description": "Each {person, percent, capital_contribution}." }, "managers": { "type": "array", "items": {}, "description": "Managers or managing members." }, "nature_of_business": { "type": "string", "description": "Business activity, used for the NV state business licence and tax registrations." }, "series": { "type": "object", "description": "{structure: 'protected'|'registered'|'wy_series', names[]}." }, "professional": { "type": "object", "description": "{profession, licensing_board, licensed_members}." }, "dao": { "type": "object", "description": "{smart_contract_identifier, algorithmically_managed, key_controllers[]}." }, "governance": { "type": "object", "description": "The entity's own rules: classes or interests, signing authority, board or management, reserved matters, transfer restrictions, appointment rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "Which operating agreement: model, entiva_standard or custom." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, entiva_standard, or custom upload for review." }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "entity_type", "name", "communications_contact", "management", "members", "countries_of_operation", "beneficial_owners" ], "description": "Files the certificate of formation or articles of organisation for a single-member, multi-member, series, professional or Wyoming DAO LLC in any state or DC, with the registered agent and the state-specific extras." }, "Create_us_llc_form": { "type": "object", "properties": { "type": { "const": "us.llc.form" }, "params": { "$ref": "#/components/schemas/Params_us_llc_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form an LLC", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "formation_filing", "title": "Certificate of formation / articles of organisation", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Consent to act", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "state_supplement", "title": "State-specific supplement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped certificate or articles from the state", "source": "registry_issued", "required": true }, { "key": "professional_licence", "title": "Professional licence evidence", "source": "uploaded", "required": false }, { "key": "initial_list", "title": "Nevada initial list of managers or members", "source": "generated", "required": false } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "incorporator", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "founder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "person_concerned", "threshold": "each", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "formation_filing", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "formation_filing", "signer_role": "incorporator", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "manager", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "initial_list", "signer_role": "manager", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Certificate of Formation", "channel": "online", "government_fee": { "amount": 110, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "name_designator_invalid", "type": null, "when": "Name lacks the designator the state requires [invalid_request_error]." }, { "code": "registered_agent_required", "type": null, "when": "No in-state agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person communications contact for the registered agent (DE 8 Del." }, { "code": "professional_licence_not_found", "type": null, "when": "" }, { "code": "managers_required", "type": null, "when": "manager_managed was chosen or the state needs managers, but none are named." }, { "code": "series_not_available", "type": null, "when": "The state has no series LLC statute for the chosen state." }, { "code": "smart_contract_identifier_missing", "type": null, "when": "A Wyoming DAO LLC has no smart contract identifier." } ] } }, "Params_us_llp_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation." }, "entity_type": { "type": "string", "enum": [ "llp" ], "description": "llp." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person kept on file by the registered agent." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows (DE corporations: 8 Del." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "partners": { "type": "array", "items": {}, "description": "Each {person or entity, percent}." }, "profession": { "type": "object", "description": "{profession, licensing_board, licence_numbers}." }, "nature_of_business": { "type": "string", "description": "Business activity." }, "governance": { "type": "object", "description": "The entity's own rules: classes or interests, signing authority, board or management, reserved matters, transfer restrictions, appointment rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "Which partnership agreement: model, entiva_standard or custom." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "entity_type", "name", "communications_contact", "partners", "countries_of_operation", "members", "beneficial_owners" ], "description": "Registers a partnership as an LLP by filing the statement of qualification or registration in the chosen state." }, "Create_us_llp_register": { "type": "object", "properties": { "type": { "const": "us.llp.register" }, "params": { "$ref": "#/components/schemas/Params_us_llp_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a limited liability partnership", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "llp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "llp_filing", "title": "Statement of qualification / registration as LLP", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Partner consent", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "state_supplement", "title": "State-specific supplement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped statement from the state", "source": "registry_issued", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "llp_filing", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Statement of Qualification", "channel": "online", "government_fee": { "amount": 300, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "name_designator_invalid", "type": null, "when": "Name lacks the designator the state requires [invalid_request_error]." }, { "code": "registered_agent_required", "type": null, "when": "No in-state agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person communications contact for the registered agent (DE 8 Del." }, { "code": "partner_must_be_verified", "type": null, "when": "A general partner or partner has not completed verification." }, { "code": "llp_restricted_to_professions", "type": null, "when": "The state restricts LLPs to licensed professions and no licensed profession is stated." }, { "code": "professional_licence_not_found", "type": null, "when": "" } ] } }, "Params_us_lp_form": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation." }, "entity_type": { "type": "string", "enum": [ "lp", "lllp" ], "description": "lp or lllp." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person kept on file by the registered agent." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows (DE corporations: 8 Del." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "general_partners": { "type": "array", "items": {}, "description": "Each {person or entity, kind}." }, "limited_partners": { "type": "array", "items": {}, "description": "Each {person or entity, percent, capital_contribution}." }, "nature_of_business": { "type": "string", "description": "Business purpose or activity." }, "governance": { "type": "object", "description": "The entity's own rules: classes or interests, signing authority, board or management, reserved matters, transfer restrictions, appointment rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "Which partnership agreement: model, entiva_standard or custom." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "entity_type", "name", "communications_contact", "general_partners", "countries_of_operation", "beneficial_owners" ], "description": "Files the certificate of limited partnership in the chosen state, naming the general partner and registered agent." }, "Create_us_lp_form": { "type": "object", "properties": { "type": { "const": "us.lp.form" }, "params": { "$ref": "#/components/schemas/Params_us_lp_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a limited partnership or LLLP", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "lp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "lp_filing", "title": "Certificate of limited partnership", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "General partner consent", "source": "generated", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "state_supplement", "title": "State-specific supplement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped certificate from the state", "source": "registry_issued", "required": true } ], "people": [ { "role": "registered_agent", "verification_level": "none" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "founder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "lp_filing", "signer_role": "general_partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "consent_to_act", "signer_role": "general_partner", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Certificate of Limited Partnership", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "name_designator_invalid", "type": null, "when": "Name lacks the designator the state requires [invalid_request_error]." }, { "code": "registered_agent_required", "type": null, "when": "No in-state agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person communications contact for the registered agent (DE 8 Del." }, { "code": "partner_must_be_verified", "type": null, "when": "A general partner or partner has not completed verification." }, { "code": "general_partner_required", "type": null, "when": "No general partner is named." }, { "code": "lllp_not_available", "type": null, "when": "The state does not recognise LLLPs." } ] } }, "Params_us_name_reserve": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State where the name is reserved." }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc" ], "description": "Entity type the name will be used for." }, "name": { "type": "string", "description": "Name to reserve, with the designator the state requires for the entity type." }, "alternative_names": { "type": "array", "items": {}, "description": "Fallback names tried in order if the first is unavailable." }, "applicant": { "type": "string", "pattern": "^per_", "description": "Reserving party named on the application." } }, "required": [ "state", "entity_type", "name" ], "description": "Holds a proposed entity name with the state for a fixed period so a later formation filing can use it. Optional; no entity exists yet." }, "Create_us_name_reserve": { "type": "object", "properties": { "type": { "const": "us.name.reserve" }, "params": { "$ref": "#/components/schemas/Params_us_name_reserve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reserve an entity name before formation", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_application", "title": "Name reservation application", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Reservation confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_application", "signer_role": "filing_agent", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Name Reservation", "channel": "both", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "name_unavailable", "type": null, "when": "The name is not distinguishable on the state's records or is already reserved." }, { "code": "name_designator_invalid", "type": null, "when": "The name lacks or misuses a designator the entity type needs." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type has no reservation form in that state." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type or state." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the application." } ] } }, "Params_us_name_reservation_cancel": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State holding the reservation." }, "reservation": { "type": "string", "description": "Reference of the reservation." }, "reason": { "type": "string", "description": "Why the reservation is cancelled." } }, "required": [ "state", "reservation" ], "description": "Cancels an existing state name reservation so the name is released." }, "Create_us_name_reservation_cancel": { "type": "object", "properties": { "type": { "const": "us.name_reservation.cancel" }, "params": { "$ref": "#/components/schemas/Params_us_name_reservation_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a name reservation", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_cancellation", "title": "Cancellation request", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Cancellation confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_cancellation", "signer_role": "filing_agent", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE name reservation cancellation", "channel": "both", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "reservation_not_found", "type": null, "when": "The reference matches no active reservation held by Entiva for this account." }, { "code": "reservation_expired", "type": null, "when": "The reservation has already lapsed." }, { "code": "entity_type_not_supported", "type": null, "when": "The state has no cancellation filing for this reservation." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type or state." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the request." } ] } }, "Params_us_name_reservation_transfer": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State holding the reservation." }, "reservation": { "type": "string", "description": "Reference of the reservation to transfer." }, "transferee": { "type": "string", "pattern": "^per_", "description": "Party who takes over the reservation." } }, "required": [ "state", "reservation", "transferee" ], "description": "Assigns an existing name reservation to another person or filing agent so they can use the name." }, "Create_us_name_reservation_transfer": { "type": "object", "properties": { "type": { "const": "us.name_reservation.transfer" }, "params": { "$ref": "#/components/schemas/Params_us_name_reservation_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a name reservation to another party", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "name_reservation_transfer", "title": "Transfer request", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Transfer confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "applicant", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" } ], "signatures": [ { "document_key": "name_reservation_transfer", "signer_role": "filing_agent", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE name reservation transfer", "channel": "both", "government_fee": { "amount": 75, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "reservation_not_found", "type": null, "when": "The reference matches no active reservation held by Entiva for this account." }, { "code": "transferee_not_screened", "type": null, "when": "The transferee has not passed sanctions screening." }, { "code": "entity_type_not_supported", "type": null, "when": "The state has no transfer filing for this reservation." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type or state." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the request." } ] } }, "Params_us_operating_agreement_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the entity." }, "management": { "type": "string", "enum": [ "member_managed", "manager_managed" ], "description": "member_managed or manager_managed." }, "members": { "type": "array", "items": {}, "description": "Each {person or entity, percent, capital_contribution}." }, "managers": { "type": "array", "items": {}, "description": "Managers or managing members." }, "tax_classification": { "type": "string", "enum": [ "disregarded", "partnership", "corporation" ], "description": "Intended federal classification, which drives the allocation clauses." }, "transfer_restrictions": { "type": "object", "description": "Consent, right of first refusal, and licence conditions." }, "series_terms": { "type": "object", "description": "Series liability partition and per-series records." }, "smart_contract_precedence": { "type": "string", "description": "How the smart contract and the written agreement rank." }, "template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "entiva_standard: Entiva's LLC agreement generated from governance; custom: upload your own, which Entiva reads into governance for review." }, "operating_agreement": { "type": "string", "pattern": "^doc_", "description": "Uploaded document, required when template is custom." }, "governance": { "type": "object", "description": "Rules to generate the document from: share or interest classes, signing authority, quorum, written consents, reserved matters, transfer restrictions and." }, "effective_date": { "type": "string", "format": "date", "description": "Date the document takes effect." } }, "description": "Adopts the LLC agreement among the members and records it in the governance profile. Not filed with the state." }, "Create_us_operating_agreement_adopt": { "type": "object", "properties": { "type": { "const": "us.operating_agreement.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_operating_agreement_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt an LLC operating agreement", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "operating_agreement", "title": "LLC operating agreement", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Members' consent adopting the agreement", "source": "generated", "required": false } ], "people": [ { "role": "member", "verification_level": "identity" }, { "role": "manager", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "members", "threshold": "unanimous", "method": "written" }, { "kind": "corporate", "body": "sole_director", "threshold": "sole", "method": "written" } ], "signatures": [ { "document_key": "operating_agreement", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None: internal document, not filed with the state", "form": "LLC agreement", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_active", "type": null, "when": "The entity has not been formed yet or is not in good standing in the registry." }, { "code": "document_already_in_force", "type": null, "when": "A governing document of this type is already in force; use the amendment action." }, { "code": "custom_document_unreadable", "type": null, "when": "" }, { "code": "signer_not_verified", "type": null, "when": "A signer has not completed verification." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step, such as a director's consent." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type." }, { "code": "members_do_not_sum_to_100", "type": null, "when": "Member percentages do not total 100." } ] } }, "Params_us_partnership_agreement_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the entity." }, "partners": { "type": "array", "items": {}, "description": "Each {person or entity, partner_type, percent, capital_contribution}." }, "management": { "type": "object", "description": "Who manages: general partner, management committee, voting rules." }, "profit_allocation": { "type": "object", "description": "Allocation of profits, losses and distributions; carried interest or preferred return terms." }, "transfer_restrictions": { "type": "object", "description": "Consent, right of first refusal and admission of new partners." }, "template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "entiva_standard: Entivaship agreement generated from governance; custom: upload your own, which Entiva reads into governance for review." }, "partnership_agreement": { "type": "string", "pattern": "^doc_", "description": "Uploaded document, required when template is custom." }, "governance": { "type": "object", "description": "Rules to generate the document from: share or interest classes, signing authority, quorum, written consents, reserved matters, transfer restrictions and." }, "effective_date": { "type": "string", "format": "date", "description": "Date the document takes effect." } }, "description": "Adopts the partnership agreement of a limited partnership, LLLP, LLP or general partnership and records it in the governance profile. Not filed with the state." }, "Create_us_partnership_agreement_adopt": { "type": "object", "properties": { "type": { "const": "us.partnership_agreement.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_partnership_agreement_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt a partnership agreement", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "lp", "llp", "lllp", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_agreement", "title": "Partnership agreement", "source": "generated", "required": true }, { "key": "partners_resolution", "title": "Partners' consent adopting the agreement", "source": "generated", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity" }, { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "general_partners", "threshold": "unanimous", "method": "written" }, { "kind": "corporate", "body": "limited_partners", "threshold": "as_constitution", "method": "written" }, { "kind": "corporate", "body": "partners", "threshold": "unanimous", "method": "written" } ], "signatures": [ { "document_key": "partnership_agreement", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "partners_resolution", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None: internal document, not filed with the state", "form": "Partnership agreement", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_active", "type": null, "when": "The entity has not been formed yet or is not in good standing in the registry." }, { "code": "document_already_in_force", "type": null, "when": "A governing document of this type is already in force; use the amendment action." }, { "code": "custom_document_unreadable", "type": null, "when": "" }, { "code": "signer_not_verified", "type": null, "when": "A signer has not completed verification." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step, such as a director's consent." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type." }, { "code": "interests_do_not_sum_to_100", "type": null, "when": "Partner percentages do not total 100." } ] } }, "Params_us_partnership_authority_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Wyoming only.", "examples": [ "WY" ] }, "partnership_name": { "type": "string", "description": "Name of the partnership.", "examples": [ "Cody Freight Partners" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal office in or outside Wyoming.", "examples": [ "{\"line1\":\"5 Sheridan Ave\",\"city\":\"Cody\",\"state\":\"WY\",\"postal_code\":\"82414\",\"country\":\"US\"}" ] }, "partners_with_authority": { "type": "array", "items": {}, "description": "Partners authorised to execute instruments, and any limits.", "examples": [ "[\"per_p01\",\"per_p02\"]" ] }, "authority_scope": { "type": "string", "enum": [ "all_acts", "real_property_only" ], "description": "Whether authority covers all acts or only real-property transfers.", "examples": [ "all_acts" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date.", "examples": [ "2026-11-01" ] } }, "required": [ "state", "partnership_name", "principal_office", "partners_with_authority", "authority_scope" ], "description": "Files an optional statement of partnership authority for a Wyoming general partnership, giving public notice of which partners may act and transfer property." }, "Create_us_partnership_authority_file": { "type": "object", "properties": { "type": { "const": "us.partnership_authority.file" }, "params": { "$ref": "#/components/schemas/Params_us_partnership_authority_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Wyoming statement of partnership authority", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "partnership_authority_statement", "title": "Statement of partnership authority", "source": "generated", "required": true }, { "key": "constitution", "title": "Partnership agreement", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Filed statement", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "partnership_authority_statement", "signer_role": "partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Statement of Partnership Authority", "channel": "both", "government_fee": { "amount": 10, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "state_not_supported", "type": null, "when": "State is not WY." }, { "code": "partner_not_verified", "type": null, "when": "" } ] } }, "Params_us_s_corp_election_file": { "type": "object", "properties": { "effective_date": { "type": "string", "format": "date", "description": "First day of the tax year for which the election takes effect.", "examples": [ "2026-10-12" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "Authorised officer who signs Form 2553.", "examples": [ "per_8Hd2kQw1" ] }, "shareholders": { "type": "array", "items": {}, "description": "Every person who holds stock on the day the election is made and on the effective date: [{shareholder: person_ref, shares: integer, spouse: person_ref.", "examples": [ "[{\"shareholder\":\"per_8Hd2kQw1\",\"shares\":6000000,\"acquired_date\":\"2026-10-14\"},{\"shareholder\":\"per_3Lm9xPz7\",\"shares\":4000000,\"acquired_date\":\"2026-10-14\"}]" ] }, "tax_year": { "type": "string", "enum": [ "calendar", "fiscal_other" ], "description": "calendar or fiscal_other. fiscal_other triggers manual review; a business-purpose tax year request carries a $6,200 IRS user fee.", "examples": [ "calendar" ] }, "late_election_relief": { "type": "boolean", "description": "Request relief for a late election.", "examples": [ "false" ] }, "reasonable_cause_statement": { "type": "string", "pattern": "^doc_", "description": "doc_ reference to the statement of reasonable cause.", "examples": [ "doc_4YdS7nKc" ] }, "llc_deemed_corporation": { "type": "boolean", "description": "For an LLC with no Form 8832 on file: acknowledge that filing Form 2553 is treated as electing corporate classification.", "examples": [ "false" ] }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the entity's principal office, used only to pick the IRS service center and flag state conformity issues.", "examples": [ "DE" ] } }, "required": [ "effective_date", "officer", "shareholders" ], "description": "Prepares and files IRS Form 2553 so a corporation is treated as an S corporation. Requires a handwritten signature from an authorised officer and the consent of every shareholder, filed by fax or mail." }, "Create_us_s_corp_election_file": { "type": "object", "properties": { "type": { "const": "us.s_corp_election.file" }, "params": { "$ref": "#/components/schemas/Params_us_s_corp_election_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "S corporation election", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "s_corp_election", "c_corp", "llc_single_member", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "form_2553", "title": "Form 2553 Election by a Small Business Corporation", "source": "generated", "required": true }, { "key": "signed_form_2553", "title": "Signed Form 2553", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Board resolution authorising the election", "source": "generated", "required": true }, { "key": "reasonable_cause_statement", "title": "Reasonable-cause statement", "source": "uploaded", "required": false }, { "key": "fax_confirmation", "title": "Fax or mailing confirmation", "source": "generated", "required": true }, { "key": "irs_acceptance_letter", "title": "IRS acceptance or rejection letter", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "signed_form_2553", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "signed_form_2553", "signer_role": "shareholder", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "IRS Form 2553", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "s_corp_ineligible_holder", "type": null, "when": "A shareholder is a nonresident alien, a corporation, partnership or ineligible trust, or there are more than 100 shareholders." }, { "code": "second_class_of_stock", "type": null, "when": "The entity has more than one class of stock." }, { "code": "shareholder_consent_missing", "type": null, "when": "A shareholder has not signed." }, { "code": "election_deadline_passed", "type": null, "when": "effective_date is more than 2 months 15 days ago." }, { "code": "signature_not_wet_ink", "type": null, "when": "The uploaded form carries electronic signatures." }, { "code": "fiscal_year_manual_review", "type": null, "when": "tax_year is fiscal_other; requires licensed professional review and may carry a $6,200 user fee." } ] } }, "Params_us_section_83b_election_file": { "type": "object", "properties": { "taxpayer": { "type": "string", "pattern": "^per_", "description": "The founder who received the stock or interest and makes the election.", "examples": [ "per_8Hd2kQw1" ] }, "transfer_date": { "type": "string", "format": "date", "description": "Date the property was transferred.", "examples": [ "2026-10-14" ] }, "property_description": { "type": "string", "description": "Description of the property, for example '6,000,000 shares of common stock of Acme Robotics, Inc.' or the LLC profits interest.", "examples": [ "6,000,000 shares of common stock of Acme Robotics, Inc." ] }, "number_of_units": { "type": "integer", "description": "Number of shares or units transferred.", "examples": [ "6000000" ] }, "fair_market_value_per_unit": { "$ref": "#/components/schemas/Money", "description": "Fair market value per unit at the transfer date, determined without regard to restrictions other than non-lapse restrictions.", "examples": [ "{\"amount\":\"0.00001\",\"currency\":\"USD\"}" ] }, "amount_paid_per_unit": { "$ref": "#/components/schemas/Money", "description": "Amount the taxpayer paid per unit.", "examples": [ "{\"amount\":\"0.00001\",\"currency\":\"USD\"}" ] }, "vesting_description": { "type": "string", "description": "The substantial risk of forfeiture: for example 'subject to repurchase at cost; vests monthly over 48 months with a 12-month cliff'.", "examples": [ "Subject to repurchase at cost; vests over 48 months with a 12-month cliff" ] }, "form": { "type": "string", "enum": [ "form_15620", "statement" ], "description": "form_15620 or statement (written statement under IRC 83).", "examples": [ "form_15620" ] }, "taxable_year": { "type": "integer", "description": "Calendar year of the transfer.", "examples": [ "2026" ] }, "founder_stock_issuance": { "type": "string", "pattern": "^ent_", "description": "act_ reference to the us.founder_stock.issue action that created the transfer, to prefill the params.", "examples": [ "act_2VwC6nH8" ] }, "mailing": { "type": "string", "enum": [ "entiva_mails", "taxpayer_mails" ], "description": "entiva_mails: Entiva prints the e-signed election and mails it with tracking. taxpayer_mails: Entiva returns a print-ready PDF and the taxpayer mails.", "examples": [ "entiva_mails" ] }, "delivery_method": { "type": "string", "enum": [ "certified_mail_return_receipt", "private_delivery_service" ], "description": "How the election is mailed.", "examples": [ "certified_mail_return_receipt" ] }, "copy_to_company": { "type": "boolean", "description": "Deliver a copy to the company for its records.", "examples": [ "true" ] } }, "required": [ "taxpayer", "transfer_date", "property_description", "number_of_units", "fair_market_value_per_unit", "amount_paid_per_unit", "vesting_description" ], "description": "Prepares, collects the founder's electronic signature on, and mails the IRC 83 election within 30 days of the property transfer, with proof of mailing and a copy for the company. The election cannot be made late, so Entiva computes the." }, "Create_us_section_83b_election_file": { "type": "object", "properties": { "type": { "const": "us.section_83b_election.file" }, "params": { "$ref": "#/components/schemas/Params_us_section_83b_election_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Section 83 election for restricted founder stock", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "public_benefit_corp", "s_corp_election", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "section_83b_election", "title": "Section 83 election", "source": "generated", "required": true }, { "key": "stock_purchase_agreement", "title": "Stock purchase agreement or grant showing the transfer and restrictions", "source": "uploaded", "required": false }, { "key": "valuation_support", "title": "Support for fair market value", "source": "uploaded", "required": false }, { "key": "proof_of_mailing", "title": "Proof of mailing", "source": "generated", "required": true }, { "key": "company_copy", "title": "Copy of the election for the company", "source": "generated", "required": false } ], "people": [ { "role": "founder", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "person_concerned", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "section_83b_election", "signer_role": "founder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service, service center named in the Form 15620 instructions for the taxp", "form": "IRS Form 15620", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "election_window_closed", "type": null, "when": "More than 30 days have passed since transfer_date." }, { "code": "transfer_date_in_future", "type": null, "when": "transfer_date is after today." }, { "code": "taxpayer_not_verified", "type": null, "when": "The founder has not completed identity verification, or has no SSN or ITIN on record." }, { "code": "property_not_restricted", "type": null, "when": "The referenced issuance is fully vested; Entiva warns but allows the election if the customer insists." }, { "code": "signature_deadline_at_risk", "type": null, "when": "The founder has not signed and fewer than 5 days remain; a deadline.upcoming event fires." } ] } }, "Params_us_series_convert": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Only Delaware is supported.", "examples": [ "DE" ] }, "series_name": { "type": "string", "description": "Name of the series being converted.", "examples": [ "Acme Holdings, LLC - Series A" ] }, "direction": { "type": "string", "enum": [ "protected_to_registered", "registered_to_protected" ], "description": "Direction of the conversion.", "examples": [ "protected_to_registered" ] }, "effective_date": { "type": "string", "format": "date", "description": "Future effective date, if accepted.", "examples": [ "2026-12-01" ] }, "authorised_person": { "type": "string", "pattern": "^per_", "description": "Signer; the general partner for an LP.", "examples": [ "per_0c41de" ] } }, "required": [ "state", "series_name", "direction" ], "description": "Files a certificate of conversion changing a Delaware LLC or LP series from protected to registered or from registered to protected." }, "Create_us_series_convert": { "type": "object", "properties": { "type": { "const": "us.series.convert" }, "params": { "$ref": "#/components/schemas/Params_us_series_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a series between protected and registered", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "series_llc", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "conversion_certificate", "title": "Certificate of conversion", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Member or manager consent to the conversion", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "conversion_certificate", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "conversion_certificate", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Certificate of Conversion from protected series to registered series", "channel": "online", "government_fee": { "amount": 220, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "series_not_found", "type": null, "when": "No series of that name exists on the entity." }, { "code": "already_in_state", "type": null, "when": "The series is already of the requested type." }, { "code": "approval_missing", "type": null, "when": "The agreement's approval threshold was not met." } ] } }, "Params_us_series_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE", "WY" ], "description": "State of the parent entity.", "examples": [ "DE" ] }, "series_name": { "type": "string", "description": "Name of the series.", "examples": [ "Acme Holdings, LLC - Series A" ] }, "series_type": { "type": "string", "enum": [ "registered" ], "description": "Registered or protected.", "examples": [ "registered" ] }, "effective_date": { "type": "string", "format": "date", "description": "Future effective date of the filing, if the registry accepts one.", "examples": [ "2026-11-01" ] }, "business_purpose": { "type": "string", "description": "Purpose or activities of the series, if the certificate states one.", "examples": [ "Hold residential real estate" ] }, "manager": { "type": "string", "pattern": "^per_", "description": "Manager of the series if managed separately.", "examples": [ "per_0c41de" ] }, "authorised_person": { "type": "string", "pattern": "^per_", "description": "Authorised person who signs.", "examples": [ "per_0c41de" ] }, "expedite": { "type": "string", "enum": [ "none", "twenty_four_hour", "same_day", "two_hour", "one_hour" ], "description": "Optional expedite tier.", "examples": [ "none" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "series_name", "series_type", "name", "nature_of_business", "countries_of_operation", "general_partners", "members", "beneficial_owners" ], "description": "Files the certificate of registered series or the series designation so that a series is established as a registered series." }, "Create_us_series_register": { "type": "object", "properties": { "type": { "const": "us.series.register" }, "params": { "$ref": "#/components/schemas/Params_us_series_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a series of a Delaware LLC or LP, or designate a Wyoming series", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "series_llc", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "series_certificate", "title": "Certificate of registered series / series designation", "source": "generated", "required": true }, { "key": "constitution", "title": "LLC agreement or LP agreement showing series authority", "source": "uploaded", "required": true }, { "key": "members_resolution", "title": "Member or manager consent to establish the series", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "series_certificate", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "series_certificate", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Delaware Certificate of Registered Series", "channel": "online", "government_fee": { "amount": 110, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "series_not_authorised", "type": null, "when": "The LLC or LP agreement does not provide for series." }, { "code": "name_unavailable", "type": null, "when": "The series name is not available or does not meet the name rule." }, { "code": "state_not_supported", "type": null, "when": "State is not DE or WY." }, { "code": "registry_rejected", "type": null, "when": "The registry rejected the certificate." } ] } }, "Params_us_state_business_licence_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NV" ], "description": "Always NV for this action.", "examples": [ "NV" ] }, "nature_of_business": { "type": "string", "description": "Nature of business in Nevada, with NAICS code if known.", "examples": [ "Software development, NAICS 541511" ] }, "officers": { "type": "array", "items": {}, "description": "Officers, directors or managers shown on the filing: [{person: person_ref, title: string}].", "examples": [ "[{\"person\":\"per_8Hd2kQw1\",\"title\":\"President, Secretary, Treasurer\"}]" ] }, "nevada_address": { "$ref": "#/components/schemas/Address", "description": "Nevada business address if the entity has one.", "examples": [ "{\"line1\":\"1 S Main St\",\"city\":\"Las Vegas\",\"region\":\"NV\",\"postal_code\":\"89101\",\"country\":\"US\"}" ] }, "licence_class": { "type": "string", "enum": [ "corporation_class", "other_class", "exempt" ], "description": "Fee class.", "examples": [ "corporation_class" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "nature_of_business", "officers", "name", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Obtains the Nevada state business licence under NRS chapter 76 for an entity doing business in Nevada. Normally obtained with the initial list at formation; this action covers a standalone registration, for example for a foreign-qualified." }, "Create_us_state_business_licence_register": { "type": "object", "properties": { "type": { "const": "us.state_business_licence.register" }, "params": { "$ref": "#/components/schemas/Params_us_state_business_licence_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Nevada state business licence", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "llp", "professional_corp", "pllc", "public_benefit_corp", "close_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "state_business_licence", "title": "Nevada state business licence", "source": "registry_issued", "required": true }, { "key": "licence_application_data", "title": "Application data sheet", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Formation certificate or foreign qualification", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "licence_application_data", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Secretary of State: SilverFlume business portal", "form": "Application for state business licence, filed with the initial list", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "licence_already_active", "type": null, "when": "The entity already holds a current Nevada state business licence." }, { "code": "president_secretary_treasurer_missing", "type": null, "when": "A corporation's officer list lacks the required offices." }, { "code": "exemption_unverified", "type": null, "when": "licence_class is exempt and Entiva cannot confirm the exemption." }, { "code": "registered_agent_acceptance_missing", "type": null, "when": "No Nevada registered agent acceptance is on file." }, { "code": "registry_unavailable", "type": null, "when": "The SilverFlume portal is unavailable; the action is retried." } ] } }, "Params_us_state_tax_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State in which to register.", "examples": [ "TX" ] }, "registrations": { "type": "array", "items": {}, "description": "Registrations to make.", "examples": [ "[\"sales_use_tax\",\"payroll_withholding\",\"unemployment_insurance\"]" ] }, "nexus_start_date": { "type": "string", "format": "date", "description": "Date the entity starts activity in the state, such as hiring or sales.", "examples": [ "2026-11-01" ] }, "responsible_officer": { "type": "string", "pattern": "^per_", "description": "Officer, member or manager named on the registrations and who signs where the portal asks for a responsible person.", "examples": [ "per_8Hd2kQw1" ] }, "nature_of_business": { "type": "string", "description": "Description of products or services sold and any NAICS code.", "examples": [ "Software subscriptions, NAICS 511210" ] }, "physical_locations": { "type": "array", "items": {}, "description": "Addresses in the state as address objects.", "examples": [ "[{\"line1\":\"500 Congress Ave\",\"city\":\"Austin\",\"region\":\"TX\",\"postal_code\":\"78701\",\"country\":\"US\"}]" ] }, "first_payroll_date": { "type": "string", "format": "date", "description": "Date wages are first paid in the state.", "examples": [ "2026-11-15" ] }, "employee_count": { "type": "integer", "description": "Expected employees in the state in the next 12 months.", "examples": [ "3" ] }, "expected_monthly_taxable_sales": { "$ref": "#/components/schemas/Money", "description": "Expected monthly taxable sales in the state, for filing-frequency assignment.", "examples": [ "{\"amount\":\"15000\",\"currency\":\"USD\"}" ] }, "local_jurisdiction": { "type": "string", "description": "City or county for local business licences.", "examples": [ "Austin, Travis County" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "registrations", "nexus_start_date", "responsible_officer", "nature_of_business", "name", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers the entity with a state's tax agencies and local licensing offices: sales and use tax, payroll withholding, unemployment insurance and local business licences. Which registrations apply depends on the entity's activity in the." }, "Create_us_state_tax_register": { "type": "object", "properties": { "type": { "const": "us.state_tax.register" }, "params": { "$ref": "#/components/schemas/Params_us_state_tax_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "State tax and local business registrations", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "llp", "professional_corp", "pllc", "public_benefit_corp", "close_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "state_tax_registration_data", "title": "Registration data sheet", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Formation certificate", "source": "registry_issued", "required": false }, { "key": "ein_confirmation_letter", "title": "EIN confirmation", "source": "uploaded", "required": true }, { "key": "state_registration_certificate", "title": "State account numbers and certificates", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "state_tax_registration_data", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "State department of revenue or taxation, state workforce or unemployment agency and local ", "form": "State-specific", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "state_not_supported", "type": null, "when": "Entiva has no portal automation for this state; the action runs as a manual action with the officer filing." }, { "code": "ein_missing", "type": null, "when": "The entity has no EIN yet." }, { "code": "foreign_qualification_missing", "type": null, "when": "The entity is not registered to do business in the state; run foreign qualification first." }, { "code": "registration_not_available", "type": null, "when": "A requested registration does not exist in the state." }, { "code": "officer_identity_check_failed", "type": null, "when": "The state portal's own identity check for the responsible officer failed." } ] } }, "Params_us_statutory_trust_form": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation." }, "entity_type": { "type": "string", "enum": [ "statutory_trust" ], "description": "statutory_trust." }, "name": { "type": "string", "description": "Proposed legal name with the state's required designator." }, "name_reservation": { "type": "string", "description": "Active name reservation the filing consumes." }, "registered_agent": { "type": "object", "description": "{mode: 'entiva'|'own', name, address, consent_document}." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business, used for annual reports and tax registrations." }, "effective_date": { "type": "string", "format": "date", "description": "Delayed effective date where the state allows." }, "expedite": { "type": "string", "enum": [ "standard", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Expedite tier." }, "state_fields": { "type": "object", "description": "Extra fields the state's form needs; requirements[] names the keys." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person for the registered agent's records, where the state asks." }, "trustees": { "type": "array", "items": {}, "description": "Each {person or entity, delaware_trustee: boolean}." }, "settlors": { "type": "array", "items": {}, "description": "Sponsors, depositors or settlors who create or fund the trust." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Initial holders of beneficial interests: each {person or entity, percent}." }, "purpose": { "type": "string", "description": "Trust purpose or business." }, "series": { "type": "boolean", "description": "True if the trust will have separate series of assets and liabilities." }, "trust_agreement": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "Governing instrument: entiva_standard or custom." } }, "required": [ "state", "entity_type", "name", "trustees" ], "description": "Files the certificate of trust for a Delaware statutory trust or the equivalent in another state, naming the qualifying Delaware trustee." }, "Create_us_statutory_trust_form": { "type": "object", "properties": { "type": { "const": "us.statutory_trust.form" }, "params": { "$ref": "#/components/schemas/Params_us_statutory_trust_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form a statutory trust", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "certificate_of_trust", "title": "Certificate of trust", "source": "generated", "required": true }, { "key": "trustee_acceptance", "title": "Trustee acceptance", "source": "generated", "required": true }, { "key": "trust_agreement", "title": "Trust agreement or governing instrument", "source": "uploaded", "required": false }, { "key": "registered_agent_consent", "title": "Registered agent consent", "source": "generated", "required": false }, { "key": "ownership_chart", "title": "Ownership chart", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "State filing receipt", "source": "registry_issued", "required": true }, { "key": "filed_instrument", "title": "Stamped certificate of trust", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "settlor", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" }, { "role": "founder", "verification_level": "enhanced" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "trustees", "threshold": "unanimous", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "certificate_of_trust", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "certificate_of_trust", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "trustee_acceptance", "signer_role": "trustee", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "State Secretary of State or equivalent filing office", "form": "DE Certificate of Trust", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "requirements_incomplete", "type": null, "when": "Approved while requirements[] still has open items [requirement_error]." }, { "code": "sanctions_alert_open", "type": null, "when": "A party has an open sanctions alert, which pauses live actions [permission_error]." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step: selfie, consent to act, director consent or a perjury affirmation [permission_error]." }, { "code": "registry_rejected", "type": null, "when": "The state filing office rejected the filing; the action moves to rejected [registry_error]." }, { "code": "state_not_supported", "type": null, "when": "State and entity-type combination not yet available [jurisdiction_error]." }, { "code": "name_unavailable", "type": null, "when": "Name not distinguishable or already reserved [registry_error]." }, { "code": "name_designator_invalid", "type": null, "when": "Name lacks the designator the state requires [invalid_request_error]." }, { "code": "registered_agent_required", "type": null, "when": "No in-state agent named, or the agent has not accepted after OFAC screening [requirement_error]." }, { "code": "delaware_trustee_required", "type": null, "when": "No trustee satisfies the Delaware resident or principal-place-of-business rule (12 Del." }, { "code": "trust_agreement_review_required", "type": null, "when": "A custom trust agreement is waiting for attorney review." } ] } }, "Params_us_tax_exemption_apply": { "type": "object", "properties": { "form": { "type": "string", "enum": [ "1023", "1023_ez", "1024" ], "description": "Application form. 1023-EZ only if the organisation passes the IRS eligibility worksheet.", "examples": [ "1023" ] }, "exemption_category": { "type": "string", "description": "Code section, for example 501, or the 501 category for Form 1024.", "examples": [ "501(c)(3)" ] }, "ein": { "type": "string", "description": "The organisation's EIN.", "examples": [ "88-1234567" ] }, "mission": { "type": "string", "description": "Summary of purposes and activities.", "examples": [ "Educational programs for rural libraries" ] }, "officers": { "type": "array", "items": {}, "description": "Officers, directors and trustees with compensation where reported.", "examples": [ "[\"per_aa01\",\"per_aa02\",\"per_aa03\"]" ] }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "Officer or authorised person who signs under penalties of perjury.", "examples": [ "per_aa01" ] }, "fiscal_year_end": { "type": "string", "description": "Month and day of the accounting year end.", "examples": [ "12-31" ] }, "formation_date": { "type": "string", "format": "date", "description": "Date the organisation was formed; affects retroactive recognition.", "examples": [ "2026-09-01" ] }, "projected_revenue": { "$ref": "#/components/schemas/Money", "description": "Projected annual gross receipts; used to test 1023-EZ eligibility.", "examples": [ "{\"amount\":120000,\"currency\":\"USD\"}" ] }, "prepared_by": { "type": "string", "enum": [ "entiva_partner", "customer" ], "description": "Who prepares the narrative.", "examples": [ "entiva_partner" ] } }, "required": [ "form", "exemption_category", "ein", "mission", "officers", "signing_officer", "fiscal_year_end", "formation_date", "projected_revenue" ], "description": "Prepares and files the IRS exemption application for a nonprofit: Form 1023, the streamlined 1023-EZ, or Form 1024 for other 501 categories. Entiva it." }, "Create_us_tax_exemption_apply": { "type": "object", "properties": { "type": { "const": "us.tax_exemption.apply" }, "params": { "$ref": "#/components/schemas/Params_us_tax_exemption_apply" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Apply for federal tax-exempt status", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "nonprofit_corp", "unincorporated_nonprofit_association", "wy_duna", "corporation_sole", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "exemption_application", "title": "Form 1023 / 1023-EZ / 1024 with narrative", "source": "generated", "required": true }, { "key": "certificate_of_incorporation", "title": "Organising document", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Bylaws or governing principles", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Resolution authorising the application", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Financial data / budget projections", "source": "uploaded", "required": false }, { "key": "ein_letter", "title": "IRS EIN letter", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "Pay.gov confirmation", "source": "registry_issued", "required": true }, { "key": "determination_letter", "title": "IRS determination letter", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "exemption_application", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service via Pay.gov", "form": "Form 1023 / 1023-EZ / 1024", "channel": "online", "government_fee": { "amount": 600, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "ein_missing", "type": null, "when": "The organisation has no EIN." }, { "code": "form_ineligible", "type": null, "when": "1023-EZ was chosen but the eligibility test failed." }, { "code": "organising_document_defect", "type": null, "when": "The organising document lacks purpose or dissolution language." } ] } }, "Params_us_trade_name_assign": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code.", "examples": [ "WY" ] }, "trade_name": { "type": "string", "description": "The registered name.", "examples": [ "Bright Path Studio" ] }, "assignee": { "type": "string", "pattern": "^per_", "description": "New owner.", "examples": [ "per_9e22bb" ] }, "assignee_address": { "$ref": "#/components/schemas/Address", "description": "Address of the assignee.", "examples": [ "{\"line1\":\"22 Elm St\",\"city\":\"Casper\",\"state\":\"WY\",\"postal_code\":\"82601\",\"country\":\"US\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the assignment.", "examples": [ "2026-11-01" ] }, "owner": { "type": "string", "pattern": "^per_", "description": "Current owner or officer who signs.", "examples": [ "per_2d9e44" ] } }, "required": [ "state", "trade_name", "assignee", "assignee_address", "owner" ], "description": "Assigns a Wyoming trade name registration to a new owner." }, "Create_us_trade_name_assign": { "type": "object", "properties": { "type": { "const": "us.trade_name.assign" }, "params": { "$ref": "#/components/schemas/Params_us_trade_name_assign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Assign a trade name registration", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "sole_proprietorship", "general_partnership", "c_corp", "public_benefit_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "l3c", "wy_close_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trade_name_assignment", "title": "Assignment of trade name", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trade_name_assignment", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State", "form": "Trade name assignment", "channel": "both", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trade_name_not_found", "type": null, "when": "No such registration." }, { "code": "assignee_screening_hit", "type": null, "when": "Sanctions screening flagged the assignee." } ] } }, "Params_us_trade_name_cancel": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code.", "examples": [ "WY" ] }, "trade_name": { "type": "string", "description": "The registered name.", "examples": [ "Bright Path Studio" ] }, "effective_date": { "type": "string", "format": "date", "description": "Cancellation effective date.", "examples": [ "2026-12-31" ] }, "owner": { "type": "string", "pattern": "^per_", "description": "Owner or officer who signs.", "examples": [ "per_2d9e44" ] } }, "required": [ "state", "trade_name", "owner" ], "description": "Cancels a Wyoming trade name registration." }, "Create_us_trade_name_cancel": { "type": "object", "properties": { "type": { "const": "us.trade_name.cancel" }, "params": { "$ref": "#/components/schemas/Params_us_trade_name_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a trade name registration", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "sole_proprietorship", "general_partnership", "c_corp", "public_benefit_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "l3c", "wy_close_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trade_name_cancellation", "title": "Trade name cancellation form", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "trade_name_cancellation", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State", "form": "Trade name cancellation", "channel": "both", "government_fee": { "amount": 10, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trade_name_not_found", "type": null, "when": "No such registration." } ] } }, "Params_us_trade_name_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "WY" ] }, "trade_name": { "type": "string", "description": "Name to trade under.", "examples": [ "Bright Path Studio" ] }, "county": { "type": "string", "description": "County for county-level filing states.", "examples": [ "Clark" ] }, "business_description": { "type": "string", "description": "Nature of the business, if the form asks.", "examples": [ "Design services" ] }, "owner": { "type": "string", "pattern": "^per_", "description": "Owner or authorised officer who signs.", "examples": [ "per_2d9e44" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal place of business.", "examples": [ "{\"line1\":\"1 Main St\",\"city\":\"Cheyenne\",\"state\":\"WY\",\"postal_code\":\"82001\",\"country\":\"US\"}" ] }, "reserve_first": { "type": "boolean", "description": "Reserve the name before registering.", "examples": [ "false" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the name is to take effect.", "examples": [ "2026-11-01" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "name": { "type": "string", "description": "The entity's name as it will be registered, with any required suffix.", "x-entiva-need": "required" }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office or registered agent address in the jurisdiction.", "x-entiva-need": "provided" }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "managers": { "type": "array", "items": {}, "description": "For a manager-managed LLC: its managers.", "x-entiva-need": "optional" }, "general_partners": { "type": "array", "items": {}, "description": "General partners.", "x-entiva-need": "required" }, "members": { "type": "array", "items": {}, "description": "Founding members, with contributions or guarantees where relevant.", "x-entiva-need": "required" }, "shareholders": { "type": "array", "items": {}, "description": "Subscribers: person, share_class and number_of_shares for each, and the amount paid.", "x-entiva-need": "required" }, "share_classes": { "type": "array", "items": {}, "description": "The classes to create: name, currency, par value and rights.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "trade_name", "owner", "principal_office", "name", "nature_of_business", "countries_of_operation", "directors", "general_partners", "members", "shareholders", "share_classes", "beneficial_owners" ], "description": "Registers a trade name for an entity or sole proprietor: with the Secretary of State in Wyoming, otherwise with the state or county as that state requires." }, "Create_us_trade_name_register": { "type": "object", "properties": { "type": { "const": "us.trade_name.register" }, "params": { "$ref": "#/components/schemas/Params_us_trade_name_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register an assumed name / trade name / DBA", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "sole_proprietorship", "general_partnership", "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "statutory_trust", "wy_statutory_foundation", "l3c", "wy_close_llc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trade_name_application", "title": "Application for trade name registration / assumed name certificate", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Authority to use the name", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Filed registration / certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "trade_name_application", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State", "form": "Application for Trade Name Registration", "channel": "both", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_unavailable", "type": null, "when": "The trade name conflicts with an existing registration." }, { "code": "owner_not_verified", "type": null, "when": "" } ] } }, "Params_us_trade_name_renew": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code.", "examples": [ "WY" ] }, "trade_name": { "type": "string", "description": "The registered trade name.", "examples": [ "Bright Path Studio" ] }, "registration_number": { "type": "string", "description": "Registry number or filing ID.", "examples": [ "TN-2024-001234" ] }, "owner": { "type": "string", "pattern": "^per_", "description": "Owner or authorised officer who signs.", "examples": [ "per_2d9e44" ] } }, "required": [ "state", "trade_name", "owner" ], "description": "Renews a Wyoming trade name before it lapses; other states' renewal rules are routed to manual handling." }, "Create_us_trade_name_renew": { "type": "object", "properties": { "type": { "const": "us.trade_name.renew" }, "params": { "$ref": "#/components/schemas/Params_us_trade_name_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Renew a trade name registration", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "sole_proprietorship", "general_partnership", "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "statutory_trust", "wy_statutory_foundation", "l3c", "wy_close_llc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trade_name_renewal", "title": "Trade name renewal form", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Renewal receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "trade_name_renewal", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State", "form": "Trade name renewal", "channel": "both", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registration_lapsed", "type": null, "when": "The registration has already lapsed; a new registration is required." }, { "code": "trade_name_not_found", "type": null, "when": "No such registration on the entity." } ] } }, "Params_us_trust_agreement_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the entity." }, "trustees": { "type": "array", "items": {}, "description": "Each {person or entity, delaware_trustee}." }, "settlors": { "type": "array", "items": {}, "description": "Sponsors, depositors or settlors who sign." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Each {person or entity, percent}." }, "trustee_powers": { "type": "object", "description": "Powers, duties and limits of the trustees, including investment and distribution terms." }, "amendment_rules": { "type": "object", "description": "How the instrument may be amended and by whom." }, "template": { "type": "string", "enum": [ "entiva_standard", "custom" ], "description": "entiva_standard: Entiva's holding-trust agreement generated from governance; custom: upload your own, which Entiva reads into governance for review." }, "trust_agreement": { "type": "string", "pattern": "^doc_", "description": "Uploaded document, required when template is custom." }, "effective_date": { "type": "string", "format": "date", "description": "Date the document takes effect." } }, "description": "Adopts the governing instrument of a statutory trust and records it in the governance profile. Not filed with the state." }, "Create_us_trust_agreement_adopt": { "type": "object", "properties": { "type": { "const": "us.trust_agreement.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_trust_agreement_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt a statutory trust agreement", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "trust_agreement", "title": "Trust agreement", "source": "generated", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "settlor", "verification_level": "identity_address" }, { "role": "beneficiary", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "any_one", "method": "in_app" }, { "kind": "corporate", "body": "trustees", "threshold": "unanimous", "method": "written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "trust_agreement", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "trust_agreement", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "trust_agreement", "signer_role": "settlor", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None: internal document, not filed with the state", "form": "Trust agreement / governing instrument", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_not_active", "type": null, "when": "The entity has not been formed yet or is not in good standing in the registry." }, { "code": "document_already_in_force", "type": null, "when": "A governing document of this type is already in force; use the amendment action." }, { "code": "custom_document_unreadable", "type": null, "when": "" }, { "code": "signer_not_verified", "type": null, "when": "A signer has not completed verification." }, { "code": "human_presence_required", "type": null, "when": "An agent tried a personal step, such as a director's consent." }, { "code": "mandate_scope_exceeded", "type": null, "when": "The agent key's mandate does not cover this action type." }, { "code": "delaware_trustee_required", "type": null, "when": "No trustee satisfies the Delaware resident or principal-place-of-business rule." } ] } }, "Params_us_unincorporated_association_form": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE", "WY" ], "description": "State of formation.", "examples": [ "WY" ] }, "entity_type": { "type": "string", "enum": [ "unincorporated_nonprofit_association", "wy_duna" ], "description": "UNA or Wyoming DUNA.", "examples": [ "wy_duna" ] }, "name": { "type": "string", "description": "Name of the association.", "examples": [ "Harbor Commons DUNA" ] }, "purpose": { "type": "string", "description": "Common nonprofit purpose.", "examples": [ "Fund open-source maintainers" ] }, "governing_principles": { "type": "object", "description": "Governing principles or membership agreement; for a DUNA these may be smart contracts.", "examples": [ "{\"document\":\"doc_gp01\",\"contract_address\":\"0x00...\",\"chain\":\"ethereum\"}" ] }, "administrators": { "type": "array", "items": {}, "description": "People authorised to manage the association's affairs.", "examples": [ "[\"per_aa01\"]" ] }, "members": { "type": "array", "items": {}, "description": "Initial members as person or legal_entity refs with voting share where known.", "examples": [ "[{\"person\":\"per_aa01\",\"voting_percent\":40}]" ] }, "registered_agent": { "type": "string", "pattern": "^ent_", "description": "Agent for service of process.", "examples": [ "Entiva registered agent" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Agent's in-state address, when a statement appointing agent is filed.", "examples": [ "{\"line1\":\"30 N Gould St\",\"city\":\"Sheridan\",\"state\":\"WY\",\"postal_code\":\"82801\",\"country\":\"US\"}" ] }, "file_agent_statement": { "type": "boolean", "description": "Whether to file the optional statement appointing agent.", "examples": [ "true" ] }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person named to the registered agent (Delaware Reg. 101; Wyoming W.S. 17-28-104).", "examples": [ "per_aa01" ] }, "tax_classification": { "type": "string", "enum": [ "seek_501c3", "seek_other_501c", "taxable" ], "description": "Intended federal treatment.", "examples": [ "seek_501c3" ] }, "expedite": { "type": "string", "enum": [ "none", "twenty_four_hour", "same_day", "next_business_day" ], "description": "Optional expedite tier.", "examples": [ "none" ] }, "governance": { "type": "object", "description": "The entity's own rules: share_classes, signing_authority, board, approval_rules, transfer_restrictions and appointment_rights." }, "articles": { "type": "string", "enum": [ "model", "entiva_standard", "custom" ], "description": "model: the jurisdiction's statutory default articles; entiva_standard: Entiva's articles, generated from governance; custom: upload your own, which." }, "shareholders_agreement": { "type": "string", "enum": [ "none", "entiva_standard", "custom" ], "description": "none, Entiva's standard agreement generated from governance, or upload your own for review." }, "nature_of_business": { "type": "string", "description": "What the entity will do, in plain words; used for the registry's activity code and for due diligence.", "x-entiva-need": "required" }, "countries_of_operation": { "type": "array", "items": {}, "description": "Where it will do business, for due diligence and economic substance.", "x-entiva-need": "required" }, "directors": { "type": "array", "items": {}, "description": "Directors.", "x-entiva-need": "required" }, "company_secretary": { "type": "string", "pattern": "^per_", "description": "Required in Hong Kong and Singapore; Entiva's Entiva acts unless you appoint your own.", "x-entiva-need": "provided" }, "beneficial_owners": { "type": "array", "items": {}, "description": "Every individual who owns or controls 10% or more, directly or through others.", "x-entiva-need": "required" }, "financial_year_end": { "type": "string", "format": "date", "description": "Month and day.", "x-entiva-need": "optional" } }, "required": [ "state", "entity_type", "name", "purpose", "governing_principles", "administrators", "communications_contact", "nature_of_business", "countries_of_operation", "directors", "beneficial_owners" ], "description": "Creates a UNA or Wyoming DUNA by governing principles, with an optional statement appointing an agent for service of process. The association exists once formed by agreement; the filing is optional but Entiva files it by default to give." }, "Create_us_unincorporated_association_form": { "type": "object", "properties": { "type": { "const": "us.unincorporated_association.form" }, "params": { "$ref": "#/components/schemas/Params_us_unincorporated_association_form" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Form an unincorporated nonprofit association or Wyoming DUNA", "x-entiva": { "jurisdiction": "us", "stage": "formation", "applies_to": [ "unincorporated_nonprofit_association", "wy_duna" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "founder" ], "evidence": [ "founder_consent" ] }, "documents": [ { "key": "constitution", "title": "Governing principles / membership agreement", "source": "uploaded", "required": true }, { "key": "agent_statement", "title": "Statement appointing agent to receive service of process", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Registered agent consent", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Filed statement / registry receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "liquidator", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "constitution", "signer_role": "liquidator", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "agent_statement", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Governing principles", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "free", "errors": [ { "code": "entity_type_not_in_state", "type": null, "when": "DUNA requested outside Wyoming." }, { "code": "nonprofit_purpose_required", "type": null, "when": "Purpose is for profit distribution." }, { "code": "agent_acceptance_pending", "type": null, "when": "Registered agent has not accepted after OFAC screening." }, { "code": "name_unavailable", "type": null, "when": "The name is unavailable at the registry." } ] } }, "Params_us_annual_accounts_prepare": { "type": "object", "properties": { "fiscal_year_end": { "type": "string", "format": "date", "description": "Year-end the accounts are prepared to.", "examples": [ "2026-12-31" ] }, "accounting_basis": { "type": "string", "enum": [ "cash", "accrual" ], "description": "Cash or accrual.", "examples": [ "accrual" ] }, "bank_accounts": { "type": "array", "items": {}, "description": "Accounts to reconcile: institution, last four digits, currency.", "examples": [ "[{\"institution\":\"Mercury\",\"last4\":\"4821\",\"currency\":\"USD\"}]" ] }, "foreign_owned": { "type": "boolean", "description": "If true, the related-party ledger needed for Form 5472 is produced.", "examples": [ "true" ] }, "accounting_system": { "type": "string", "description": "Name of an existing system to import from.", "examples": [ "QuickBooks" ] }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of formation, to pick franchise tax inputs.", "examples": [ "DE" ] } }, "required": [ "fiscal_year_end", "bank_accounts" ], "description": "Closes the books for the year: reconciles bank and card feeds, produces trial balance, income statement and balance sheet, and the related-party ledger needed for Form 5472. Outputs feed the tax return and franchise tax inputs." }, "Create_us_annual_accounts_prepare": { "type": "object", "properties": { "type": { "const": "us.annual_accounts.prepare" }, "params": { "$ref": "#/components/schemas/Params_us_annual_accounts_prepare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare bookkeeping and year-end accounts", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "s_corp_election", "llc_single_member", "llc_multi_member", "lp", "llp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "bank_statements", "title": "Bank and card statements", "source": "uploaded", "required": true }, { "key": "ledger_export", "title": "Existing ledger export", "source": "uploaded", "required": false }, { "key": "year_end_accounts", "title": "Year-end accounts pack", "source": "generated", "required": true }, { "key": "related_party_ledger", "title": "Related-party transaction ledger", "source": "generated", "required": false } ], "people": [ { "role": "member", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "year_end_accounts", "signer_role": "member", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Internal books", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "statements_missing", "type": null, "when": "Gaps in bank statements for the period." }, { "code": "unreconciled_balance", "type": null, "when": "Reconciliation difference above tolerance; needs customer input." } ] } }, "Params_us_annual_list_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NV" ], "description": "Nevada.", "examples": [ "NV" ] }, "anniversary_month": { "type": "integer", "description": "Month of formation; the list is due the last day of that month unless the Secretary of State sets an alternative." }, "officers": { "type": "array", "items": {}, "description": "President, secretary and treasurer or equivalents, as person_refs." }, "directors": { "type": "array", "items": {}, "description": "Directors." }, "managers": { "type": "array", "items": {}, "description": "Managers or managing members." }, "authorised_stock_value": { "$ref": "#/components/schemas/Money", "description": "Total authorised stock value; sets the corporation list fee, which is tiered up to $11,125." }, "controller_concealment_declaration": { "type": "boolean", "description": "Confirms, under penalty of perjury, compliance with NRS ch. 76 and that no officer or director is listed to conceal a controller (NRS 78.150)." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "Payment method." } }, "required": [ "state", "controller_concealment_declaration", "payment_method" ], "description": "Files the Nevada annual list of officers, directors or managers and renews the state business licence. For corporations Entiva signs as the person the board specifically authorised (NRS 78.150)." }, "Create_us_annual_list_file": { "type": "object", "properties": { "type": { "const": "us.annual_list.file" }, "params": { "$ref": "#/components/schemas/Params_us_annual_list_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Nevada annual list and renew state business licence", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "close_corp", "public_benefit_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_list", "title": "Annual list of officers/managers", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board authorisation for Entiva to sign annual lists", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filing receipt and business licence", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "annual_list", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Nevada Secretary of State, SilverFlume", "form": "Annual List", "channel": "online", "government_fee": { "amount": 650, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "signing_authorisation_missing", "type": null, "when": "No board authorisation naming Entiva for corporations." }, { "code": "officer_titles_missing", "type": null, "when": "President, secretary or treasurer not recorded." }, { "code": "entity_revoked", "type": null, "when": "Charter revoked; reinstatement required." }, { "code": "declaration_not_confirmed", "type": null, "when": "controller_concealment_declaration is false." } ] } }, "Params_us_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Wyoming.", "examples": [ "WY" ] }, "report_year": { "type": "integer", "description": "Year of the anniversary month.", "examples": [ "2027" ] }, "wyoming_assets": { "$ref": "#/components/schemas/Money", "description": "Value of assets located in Wyoming; license tax is $60 or $0.0002 per dollar, whichever is greater." }, "officers": { "type": "array", "items": {}, "description": "Officers; corporations list officers and directors." }, "directors": { "type": "array", "items": {}, "description": "Directors, corporations." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person held by the agent, re-confirmed at each annual report (W.S. 17-28-107)." }, "registered_series_count": { "type": "integer", "description": "Series in a series LLC." }, "payment_method": { "type": "string", "enum": [ "card", "ach", "check" ], "description": "Card payments carry a 2.4% fee." } }, "required": [ "state", "report_year", "wyoming_assets", "communications_contact", "payment_method" ], "description": "Files the Wyoming annual report via WyoBiz, lists officers and directors for corporations, refreshes the registered agent's communications contact and pays the license tax." }, "Create_us_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Wyoming annual report and pay license tax", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "close_corp", "llc_single_member", "llc_multi_member", "series_llc", "lp", "llp", "wy_dao_llc", "wy_statutory_foundation", "nonprofit_corp", "statutory_trust", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Wyoming annual report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "WyoBiz receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "annual_report", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Annual Report", "channel": "both", "government_fee": { "amount": 60, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "efile_limit_exceeded", "type": null, "when": "Fee exceeds $500; switch to the paper/courier route." }, { "code": "entity_administratively_dissolved", "type": null, "when": "Not filed within 60 days of due date; reinstate." }, { "code": "report_already_filed", "type": null, "when": "Report for the period is on file." }, { "code": "communications_contact_missing", "type": null, "when": "No contact supplied." } ] } }, "Params_us_annual_tax_pay": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Delaware only.", "examples": [ "DE" ] }, "tax_year": { "type": "integer", "description": "Calendar year the tax is for; owed if the entity was active at any time in the year, no proration.", "examples": [ "2026" ] }, "registered_series_count": { "type": "integer", "description": "Number of registered series, each taxed separately." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "Payment method." } }, "required": [ "state", "tax_year", "payment_method" ], "description": "Pays the Delaware annual tax for LLCs, limited partnerships and general partnerships. No annual report is filed." }, "Create_us_annual_tax_pay": { "type": "object", "properties": { "type": { "const": "us.annual_tax.pay" }, "params": { "$ref": "#/components/schemas/Params_us_annual_tax_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay Delaware annual tax for an LLC, LP or GP", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "general_partnership" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_authorisation", "title": "Payment authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "payment_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Annual tax payment", "channel": "online", "government_fee": { "amount": 400, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "tax_already_paid", "type": null, "when": "Tax for the year is on record." }, { "code": "entity_cancelled", "type": null, "when": "Certificate cancelled; revive first." }, { "code": "unsupported_entity_type", "type": null, "when": "Entity type is not covered by this tax." } ] } }, "Params_us_apostille_request": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State whose authority issues the apostille: the state that issued the certified document or commissioned the notary.", "examples": [ "DE" ] }, "source_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the certified copy, good standing certificate or notarised document to apostille.", "examples": [ "doc_1QxQ3m" ] }, "destination_country": { "type": "string", "description": "ISO 3166 country where the document will be used.", "examples": [ "SG" ] }, "certification_type": { "type": "string", "enum": [ "apostille", "authentication" ], "description": "apostille for Hague Convention destinations; authentication for others.", "examples": [ "apostille" ] }, "quantity": { "type": "integer", "description": "Number of documents.", "examples": [ "1" ] }, "expedite": { "type": "string", "enum": [ "none", "same_day", "24_hour" ], "description": "Delaware same-day or 24-hour tier.", "examples": [ "none" ] }, "consular_legalisation": { "type": "boolean", "description": "Request onward legalisation at the destination's embassy or consulate.", "examples": [ "false" ] }, "delivery_address": { "$ref": "#/components/schemas/Address", "description": "Where to send the apostilled paper original, if paper.", "examples": [ "{\"line1\":\"1 Raffles Place\",\"city\":\"Singapore\",\"country\":\"SG\"}" ] } }, "required": [ "state", "source_document", "destination_country" ], "description": "Requests an apostille or an authentication from the competent authority of the state that issued or notarised the document, so it can be used abroad." }, "Create_us_apostille_request": { "type": "object", "properties": { "type": { "const": "us.apostille.request" }, "params": { "$ref": "#/components/schemas/Params_us_apostille_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order an apostille or authentication for a state-issued document", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "source_document", "title": "Certified or notarised document to apostille", "source": "uploaded", "required": true }, { "key": "apostille", "title": "Apostille or authentication certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "source_document", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Competent authority: Secretary of State in most states including DE, WY and NV. Exceptions", "form": "Apostille", "channel": "both", "government_fee": { "amount": 30, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "wrong_issuing_state", "type": null, "when": "Document was issued or notarised in a different state from the one requested." }, { "code": "document_not_eligible", "type": null, "when": "Document is not a state-issued or state-notarised document." }, { "code": "destination_not_hague", "type": null, "when": "certification_type is apostille but the destination is not a Hague Convention member." }, { "code": "notarisation_required", "type": null, "when": "Company-signed document with no notarial act." } ] } }, "Params_us_bea_quarterly_survey_file": { "type": "object", "properties": { "quarter": { "type": "string", "enum": [ "Q1", "Q2", "Q3", "Q4" ], "description": "Quarter being reported.", "examples": [ "Q3" ] }, "year": { "type": "integer", "description": "Calendar year of the quarter.", "examples": [ "2026" ] }, "foreign_parent": { "type": "string", "pattern": "^ent_", "description": "Directly owning foreign parent." }, "transactions": { "type": "array", "items": {}, "description": "Transactions and positions with the foreign parent and affiliates in the quarter." }, "bea_contact": { "type": "string", "pattern": "^per_", "description": "Contact for BEA queries." } }, "required": [ "quarter", "year", "foreign_parent", "transactions", "bea_contact" ], "description": "Files the BE-605 quarterly report for directly owned US affiliates with assets, sales or net income over $500 million. Due within 30 days of quarter-end." }, "Create_us_bea_quarterly_survey_file": { "type": "object", "properties": { "type": { "const": "us.bea_quarterly_survey.file" }, "params": { "$ref": "#/components/schemas/Params_us_bea_quarterly_survey_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the BEA BE-605 quarterly report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "wy_dao_llc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "intercompany_ledger", "title": "Intercompany transaction ledger", "source": "uploaded", "required": true }, { "key": "bea_survey_form", "title": "BE-605 report", "source": "generated", "required": true }, { "key": "bea_confirmation", "title": "BEA eFile confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "bea_survey_form", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "US Bureau of Economic Analysis", "form": "BE-605", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "below_reporting_threshold", "type": null, "when": "The affiliate does not exceed the $500 million assets, sales or net income test." }, { "code": "deadline_passed", "type": null, "when": "Quarter deadline has passed." }, { "code": "ledger_missing", "type": null, "when": "No intercompany ledger uploaded." } ] } }, "Params_us_boi_report_change": { "type": "object", "properties": { "update_type": { "type": "string", "enum": [ "update", "correction" ], "description": "Change or error." }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change; for corrections, the date the error was discovered." }, "changes": { "type": "object", "description": "What changed: added or removed beneficial owners, changed names, addresses or ID documents, company details." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Current non-US beneficial owners after the change." }, "fincen_ids": { "type": "object", "description": "Optional FinCEN IDs." } }, "required": [ "update_type", "effective_date", "changes" ], "description": "Files an updated BOIR within 30 days of a change, or a corrected BOIR within 30 days of learning of an error, for a foreign reporting company." }, "Create_us_boi_report_change": { "type": "object", "properties": { "type": { "const": "us.boi_report.change" }, "params": { "$ref": "#/components/schemas/Params_us_boi_report_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Update or correct a FinCEN beneficial ownership report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "foreign_company", "c_corp", "llc_single_member", "llc_multi_member", "lp", "llp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "third_party_filer_authorisation", "title": "Filing authorisation", "source": "generated", "required": true }, { "key": "passport", "title": "New or updated identity document image", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "FinCEN confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "third_party_filer_authorisation", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "FinCEN BOI E-Filing", "form": "BOIR", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_initial_report", "type": null, "when": "No prior BOIR on record; use us.boi_report.file." }, { "code": "exempt_domestic_entity", "type": null, "when": "US-formed entity; no report." }, { "code": "deadline_passed", "type": null, "when": "Past 30 days." } ] } }, "Params_us_boi_report_file": { "type": "object", "properties": { "registration_state": { "type": "string", "description": "State or tribal jurisdiction where the foreign entity registered to do business.", "examples": [ "NY" ] }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 country of formation, with subdivision if any.", "examples": [ "GB" ] }, "registration_effective_date": { "type": "string", "format": "date", "description": "Date of notice that the US registration is effective; starts the 30-day clock." }, "tax_identification": { "type": "object", "description": "EIN, or foreign tax ID with issuing country." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Non-US individuals who own or control 25% or more, directly or indirectly, or exercise substantial control." }, "company_applicants": { "type": "array", "items": {}, "description": "Up to two individuals: the one who filed the state registration and the one primarily responsible for directing it." }, "fincen_ids": { "type": "object", "description": "Optional map of person to FinCEN ID, used instead of ID document details." } }, "required": [ "registration_state", "home_jurisdiction", "registration_effective_date", "tax_identification", "beneficial_owners" ], "description": "Files the initial BOIR with FinCEN for an entity formed under foreign law and registered to do business in a US state. US-formed entities are exempt and the action is refused for them." }, "Create_us_boi_report_file": { "type": "object", "properties": { "type": { "const": "us.boi_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_boi_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File FinCEN beneficial ownership report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "foreign_company", "c_corp", "llc_single_member", "llc_multi_member", "lp", "llp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "third_party_filer_authorisation", "title": "Authorisation for Entiva to file as third-party service provider", "source": "generated", "required": true }, { "key": "passport", "title": "Identity document image for each reported individual", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "FinCEN filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "applicant", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "third_party_filer_authorisation", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "FinCEN BOI E-Filing", "form": "Beneficial Ownership Information Report", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "exempt_domestic_entity", "type": null, "when": "Entity is formed in the US; no BOI report is required." }, { "code": "no_reportable_individuals", "type": null, "when": "All owners and applicants are US persons; nothing to report beyond the entity." }, { "code": "beneficial_owner_unverified", "type": null, "when": "A reported person has not completed verification." }, { "code": "deadline_passed", "type": null, "when": "30 days have passed; late filing exposes the company to penalties." } ] } }, "Params_us_certified_copy_request": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Issuing state.", "examples": [ "DE" ] }, "documents": { "type": "array", "items": {}, "description": "Filed documents to certify: type, filing_date, optional page_count.", "examples": [ "[{\"type\":\"formation\",\"filing_date\":\"2024-03-12\",\"page_count\":3}]" ] }, "copies": { "type": "integer", "description": "Certified copies of each document.", "examples": [ "1" ] }, "expedite": { "type": "string", "enum": [ "none", "same_day", "24_hour" ], "description": "Delaware same-day or 24-hour tier.", "examples": [ "none" ] }, "delivery": { "type": "string", "enum": [ "electronic", "paper" ], "description": "Electronic or paper.", "examples": [ "electronic" ] }, "apostille_required": { "type": "boolean", "description": "If true, chains a us.apostille.order action.", "examples": [ "false" ] }, "destination_country": { "type": "string", "description": "ISO country of use, for the apostille.", "examples": [ "GB" ] } }, "required": [ "state", "documents" ], "description": "Orders a certified copy of a document the entity filed with the state, for banks, foreign registries or apostille." }, "Create_us_certified_copy_request": { "type": "object", "properties": { "type": { "const": "us.certified_copy.request" }, "params": { "$ref": "#/components/schemas/Params_us_certified_copy_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order certified copies of filed documents", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_copy", "title": "Certified copy", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "certified_copy", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or Division of Corporations", "form": "Request for certified copy", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "document_not_found", "type": null, "when": "No filing matches the type and date." }, { "code": "page_count_required", "type": null, "when": "Per-page states and unknown page count; Entiva looks it up and may re-quote." }, { "code": "unsupported_expedite", "type": null, "when": "State does not offer the tier." } ] } }, "Params_us_commerce_tax_exemption_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NV" ], "description": "Nevada only.", "examples": [ "NV" ] }, "fiscal_year": { "type": "string", "description": "Commerce tax year July 1 to June 30.", "examples": [ "2026-27" ] }, "nevada_gross_revenue": { "$ref": "#/components/schemas/Money", "description": "Gross revenue from Nevada sources; must not exceed $4,000,000." }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer or authorised person who attests." } }, "required": [ "state", "fiscal_year", "nevada_gross_revenue", "signer" ], "description": "Files the Exempt Status Entity Form for a business whose Nevada gross revenue is below the $4,000,000 Commerce Tax threshold. Due on the same date as the Commerce Tax return." }, "Create_us_commerce_tax_exemption_file": { "type": "object", "properties": { "type": { "const": "us.commerce_tax_exemption.file" }, "params": { "$ref": "#/components/schemas/Params_us_commerce_tax_exemption_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Nevada Exempt Status Entity Form", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "sole_proprietorship", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "revenue_report", "title": "Nevada revenue workpaper", "source": "uploaded", "required": false }, { "key": "exempt_status_form", "title": "Exempt Status Entity Form", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "My Nevada Tax confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "exempt_status_form", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Department of Taxation", "form": "Exempt Status Entity Form", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "revenue_above_threshold", "type": null, "when": "Nevada gross revenue exceeds $4,000,000; use us.commerce_tax_return.file." }, { "code": "deadline_passed", "type": null, "when": "Due date has passed." }, { "code": "registry_rejected", "type": null, "when": "The portal rejects the form." } ] } }, "Params_us_commerce_tax_return_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NV" ], "description": "Nevada only.", "examples": [ "NV" ] }, "fiscal_year": { "type": "string", "description": "Commerce tax year running July 1 to June 30, for example 2026-27.", "examples": [ "2026-27" ] }, "nevada_gross_revenue": { "$ref": "#/components/schemas/Money", "description": "Gross revenue from Nevada sources for the year." }, "industry_code": { "type": "string", "description": "Industry classification used to set the rate." }, "deductions": { "$ref": "#/components/schemas/Money", "description": "Deductions claimed, as the Department's rules allow." }, "modified_business_tax_credit": { "$ref": "#/components/schemas/Money", "description": "Credit against the Modified Business Tax claimed under the Department's criteria." }, "extension_requested": { "type": "boolean", "description": "True requests the 30-day extension.", "examples": [ "false" ] }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer or authorised person who approves the return." }, "payment_method": { "type": "string", "enum": [ "ach", "card" ], "description": "How the tax is paid.", "examples": [ "ach" ] } }, "required": [ "state", "fiscal_year", "nevada_gross_revenue", "industry_code", "signer" ], "description": "Files the Nevada Commerce Tax return through My Nevada Tax. Tax is due only on Nevada gross revenue above $4,000,000 a year, at industry-specific rates." }, "Create_us_commerce_tax_return_file": { "type": "object", "properties": { "type": { "const": "us.commerce_tax_return.file" }, "params": { "$ref": "#/components/schemas/Params_us_commerce_tax_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Nevada Commerce Tax return", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "sole_proprietorship", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "revenue_report", "title": "Nevada revenue workpaper", "source": "uploaded", "required": true }, { "key": "commerce_tax_return", "title": "Commerce Tax return", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "My Nevada Tax confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "commerce_tax_return", "signer_role": "authorised_representative", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Department of Taxation", "form": "Commerce Tax Return", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "below_threshold_use_exempt_form", "type": null, "when": "Nevada gross revenue is $4,000,000 or less; file the exempt status form instead." }, { "code": "industry_code_missing", "type": null, "when": "No industry classification provided." }, { "code": "deadline_passed", "type": null, "when": "The return or extension date has passed." }, { "code": "registry_rejected", "type": null, "when": "My Nevada Tax rejects the return." } ] } }, "Params_us_exempt_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Fixed to DE for this action.", "examples": [ "DE" ] }, "report_year": { "type": "integer", "description": "Year the report is due.", "examples": [ "2027" ] }, "file_number": { "type": "string", "description": "Delaware entity file number.", "examples": [ "1234567" ] }, "directors": { "type": "array", "items": {}, "description": "Current directors: name and address.", "examples": [ "[\"per_1Qy1a\",\"per_1Qy1b\"]" ] }, "officers": { "type": "array", "items": {}, "description": "Current principal officers with titles.", "examples": [ "[{\"person\":\"per_1Qy1a\",\"title\":\"President\"}]" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Current registered office.", "examples": [ "{\"line1\":\"8 The Green\",\"city\":\"Dover\",\"region\":\"DE\",\"postal_code\":\"19901\",\"country\":\"US\"}" ] }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal address, if the report asks for it.", "examples": [ "{\"line1\":\"1 Main St\",\"city\":\"Wilmington\",\"region\":\"DE\",\"postal_code\":\"19801\",\"country\":\"US\"}" ] }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "Officer who signs the report.", "examples": [ "per_1Qy1a" ] } }, "required": [ "state", "report_year", "file_number", "directors", "officers", "signing_officer" ], "description": "Files the annual report for a Delaware exempt corporation with the Division of Corporations by March 1; $25 fee, no franchise tax." }, "Create_us_exempt_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.exempt_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_exempt_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Delaware exempt domestic corporation annual report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Annual report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "annual_report", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Annual Report", "channel": "online", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_exempt_corporation", "type": null, "when": "Entity is not a Delaware exempt domestic corporation; use us.annual_report.file." }, { "code": "stale_officer_data", "type": null, "when": "Officer or director register is out of date." }, { "code": "report_already_filed", "type": null, "when": "A report for that year is on record." } ] } }, "Params_us_exempt_postcard_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Tax year being reported.", "examples": [ "2026" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Last day of the tax year.", "examples": [ "2026-12-31" ] }, "gross_receipts": { "$ref": "#/components/schemas/Money", "description": "Annual gross receipts." }, "ein": { "type": "string", "description": "Defaults to the EIN on the entity record." }, "principal_officer": { "type": "string", "pattern": "^per_", "description": "Name and address of the principal officer to report." }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Organization mailing address." }, "website": { "type": "string", "description": "Website address if any." }, "terminated": { "type": "boolean", "description": "True if the organization has ceased operations.", "examples": [ "false" ] } }, "required": [ "tax_year", "fiscal_year_end", "gross_receipts", "principal_officer", "mailing_address" ], "description": "Files the Form 990-N e-Postcard for a tax-exempt organization with normally $50,000 or less in gross receipts. Due on the 15th day of the 5th month after year-end; the 990-N cannot be extended." }, "Create_us_exempt_postcard_file": { "type": "object", "properties": { "type": { "const": "us.exempt_postcard.file" }, "params": { "$ref": "#/components/schemas/Params_us_exempt_postcard_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Form 990-N e-Postcard", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "nonprofit_corp", "unincorporated_nonprofit_association", "wy_duna", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "exempt_postcard", "title": "Form 990-N data sheet", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS e-Postcard acknowledgment", "source": "registry_issued", "required": true }, { "key": "irs_exemption_letter", "title": "IRS determination letter", "source": "uploaded", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "exempt_postcard", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 990-N", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "gross_receipts_above_990n_limit", "type": null, "when": "Gross receipts exceed the 990-N limit; use us.exempt_return.file." }, { "code": "exempt_status_not_recorded", "type": null, "when": "No exemption determination is on file for the entity." }, { "code": "exemption_revoked", "type": null, "when": "IRS records show automatic revocation after three missed years." }, { "code": "duplicate_filing", "type": null, "when": "A 990-N for this tax year was already submitted." } ] } }, "Params_us_exempt_return_file": { "type": "object", "properties": { "form": { "type": "string", "enum": [ "990-EZ", "990", "990-PF" ], "description": "Return type.", "examples": [ "990-EZ" ] }, "tax_year": { "type": "integer", "description": "Tax year being reported.", "examples": [ "2026" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Last day of the tax year.", "examples": [ "2026-12-31" ] }, "gross_receipts": { "$ref": "#/components/schemas/Money", "description": "Total gross receipts." }, "total_assets": { "$ref": "#/components/schemas/Money", "description": "Year-end total assets." }, "private_foundation": { "type": "boolean", "description": "True forces Form 990-PF.", "examples": [ "false" ] }, "officers": { "type": "array", "items": {}, "description": "Officers, directors, trustees and key employees as person references with compensation, for the Part on governance and pay." }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer who signs Form 8879-EO." }, "extension_filed": { "type": "boolean", "description": "True if Form 8868 is already on file so the extended due date applies.", "examples": [ "false" ] }, "schedules": { "type": "array", "items": {}, "description": "Schedules required by the answers, for example Schedule B; Entiva lists those it needs as requirements." } }, "required": [ "form", "tax_year", "fiscal_year_end", "gross_receipts", "total_assets", "private_foundation", "officers", "signer" ], "description": "Files the annual information return of a tax-exempt organization that is above the 990-N limit, or a private foundation. Due on the 15th day of the 5th month after year-end; Form 8868 gives an automatic 6-month extension." }, "Create_us_exempt_return_file": { "type": "object", "properties": { "type": { "const": "us.exempt_return.file" }, "params": { "$ref": "#/components/schemas/Params_us_exempt_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Form 990, 990-EZ or 990-PF", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "nonprofit_corp", "unincorporated_nonprofit_association", "wy_duna", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Year-end financial statements", "source": "uploaded", "required": true }, { "key": "exempt_return", "title": "Draft Form 990-series return", "source": "generated", "required": true }, { "key": "form_8879_eo", "title": "IRS e-file signature authorization", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS e-file acknowledgment", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "form_8879_eo", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRS Modernized e-File", "form": "Form 990-EZ, Form 990 or Form 990-PF", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "wrong_return_type", "type": null, "when": "Receipts, assets or foundation status do not match the chosen form." }, { "code": "financial_statements_missing", "type": null, "when": "No year-end financials were uploaded." }, { "code": "exemption_revoked", "type": null, "when": "IRS records show automatic revocation; a new application is needed." }, { "code": "mef_rejected", "type": null, "when": "MeF rejects the return; the reject codes are returned in the requirement." } ] } }, "Params_us_exempt_return_extension_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Tax year of the return being extended.", "examples": [ "2026" ] }, "form": { "type": "string", "enum": [ "990-EZ", "990", "990-PF" ], "description": "Return to be extended. 990-N is not accepted.", "examples": [ "990" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Last day of the tax year.", "examples": [ "2026-12-31" ] }, "tentative_payment": { "$ref": "#/components/schemas/Money", "description": "Any tax payment sent with the extension; no payment for most filers." }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer who approves the request." } }, "required": [ "tax_year", "form", "fiscal_year_end", "signer" ], "description": "Files Form 8868 to extend the due date of Form 990-EZ, 990 or 990-PF by 6 months. The 990-N e-Postcard cannot be extended." }, "Create_us_exempt_return_extension_file": { "type": "object", "properties": { "type": { "const": "us.exempt_return_extension.file" }, "params": { "$ref": "#/components/schemas/Params_us_exempt_return_extension_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request an automatic 6-month extension for a 990-series return", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "nonprofit_corp", "unincorporated_nonprofit_association", "wy_duna", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_8868", "title": "Form 8868 application for extension", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS acknowledgment of the extension", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "form_8868", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 8868", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_not_extendable", "type": null, "when": "Form 990-N was selected; it cannot be extended." }, { "code": "deadline_passed", "type": null, "when": "The original due date has passed." }, { "code": "duplicate_filing", "type": null, "when": "An extension for this tax year is already on file." } ] } }, "Params_us_fbar_file": { "type": "object", "properties": { "calendar_year": { "type": "integer", "description": "Calendar year being reported.", "examples": [ "2026" ] }, "accounts": { "type": "array", "items": {}, "description": "Each foreign financial account: financial institution name and address, country, account type, account number, maximum value during the year, and joint owners." }, "signature_authority_only": { "type": "array", "items": {}, "description": "Foreign accounts over which the entity has signature authority but no ownership, with the owner's details." }, "authorised_officer": { "type": "string", "pattern": "^per_", "description": "Officer who signs the Form 114a record of authorisation." }, "consolidated_filing": { "type": "boolean", "description": "True where the filing covers subsidiaries; subsidiary entities are then listed as entity references.", "examples": [ "false" ] } }, "required": [ "calendar_year", "accounts", "authorised_officer" ], "description": "Files the Report of Foreign Bank and Financial Accounts for a US entity through BSA E-Filing. Due April 15 after the calendar year, with an automatic extension to October 15." }, "Create_us_fbar_file": { "type": "object", "properties": { "type": { "const": "us.fbar.file" }, "params": { "$ref": "#/components/schemas/Params_us_fbar_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File an FBAR", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_account_statements", "title": "Foreign account statements", "source": "uploaded", "required": true }, { "key": "fbar_authorisation", "title": "FinCEN Form 114a record of authorisation to electronically file", "source": "generated", "required": true }, { "key": "fbar_report", "title": "FinCEN Form 114", "source": "generated", "required": true }, { "key": "bsa_acknowledgment", "title": "BSA E-Filing acknowledgment", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "fbar_authorisation", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "fbar_report", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "FinCEN BSA E-Filing", "form": "FinCEN Form 114", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "accounts_missing", "type": null, "when": "No foreign accounts or maximum values supplied." }, { "code": "statements_missing", "type": null, "when": "Supporting statements were not uploaded." }, { "code": "authorisation_not_signed", "type": null, "when": "Form 114a is unsigned." }, { "code": "deadline_passed", "type": null, "when": "Filing after October 15; a late-filing note and penalty warning are added." } ] } }, "Params_us_federal_return_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Tax year or fiscal year being filed.", "examples": [ "2025" ] }, "return_form": { "type": "string", "enum": [ "1120", "1120-S", "1065", "990" ], "description": "Form to file." }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Year end; fixes the due date." }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer, partner or member, principal officer." }, "extension_filed": { "type": "boolean", "description": "True if Form 7004 or 8868 was filed." }, "preparer": { "type": "string", "pattern": "^ent_", "description": "Paid preparer with a PTIN." }, "payment_method": { "type": "string", "enum": [ "card", "ach", "none" ], "description": "For any tax due." } }, "required": [ "tax_year", "return_form", "fiscal_year_end", "signer" ], "description": "Prepares and e-files the entity's federal return through Entiva's authorised e-file provider after the officer signs the e-file authorisation by PIN." }, "Create_us_federal_return_file": { "type": "object", "properties": { "type": { "const": "us.federal_return.file" }, "params": { "$ref": "#/components/schemas/Params_us_federal_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File federal income tax return", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "s_corp_election", "llc_multi_member", "lp", "llp", "lllp", "general_partnership", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Financial statements or trial balance", "source": "uploaded", "required": true }, { "key": "federal_return", "title": "Prepared return", "source": "generated", "required": true }, { "key": "efile_authorisation", "title": "E-file signature authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "IRS acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "efile_authorisation", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRS, Modernized e-File", "form": "Form 1120", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "wrong_return_form", "type": null, "when": "Form does not match the entity's tax classification." }, { "code": "ein_missing", "type": null, "when": "No EIN on record." }, { "code": "efile_rejected", "type": null, "when": "IRS rejected the e-file; reason attached." }, { "code": "foreign_owned_disregarded_entity", "type": null, "when": "Entity must paper-file pro forma 1120 with Form 5472; handled by another action." } ] } }, "Params_us_federal_return_extension_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Tax year to extend.", "examples": [ "2026" ] }, "return_form": { "type": "string", "enum": [ "1120", "1120-S", "1065", "990" ], "description": "Return being extended." }, "estimated_tax_due": { "$ref": "#/components/schemas/Money", "description": "Estimated tax to pay with the extension." }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer or partner who authorises." } }, "required": [ "tax_year", "return_form", "signer" ], "description": "Files Form 7004 or Form 8868 to extend the time to file the federal return." }, "Create_us_federal_return_extension_file": { "type": "object", "properties": { "type": { "const": "us.federal_return_extension.file" }, "params": { "$ref": "#/components/schemas/Params_us_federal_return_extension_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File federal return extension", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "s_corp_election", "llc_multi_member", "lp", "llp", "lllp", "general_partnership", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "extension_authorisation", "title": "Extension authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "IRS acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "extension_authorisation", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 7004", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_passed", "type": null, "when": "The original due date has passed." }, { "code": "ein_missing", "type": null, "when": "No EIN on record." }, { "code": "efile_rejected", "type": null, "when": "IRS rejected the submission." } ] } }, "Params_us_financial_statements_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State whose report uses the figures.", "examples": [ "DE" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "End of the period the figures cover.", "examples": [ "2026-12-31" ] }, "total_gross_assets": { "$ref": "#/components/schemas/Money", "description": "Total gross assets per Form 1120 Schedule L.", "examples": [ "{\"amount\":1250000,\"currency\":\"USD\"}" ] }, "wyoming_assets": { "$ref": "#/components/schemas/Money", "description": "Value of assets located and employed in Wyoming.", "examples": [ "{\"amount\":0,\"currency\":\"USD\"}" ] }, "financial_statements": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the statements or trial balance supporting the figures.", "examples": [ "doc_1QxS1p" ] }, "target_action": { "type": "string", "description": "act_ id of the us.annual_report.file or us.franchise_tax.pay action that will use these figures.", "examples": [ "act_1QxS9q" ] } }, "required": [ "state", "fiscal_year_end" ], "description": "There is no financial-statements filing for private companies in Delaware, Wyoming or Nevada. Nothing is filed." }, "Create_us_financial_statements_file": { "type": "object", "properties": { "type": { "const": "us.financial_statements.file" }, "params": { "$ref": "#/components/schemas/Params_us_financial_statements_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record financial-statement figures for registry reports", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Financial statements or trial balance", "source": "uploaded", "required": false }, { "key": "filing_determination", "title": "Filing determination memo", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "filing_determination", "signer_role": "officer", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None for private companies in DE, WY or NV", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "figures_inconsistent", "type": null, "when": "Figures contradict the ledger held by Entiva." }, { "code": "state_not_covered", "type": null, "when": "" } ] } }, "Params_us_foreign_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Delaware.", "examples": [ "DE" ] }, "report_year": { "type": "integer", "description": "Year of the June 30 due date.", "examples": [ "2027" ] }, "home_jurisdiction": { "type": "string", "description": "State or country of incorporation.", "examples": [ "CA" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "Officer who signs." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "Payment method." } }, "required": [ "state", "report_year", "home_jurisdiction", "officer", "payment_method" ], "description": "Files the annual report of a non-Delaware corporation qualified to do business in Delaware." }, "Create_us_foreign_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.foreign_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_foreign_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Delaware foreign corporation annual report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "foreign_annual_report", "title": "Foreign Corporation Annual Report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "foreign_annual_report", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Foreign Corporation Annual Report", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "report_already_filed", "type": null, "when": "A report for the year is on file." }, { "code": "not_qualified_in_state", "type": null, "when": "Entity has no Delaware foreign qualification." } ] } }, "Params_us_form_1042_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Calendar year of payment.", "examples": [ "2026" ] }, "recipients": { "type": "array", "items": {}, "description": "Each foreign recipient: person_ref or entity_ref, country, income code, gross income, tax withheld, chapter 3 and chapter 4 status, and the W-8 on file." }, "withholding_deposits": { "$ref": "#/components/schemas/Money", "description": "Total tax deposited during the year, for reconciliation on Form 1042." }, "withholding_agent_contact": { "type": "string", "pattern": "^per_", "description": "Officer who approves and signs." }, "include_form_1042": { "type": "boolean", "description": "True files the annual Form 1042 together with the 1042-S forms.", "examples": [ "true" ] } }, "required": [ "tax_year", "recipients", "withholding_agent_contact" ], "description": "Files Form 1042-S for US-source FDAP income paid to foreign persons and the annual Form 1042 withholding return. Both 1042-S copies are due March 15 to the IRS and recipients." }, "Create_us_form_1042_file": { "type": "object", "properties": { "type": { "const": "us.form_1042.file" }, "params": { "$ref": "#/components/schemas/Params_us_form_1042_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Forms 1042-S and 1042 for payments to foreign persons", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "sole_proprietorship", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_w8", "title": "Recipient Form W-8", "source": "uploaded", "required": true }, { "key": "payment_ledger", "title": "Payments ledger", "source": "uploaded", "required": true }, { "key": "information_return", "title": "Forms 1042-S and 1042", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS acknowledgment", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "recipient", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "information_return", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 1042-S and Form 1042", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "w8_missing", "type": null, "when": "A recipient has no valid W-8 on file." }, { "code": "withholding_mismatch", "type": null, "when": "Withheld amounts do not reconcile with deposits." }, { "code": "recipient_sanctions_hit", "type": null, "when": "A recipient triggers a screening alert." }, { "code": "irs_rejected", "type": null, "when": "IRS e-file rejects the batch." } ] } }, "Params_us_form_1099_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Calendar year of payment.", "examples": [ "2026" ] }, "form": { "type": "string", "enum": [ "1099-NEC", "1099-MISC" ], "description": "Return type.", "examples": [ "1099-NEC" ] }, "payees": { "type": "array", "items": {}, "description": "Each payee: person_ref or entity_ref, TIN, amount paid, box mapping, and backup-withholding amount if any." }, "reporting_threshold": { "$ref": "#/components/schemas/Money", "description": "Defaults to the threshold in force for the tax year." }, "payer_contact": { "type": "string", "pattern": "^per_", "description": "Payer contact and approver." }, "state_filing": { "type": "boolean", "examples": [ "false" ] } }, "required": [ "tax_year", "form", "payees", "payer_contact" ], "description": "Files Form 1099-NEC and Form 1099-MISC with the IRS and furnishes recipient copies. 1099-NEC is due January 31 to the IRS and recipients." }, "Create_us_form_1099_file": { "type": "object", "properties": { "type": { "const": "us.form_1099.file" }, "params": { "$ref": "#/components/schemas/Params_us_form_1099_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Forms 1099-NEC / 1099-MISC for contractor payments", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "sole_proprietorship", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_w9", "title": "Payee Form W-9", "source": "uploaded", "required": true }, { "key": "payment_ledger", "title": "Payments ledger for the tax year", "source": "uploaded", "required": true }, { "key": "information_return", "title": "Forms 1099 as filed", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS e-file acknowledgment", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "information_return", "signer_role": "filing_agent", "method": "none", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 1099-NEC / 1099-MISC", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "w9_missing", "type": null, "when": "A payee over the threshold has no W-9." }, { "code": "tin_mismatch", "type": null, "when": "Payee name and TIN do not match." }, { "code": "payee_sanctions_hit", "type": null, "when": "A payee name triggers a screening alert." }, { "code": "irs_rejected", "type": null, "when": "IRS e-file rejects the batch." } ] } }, "Params_us_form_1120f_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Tax year of the return.", "examples": [ "2026" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Year-end; June 30 year-ends use the 3rd month.", "examples": [ "2026-12-31" ] }, "has_us_office": { "type": "boolean", "description": "Decides the due date.", "examples": [ "true" ] }, "effectively_connected_income": { "$ref": "#/components/schemas/Money", "description": "Income effectively connected with a US trade or business." }, "treaty_position": { "type": "object", "description": "Treaty country and article if a treaty benefit is claimed." }, "form_5472_required": { "type": "boolean", "description": "True if reportable transactions with related parties exist.", "examples": [ "false" ] }, "officer_signer": { "type": "string", "pattern": "^per_", "description": "Officer of the foreign corporation who signs." }, "extension_on_file": { "type": "boolean", "description": "True if Form 7004 was filed.", "examples": [ "false" ] } }, "required": [ "tax_year", "fiscal_year_end", "has_us_office", "officer_signer" ], "description": "Files the US income tax return of a foreign corporation, with Form 5472 where applicable. Due the 15th day of the 4th month after year-end if it has a US office, or the 15th day of the 6th month if not." }, "Create_us_form_1120f_file": { "type": "object", "properties": { "type": { "const": "us.form_1120f.file" }, "params": { "$ref": "#/components/schemas/Params_us_form_1120f_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Form 1120-F for a foreign corporation with US income", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Financial statements and US books", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Home-country certificate of incorporation", "source": "uploaded", "required": false }, { "key": "form_1120f", "title": "Draft Form 1120-F", "source": "generated", "required": true }, { "key": "efile_signature_authorisation", "title": "E-file signature authorization", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS acknowledgment", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "beneficial_owner", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "efile_signature_authorisation", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 1120-F", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "financial_statements_missing", "type": null, "when": "No accounts uploaded." }, { "code": "office_status_unknown", "type": null, "when": "has_us_office not provided, so the due date cannot be computed." }, { "code": "treaty_position_incomplete", "type": null, "when": "Treaty claim lacks country or article." }, { "code": "irs_rejected", "type": null, "when": "E-file rejects the return." } ] } }, "Params_us_form_5472_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Calendar year in which the tax year begins.", "examples": [ "2026" ] }, "tax_year_end": { "type": "string", "format": "date", "description": "Last day of the tax year covered.", "examples": [ "2026-12-31" ] }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state of formation.", "examples": [ "WY" ] }, "entity_type": { "type": "string", "enum": [ "llc_single_member", "c_corp", "wy_dao_llc" ], "description": "Reporting entity type.", "examples": [ "llc_single_member" ] }, "ein": { "type": "string", "description": "The entity's EIN.", "examples": [ "98-7654321" ] }, "foreign_owner": { "type": "string", "pattern": "^per_", "description": "The 25% foreign shareholder, or the foreign sole member of a disregarded entity.", "examples": [ "per_1QxA8eK2" ] }, "ultimate_indirect_owners": { "type": "array", "items": {}, "description": "Ultimate indirect owner with country of residence and tax ID, if different from the direct 25% foreign shareholder.", "examples": [ "[{\"person\":\"per_1QxB2\",\"country\":\"GB\"}]" ] }, "related_parties": { "type": "array", "items": {}, "description": "Each related party that had a reportable transaction: name, address, country, tax ID, relationship.", "examples": [ "[{\"name\":\"Acme Holdings Ltd\",\"country\":\"GB\",\"relationship\":\"parent\"}]" ] }, "reportable_transactions": { "type": "array", "items": {}, "description": "Transactions with related parties: type, direction, amount, currency, part of the form.", "examples": [ "[{\"part\":\"V\",\"type\":\"capital_contribution\",\"amount\":{\"amount\":10000,\"currency\":\"USD\"}}]" ] }, "no_reportable_transactions": { "type": "boolean", "description": "Set when the entity had no reportable transaction.", "examples": [ "false" ] }, "extension_requested": { "type": "boolean", "description": "Request an automatic extension on Form 7004, sent to the same fax number or address as the form, before the regular due date.", "examples": [ "false" ] }, "filing_channel": { "type": "string", "enum": [ "fax", "mail" ], "description": "Transmission to the IRS.", "examples": [ "fax" ] }, "form_1120_action": { "type": "string", "description": "For a c_corp: id of the us.federal_return.file action that carries the regular Form 1120 to which Form 5472 is attached.", "examples": [ "act_1QxF77" ] }, "effective_date": { "type": "string", "format": "date", "description": "Not used for this action; omitted unless a catch-up filing needs a stated date.", "examples": [ "2027-04-15" ] } }, "required": [ "tax_year", "tax_year_end", "state", "entity_type", "ein", "foreign_owner", "related_parties", "reportable_transactions" ], "description": "Prepares and sends Form 5472 reporting transactions between a US reporting corporation and its foreign or domestic related parties. A foreign-owned US DE attaches the form to a pro forma Form 1120 marked 'Foreign-owned U.S." }, "Create_us_form_5472_file": { "type": "object", "properties": { "type": { "const": "us.form_5472.file" }, "params": { "$ref": "#/components/schemas/Params_us_form_5472_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File IRS Form 5472", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "llc_single_member", "c_corp", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "transaction_ledger", "title": "Related-party transaction ledger", "source": "uploaded", "required": true }, { "key": "ownership_chart", "title": "Ownership chart to the ultimate owners", "source": "uploaded", "required": true }, { "key": "form_5472", "title": "Form 5472", "source": "generated", "required": true }, { "key": "pro_forma_1120", "title": "Pro forma Form 1120 marked 'Foreign-owned U.S.", "source": "generated", "required": true }, { "key": "form_7004", "title": "Form 7004 extension request", "source": "generated", "required": false }, { "key": "fax_confirmation", "title": "Fax or mailing proof", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "member", "verification_level": "identity" }, { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "pro_forma_1120", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_5472", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_7004", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form 5472 with pro forma Form 1120", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_a_reporting_corporation", "type": null, "when": "Entity is not a 25% foreign-owned corporation or a foreign-owned US disregarded entity." }, { "code": "ein_required", "type": null, "when": "No EIN on the entity; run us.ein.obtain first." }, { "code": "no_reportable_transactions", "type": null, "when": "no_reportable_transactions is true; nothing to report." }, { "code": "electronic_filing_not_available", "type": null, "when": "filing_channel set to online for a foreign-owned US disregarded entity." }, { "code": "extension_window_closed", "type": null, "when": "extension_requested after the regular due date." }, { "code": "wet_ink_signature_missing", "type": null, "when": "Signed pages not received by the deadline." } ] } }, "Params_us_foundation_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Only Wyoming statutory foundations are covered by this action type.", "examples": [ "WY" ] }, "report_year": { "type": "integer", "description": "Calendar year in which the anniversary month falls, for example 2027 for a foundation formed in March 2022.", "examples": [ "2027" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal office address to appear on the report." }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address if different from the principal office." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Defaults to the registered office held on the entity record." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person the registered agent keeps as communications contact (W.S. 17-28-104)." }, "directors": { "type": "array", "items": {}, "description": "Directors to list, as person references." }, "changes_since_last_report": { "type": "boolean", "description": "False confirms that nothing in the register has changed; true triggers a register review before filing.", "examples": [ "false" ] }, "signer": { "type": "string", "pattern": "^per_", "description": "Director or officer who approves the report content." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "How the state fee is paid.", "examples": [ "card" ] } }, "required": [ "state", "report_year", "principal_office", "communications_contact", "changes_since_last_report", "signer" ], "description": "Files the annual report of a Wyoming statutory foundation with the Wyoming Secretary of State and pays the $100 report fee. Due on the first day of the foundation's anniversary month, and may be filed up to 120 days early." }, "Create_us_foundation_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.foundation_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_foundation_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Wyoming statutory foundation annual report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Wyoming statutory foundation annual report", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Approval of the annual report", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "WyoBiz filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "annual_report", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Wyoming Annual Report", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "The foundation is administratively dissolved; run reinstatement first." }, { "code": "report_not_yet_open", "type": null, "when": "Filed more than 120 days before the anniversary month." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person contact is recorded with the registered agent." }, { "code": "registry_rejected", "type": null, "when": "WyoBiz rejects the report data." } ] } }, "Params_us_franchise_tax_pay": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Delaware only.", "examples": [ "DE" ] }, "tax_year": { "type": "integer", "description": "Tax year being paid.", "examples": [ "2026" ] }, "calculation_method": { "type": "string", "enum": [ "lowest", "authorized_shares", "assumed_par_value_capital" ], "description": "Default: lowest of the two methods." }, "authorised_shares": { "type": "integer", "description": "Total authorised shares." }, "assumed_par_value_capital": { "$ref": "#/components/schemas/Money" }, "large_corporate_filer": { "type": "boolean", "description": "Fixed $250,000 (s.503)." }, "amount": { "$ref": "#/components/schemas/Money", "description": "Override with the amount per the Division's calculator; otherwise Entiva computes it." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "ACH required above $5,000." } }, "required": [ "state", "tax_year", "payment_method" ], "description": "Normally paid with the annual report; this action also handles stand-alone and late payments." }, "Create_us_franchise_tax_pay": { "type": "object", "properties": { "type": { "const": "us.franchise_tax.pay" }, "params": { "$ref": "#/components/schemas/Params_us_franchise_tax_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay Delaware corporate franchise tax", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "franchise_tax_calculation", "title": "Calculation under both methods", "source": "generated", "required": true }, { "key": "payment_authorisation", "title": "Payment authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "payment_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Paid with the Annual Franchise Tax Report", "channel": "online", "government_fee": { "amount": 175, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ach_required", "type": null, "when": "Amount exceeds $5,000 and card chosen." }, { "code": "amount_mismatch", "type": null, "when": "Supplied amount differs from the Division's balance." }, { "code": "exempt_corporation", "type": null, "when": "Entity is exempt; no franchise tax is due." }, { "code": "spending_limit_exceeded", "type": null, "when": "Amount exceeds the agent mandate." } ] } }, "Params_us_franchise_tax_installment_pay": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Delaware only.", "examples": [ "DE" ] }, "tax_year": { "type": "integer", "description": "Tax year the installment relates to.", "examples": [ "2026" ] }, "installment": { "type": "string", "enum": [ "june_1", "september_1", "december_1" ], "description": "Which instalment." }, "estimated_annual_tax": { "$ref": "#/components/schemas/Money", "description": "Estimated annual franchise tax from which the percentage is taken." }, "amount": { "$ref": "#/components/schemas/Money", "description": "Installment amount; computed from the percentage if omitted." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "ACH required above $5,000." } }, "required": [ "state", "tax_year", "installment", "estimated_annual_tax", "payment_method" ], "description": "Pays one of the estimated installments required when a corporation's franchise tax is $5,000 or more." }, "Create_us_franchise_tax_installment_pay": { "type": "object", "properties": { "type": { "const": "us.franchise_tax_installment.pay" }, "params": { "$ref": "#/components/schemas/Params_us_franchise_tax_installment_pay" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Pay a Delaware franchise tax estimated installment", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payment_authorisation", "title": "Payment authorisation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "payment_authorisation", "signer_role": "authorised_representative", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Estimated franchise tax payment", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "installments_not_required", "type": null, "when": "Estimated tax is below $5,000." }, { "code": "ach_required", "type": null, "when": "Amount above $5,000 and card chosen." }, { "code": "spending_limit_exceeded", "type": null, "when": "Over the mandate limit." } ] } }, "Params_us_franchise_tax_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Delaware only.", "examples": [ "DE" ] }, "tax_year": { "type": "integer", "description": "Calendar year of the report.", "examples": [ "2026" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "Signing officer or a director (8 Del." }, "directors": { "type": "array", "items": {}, "description": "Every director with name and address, as the report lists them." }, "principal_place_of_business": { "$ref": "#/components/schemas/Address", "description": "Principal place of business." }, "nature_of_business": { "type": "string", "description": "Nature of business; now required on the report." }, "share_classes": { "type": "array", "items": {}, "description": "Stock classes with authorised shares and par value." }, "total_gross_assets": { "$ref": "#/components/schemas/Money" }, "calculation_method": { "type": "string", "enum": [ "lowest", "authorized_shares", "assumed_par_value_capital" ], "description": "Method for franchise tax." }, "exempt": { "type": "boolean", "description": "True for exempt corporations: $25 filing fee, no franchise tax." }, "large_corporate_filer": { "type": "boolean", "description": "Fixed $250,000 tax for Large Corporate Filers (s.503)." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "ACH is required when payment exceeds $5,000." }, "pay_tax": { "type": "boolean", "description": "Default true: pay filing fee and tax with the report." } }, "required": [ "state", "tax_year", "officer", "directors", "principal_place_of_business", "nature_of_business", "share_classes" ], "description": "Prepares, has the officer approve and files the Delaware Annual Franchise Tax Report for a domestic corporation, and pays the filing fee and the franchise tax at cost." }, "Create_us_franchise_tax_report_file": { "type": "object", "properties": { "type": { "const": "us.franchise_tax_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_franchise_tax_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Delaware annual franchise tax report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "franchise_tax_report", "title": "Annual Franchise Tax Report", "source": "generated", "required": true }, { "key": "franchise_tax_calculation", "title": "Franchise tax calculation under both methods", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Balance sheet for gross assets", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Filing and payment receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "franchise_tax_report", "signer_role": "officer", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Annual Franchise Tax Report", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "report_already_filed", "type": null, "when": "A report for this tax_year is already on file." }, { "code": "stock_data_inconsistent", "type": null, "when": "Authorised or issued shares in the ledger do not match the charter." }, { "code": "ach_required", "type": null, "when": "Payment exceeds $5,000 and card was chosen." }, { "code": "entity_not_in_good_standing", "type": null, "when": "Charter is void or forfeited; revive first." }, { "code": "officer_not_verified", "type": null, "when": "" } ] } }, "Params_us_good_standing_request": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State that issues the certificate.", "examples": [ "DE" ] }, "certificate_form": { "type": "string", "enum": [ "short", "long" ], "description": "Delaware: short form or long form.", "examples": [ "short" ] }, "delivery": { "type": "string", "enum": [ "electronic", "paper" ], "description": "Electronic copy or paper original.", "examples": [ "electronic" ] }, "expedite": { "type": "string", "enum": [ "none", "same_day", "24_hour" ], "description": "Delaware tiers: same day or 24 hours.", "examples": [ "none" ] }, "copies": { "type": "integer", "description": "Number of certificates.", "examples": [ "1" ] }, "purpose": { "type": "string", "description": "Recipient or use, for the audit log.", "examples": [ "Bank account opening" ] }, "apostille_required": { "type": "boolean", "description": "If true, Entiva chains a us.apostille.order action once the certificate is issued.", "examples": [ "false" ] }, "destination_country": { "type": "string", "description": "ISO 3166 country where the certificate will be used; needed when apostille_required is true.", "examples": [ "SG" ] } }, "required": [ "state" ], "description": "Orders a state-issued certificate of good standing, Certificate of Existence/Evidence/Good Standing or Certificate of Existence, for banks, foreign registries and counterparties. Optional chained apostille." }, "Create_us_good_standing_request": { "type": "object", "properties": { "type": { "const": "us.good_standing.request" }, "params": { "$ref": "#/components/schemas/Params_us_good_standing_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Order a certificate of good standing or existence", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc", "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "good_standing_certificate", "title": "Certificate of good standing / existence", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "good_standing_certificate", "signer_role": "filing_agent", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or Division of Corporations", "form": "DE Certificate of Good Standing", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "The registry shows the entity delinquent, void or forfeited; revive it first." }, { "code": "unsupported_delivery", "type": null, "when": "Paper delivery or an expedite tier is not offered by the state." }, { "code": "destination_country_required", "type": null, "when": "apostille_required is true with no destination_country." } ] } }, "Params_us_irs_authorization_file": { "type": "object", "properties": { "form": { "type": "string", "enum": [ "2848", "8821" ], "description": "2848 allows representation before the IRS; 8821 allows only access to tax information.", "examples": [ "2848" ] }, "tax_matters": { "type": "array", "items": {}, "description": "Each matter: type of tax, form number, and periods covered." }, "representative": { "type": "string", "pattern": "^per_", "description": "Entiva licensed professional named on the form." }, "acts_authorised": { "type": "array", "items": {}, "description": "Specific acts for Form 2848, for example receive refund checks." }, "taxpayer_signer": { "type": "string", "pattern": "^per_", "description": "Officer or member who signs for the entity." }, "submission_channel": { "type": "string", "enum": [ "online", "fax", "mail" ], "description": "Entiva uses the IRS online submission tool by default.", "examples": [ "online" ] } }, "required": [ "form", "tax_matters", "representative", "taxpayer_signer" ], "description": "Gives Entiva's licensed professionals authority to deal with the IRS for the entity: Form 2848 or Form 8821. Filed before the provider deals with the IRS for the client." }, "Create_us_irs_authorization_file": { "type": "object", "properties": { "type": { "const": "us.irs_authorization.file" }, "params": { "$ref": "#/components/schemas/Params_us_irs_authorization_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File an IRS Form 2848 or Form 8821 authorization", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "irs_authorisation_form", "title": "Form 2848 or Form 8821", "source": "generated", "required": true }, { "key": "evidence_of_authority", "title": "Evidence of the signer's authority", "source": "uploaded", "required": false }, { "key": "irs_confirmation", "title": "IRS submission confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "irs_authorisation_form", "signer_role": "tax_agent", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "irs_authorisation_form", "signer_role": "filing_agent", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 2848 or Form 8821", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "representative_not_eligible", "type": null, "when": "The named representative cannot practise before the IRS." }, { "code": "signer_not_authorised", "type": null, "when": "The signer's authority over the entity is not evidenced." }, { "code": "one_form_per_submission", "type": null, "when": "More than one form uploaded in a single submission." }, { "code": "irs_rejected", "type": null, "when": "The IRS rejects the submission." } ] } }, "Params_us_irs_authorization_revoke": { "type": "object", "properties": { "authorisation": { "type": "string", "pattern": "^doc_", "description": "The filed Form 2848 or 8821 to revoke." }, "representative": { "type": "string", "pattern": "^per_", "description": "Representative whose authority ends; omit to revoke all listed on the form." }, "effective_date": { "type": "string", "format": "date", "description": "Date from which the authority ends.", "examples": [ "2026-11-01" ] }, "taxpayer_signer": { "type": "string", "pattern": "^per_", "description": "Officer who signs the revocation." } }, "required": [ "authorisation", "taxpayer_signer" ], "description": "Withdraws a previously filed IRS authorization, for example when an entity leaves Entiva or a representative changes." }, "Create_us_irs_authorization_revoke": { "type": "object", "properties": { "type": { "const": "us.irs_authorization.revoke" }, "params": { "$ref": "#/components/schemas/Params_us_irs_authorization_revoke" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Revoke an IRS Form 2848 or Form 8821 authorization", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "irs_revocation", "title": "Revocation of IRS authorization", "source": "generated", "required": true }, { "key": "irs_confirmation", "title": "IRS submission confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "irs_revocation", "signer_role": "tax_agent", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Revocation statement or marked copy of Form 2848 / 8821", "channel": "both", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorization_not_found", "type": null, "when": "The referenced form is not on the entity record." }, { "code": "already_revoked", "type": null, "when": "The authorization was already revoked." }, { "code": "signer_not_authorised", "type": null, "when": "Signer lacks authority." } ] } }, "Params_us_llp_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Delaware only.", "examples": [ "DE" ] }, "report_year": { "type": "integer", "description": "Year in which the report falls due.", "examples": [ "2027" ] }, "partners": { "type": "array", "items": {}, "description": "All partners; the fee is per partner." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office." }, "registered_agent": { "type": "string", "pattern": "^ent_", "description": "Registered agent." }, "signer": { "type": "string", "pattern": "^per_", "description": "Partner who signs." }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "Payment method." } }, "required": [ "state", "report_year", "partners", "registered_office", "registered_agent", "signer", "payment_method" ], "description": "Files the annual report of a Delaware limited liability partnership or LLLP with the partner count, registered office and agent, and pays the per-partner fee." }, "Create_us_llp_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.llp_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_llp_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Delaware LLP or LLLP annual report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "llp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "llp_annual_report", "title": "LLP annual report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "partner", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "llp_annual_report", "signer_role": "partner", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "LLP annual report", "channel": "online", "government_fee": { "amount": 300, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "partner_count_mismatch", "type": null, "when": "Partners listed differ from the partner register." }, { "code": "qualification_revoked", "type": null, "when": "Statement of qualification revoked; reinstate first." }, { "code": "due_date_unconfirmed", "type": null, "when": "" } ] } }, "Params_us_mail_scan": { "type": "object", "properties": { "mail_preference": { "type": "string", "enum": [ "scan_all", "scan_government_only", "hold", "forward_physical" ], "description": "Standing handling rule for incoming mail.", "examples": [ "scan_all" ] }, "recipients": { "type": "array", "items": {}, "description": "People who get the scans.", "examples": [ "[\"per_1QxA8eK2\"]" ] }, "forwarding_address": { "$ref": "#/components/schemas/Address", "description": "Address for physical forwarding.", "examples": [ "{\"line1\":\"10 Downing St\",\"city\":\"London\",\"country\":\"GB\"}" ] }, "retention_days": { "type": "integer", "description": "Days to hold originals before shredding.", "examples": [ "30" ] }, "mail_item": { "type": "string", "description": "For a one-off item: mail_ id; omit to set the standing rule.", "examples": [ "mail_1QxX2e" ] }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the registered office.", "examples": [ "DE" ] } }, "required": [ "mail_preference", "recipients", "state" ], "description": "Opens, scans and forwards or holds general and government mail received at the registered office address, with classification. Mail scanning alone needs no licence; service of process is handled by us.service_of_process.forward." }, "Create_us_mail_scan": { "type": "object", "properties": { "type": { "const": "us.mail.scan" }, "params": { "$ref": "#/components/schemas/Params_us_mail_scan" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Scan and forward mail received at the registered office", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "mail_scan", "title": "Scanned mail item", "source": "generated", "required": true }, { "key": "mail_authorisation", "title": "Mail handling authorisation", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "mail_authorisation", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "No registry filing", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_not_entiva", "type": null, "when": "Registered office is not an Entiva or partner address." }, { "code": "recipient_unverified", "type": null, "when": "" } ] } }, "Params_us_nonprofit_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Fixed to WY for this action.", "examples": [ "WY" ] }, "report_year": { "type": "integer", "description": "Year of the anniversary month.", "examples": [ "2027" ] }, "filing_id": { "type": "string", "description": "Wyoming Filing ID used by the Annual Report Wizard.", "examples": [ "2020-000812345" ] }, "cooperative_kind": { "type": "string", "enum": [ "marketing_association", "processing", "other" ], "description": "For cooperatives: marketing association pays the flat $25; processing cooperative pays the profit-corporation license tax and should use us.annual_report.file.", "examples": [ "marketing_association" ] }, "principal_address": { "$ref": "#/components/schemas/Address", "description": "Principal office address.", "examples": [ "{\"line1\":\"200 W 24th St\",\"city\":\"Cheyenne\",\"region\":\"WY\",\"postal_code\":\"82001\",\"country\":\"US\"}" ] }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address.", "examples": [ "{\"line1\":\"PO Box 1\",\"city\":\"Cheyenne\",\"region\":\"WY\",\"postal_code\":\"82003\",\"country\":\"US\"}" ] }, "directors": { "type": "array", "items": {}, "description": "Directors or officers to report, if the wizard asks.", "examples": [ "[\"per_1Qy2a\"]" ] }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural-person contact held by the registered agent, kept updated at each annual report (W.S. 17-28-107).", "examples": [ "per_1Qy2a" ] }, "signing_officer": { "type": "string", "pattern": "^per_", "description": "Officer who signs.", "examples": [ "per_1Qy2a" ] } }, "required": [ "state", "report_year", "filing_id", "principal_address", "communications_contact", "signing_officer" ], "description": "Files the Wyoming annual report for a nonprofit corporation or cooperative marketing association through WyoBiz; flat $25. Processing cooperatives pay the profit-corporation license tax instead." }, "Create_us_nonprofit_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.nonprofit_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_nonprofit_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Wyoming nonprofit corporation or cooperative annual report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "nonprofit_corp", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Annual report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "annual_report", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Wyoming Annual Report", "channel": "online", "government_fee": { "amount": 25, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "processing_cooperative", "type": null, "when": "Cooperative is a processing cooperative; license tax applies, use us.annual_report.file." }, { "code": "filing_id_not_found", "type": null, "when": "Filing ID not matched in WyoBiz." }, { "code": "entity_dissolved", "type": null, "when": "Entity was administratively dissolved; reinstate first." } ] } }, "Params_us_ny_llcta_disclosure_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NY" ], "description": "New York.", "examples": [ "NY" ] }, "update_type": { "type": "string", "enum": [ "annual_confirmation", "amendment" ], "description": "Confirm unchanged data or amend it." }, "effective_date": { "type": "string", "format": "date", "description": "Date of any change." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Current owners if changed." } }, "required": [ "state", "update_type" ], "description": "Annual confirmation or amendment of a foreign-formed LLC's New York beneficial ownership disclosure." }, "Create_us_ny_llcta_disclosure_change": { "type": "object", "properties": { "type": { "const": "us.ny_llcta_disclosure.change" }, "params": { "$ref": "#/components/schemas/Params_us_ny_llcta_disclosure_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Confirm or update New York LLC Transparency Act disclosure", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "llc_single_member", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ny_llcta_disclosure", "title": "Updated disclosure", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "NY DOS confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "ny_llcta_disclosure", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "New York Department of State", "form": "Updated disclosure", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "no_initial_disclosure", "type": null, "when": "No prior filing; use us.ny_llcta_disclosure.file." }, { "code": "domestic_llc_not_in_scope", "type": null, "when": "US-formed LLC." } ] } }, "Params_us_ny_llcta_disclosure_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "NY" ], "description": "New York.", "examples": [ "NY" ] }, "disclosure_type": { "type": "string", "enum": [ "beneficial_ownership_disclosure", "exemption_attestation" ], "description": "Reporting LLC files a disclosure; an exempt LLC files an attestation of exemption." }, "home_jurisdiction": { "type": "string", "description": "Country of formation.", "examples": [ "GB" ] }, "authority_date": { "type": "string", "format": "date", "description": "Date the LLC applied for or obtained authority in New York; starts the 30-day clock." }, "beneficial_owners": { "type": "array", "items": {}, "description": "Required for a disclosure." }, "exemption_ground": { "type": "string", "description": "Ground for exemption, for an attestation." } }, "required": [ "state", "disclosure_type", "home_jurisdiction", "authority_date" ], "description": "Files the beneficial ownership disclosure, or an attestation of exemption, with the New York Department of State for an LLC formed outside the US and authorised to do business in New York. US-formed LLCs make no filing." }, "Create_us_ny_llcta_disclosure_file": { "type": "object", "properties": { "type": { "const": "us.ny_llcta_disclosure.file" }, "params": { "$ref": "#/components/schemas/Params_us_ny_llcta_disclosure_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File New York LLC Transparency Act disclosure", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "llc_single_member", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ny_llcta_disclosure", "title": "Disclosure or attestation", "source": "generated", "required": true }, { "key": "passport", "title": "Identity document for each owner", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "NY DOS confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "ny_llcta_disclosure", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "New York Department of State", "form": "Beneficial ownership disclosure or attestation of exemption", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "domestic_llc_not_in_scope", "type": null, "when": "LLC is formed in the US." }, { "code": "fincen_id_not_accepted", "type": null, "when": "A FinCEN ID was supplied instead of ID details." }, { "code": "owner_unverified", "type": null, "when": "A listed owner has not completed verification." } ] } }, "Params_us_registered_agent_appoint": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC where the registered agent and office are maintained.", "examples": [ "DE" ] }, "registered_agent": { "type": "string", "pattern": "^ent_", "description": "The agent to appoint." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state street address of the registered office.", "examples": [ "1 Example Plaza, Wilmington, DE 19801, US" ] }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural person the agent holds as contact." }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect." }, "reason": { "type": "string", "enum": [ "initial", "vacancy_after_resignation", "vacancy_after_agent_ceased", "other" ], "description": "Why an appointment is needed." } }, "required": [ "state", "communications_contact" ], "description": "Names the registered agent and in-state registered office for an existing US entity and records the natural-person communications contact the agent must hold. Entiva's licensed commercial registered-agent partner is the default agent." }, "Create_us_registered_agent_appoint": { "type": "object", "properties": { "type": { "const": "us.registered_agent.appoint" }, "params": { "$ref": "#/components/schemas/Params_us_registered_agent_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a registered agent and registered office", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution or consent appointing the agent", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or corporations division", "form": "Registered agent designation or change instrument for the state", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registered_agent_not_accepted", "type": null, "when": "The agent partner declined the customer after identity or OFAC screening." }, { "code": "agent_not_eligible", "type": null, "when": "The named agent lacks an in-state office or, in Delaware, a required business licence." }, { "code": "communications_contact_missing", "type": null, "when": "No natural-person contact supplied." }, { "code": "unsupported_state", "type": null, "when": "State is not a US state or DC." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a related person pauses the action." } ] } }, "Params_us_registered_agent_resign": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State code.", "examples": [ "DE" ] }, "successor": { "type": "string", "pattern": "^ent_", "description": "Successor agent if the customer has already named one." }, "reason": { "type": "string", "enum": [ "customer_request", "non_payment", "customer_transferred_out", "compliance_exit" ], "description": "Reason for the resignation." }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date; the statutory date governs." } }, "required": [ "state", "reason" ], "description": "Entiva's registered-agent partner resigns as agent for an entity, starting the statutory clock for the entity to name a successor." }, "Create_us_registered_agent_resign": { "type": "object", "properties": { "type": { "const": "us.registered_agent.resign" }, "params": { "$ref": "#/components/schemas/Params_us_registered_agent_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Resign as registered agent", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_notice", "title": "Agent's resignation", "source": "generated", "required": true }, { "key": "customer_notice", "title": "Notice to entity of resignation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "other", "verification_level": "none" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "sole", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "resignation_notice", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or corporations division", "form": "Registered agent resignation instrument", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "successor_required_in_state", "type": null, "when": "The state does not allow resignation without a successor." }, { "code": "entity_not_found_at_registry", "type": null, "when": "The entity file number does not match." }, { "code": "unsupported_state", "type": null, "when": "State rules for resignation are not encoded." } ] } }, "Params_us_service_of_process_forward": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the registered office that received the process.", "examples": [ "DE" ] }, "received_date": { "type": "string", "format": "date", "description": "Date the registered agent received the process.", "examples": [ "2026-10-14" ] }, "served_document": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the scanned summons, complaint or notice.", "examples": [ "doc_1QxV4c" ] }, "court": { "type": "string", "description": "Court or agency named.", "examples": [ "Delaware Court of Chancery" ] }, "case_reference": { "type": "string", "description": "Case number or caption.", "examples": [ "C.A. No. 2026-0123" ] }, "response_deadline": { "type": "string", "format": "date", "description": "Response deadline read from the document, if stated.", "examples": [ "2026-11-03" ] }, "recipients": { "type": "array", "items": {}, "description": "People to notify: the communications contact first, plus others.", "examples": [ "[\"per_1QxA8eK2\"]" ] }, "delivery_method": { "type": "string", "enum": [ "email_scan", "courier", "both" ], "description": "How the original is sent on.", "examples": [ "both" ] }, "served_on_secretary_of_state": { "type": "boolean", "description": "True if process was served on the Secretary of State because no agent could be found; a Delaware service fee applies and is paid by the party serving.", "examples": [ "false" ] } }, "required": [ "state", "received_date", "served_document", "recipients" ], "description": "Registered-agent duty: logs a summons or other process served on the entity's registered agent, scans it and forwards it to the communications contact and designated recipients with the response deadline. Created by Entiva's." }, "Create_us_service_of_process_forward": { "type": "object", "properties": { "type": { "const": "us.service_of_process.forward" }, "params": { "$ref": "#/components/schemas/Params_us_service_of_process_forward" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Forward service of process received at the registered office", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "served_document", "title": "Served process", "source": "uploaded", "required": true }, { "key": "transmittal_record", "title": "Forwarding record", "source": "generated", "required": true } ], "people": [ { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "transmittal_record", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Receipt and forwarding of process", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_communications_contact", "type": null, "when": "Entity has no verified communications contact to forward to." }, { "code": "recipient_unverified", "type": null, "when": "" } ] } }, "Params_us_statutory_trust_annual_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Only Wyoming statutory trusts.", "examples": [ "WY" ] }, "report_year": { "type": "integer", "description": "Year in which the January 2 deadline falls.", "examples": [ "2027" ] }, "trustee": { "type": "string", "pattern": "^per_", "description": "Trustee who approves the report." }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal office to appear on the report." }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Defaults to the registered office on the entity record." }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "Natural-person communications contact kept with the registered agent." }, "changes_since_last_report": { "type": "boolean", "description": "False confirms no change in trustees or addresses.", "examples": [ "false" ] }, "payment_method": { "type": "string", "enum": [ "card", "ach" ], "description": "Payment of the $100 tax.", "examples": [ "card" ] } }, "required": [ "state", "report_year", "trustee", "principal_office", "communications_contact", "changes_since_last_report" ], "description": "Files the annual report and pays the $100 annual tax for a Wyoming statutory trust. Due on or before January 2 each year, whatever the formation date; a $100 penalty applies if unpaid by February 1." }, "Create_us_statutory_trust_annual_report_file": { "type": "object", "properties": { "type": { "const": "us.statutory_trust_annual_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_statutory_trust_annual_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Wyoming statutory trust annual report and pay the annual tax", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "annual_report", "title": "Wyoming statutory trust annual report", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "WyoBiz receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "none" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "any_one", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "annual_report", "signer_role": "trustee", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Wyoming statutory trust annual report and annual tax", "channel": "online", "government_fee": { "amount": 100, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "The trust is dissolved or past due beyond the reinstatement route." }, { "code": "deadline_penalty_applies", "type": null, "when": "Filed after February 1, so the $100 penalty is added to the quote." }, { "code": "no_trustee_on_record", "type": null, "when": "The trust register lists no active trustee." }, { "code": "registry_rejected", "type": null, "when": "WyoBiz rejects the filing." } ] } }, "Params_us_tax_return_extension_file": { "type": "object", "properties": { "return_form": { "type": "string", "enum": [ "1120-F" ], "description": "Return being extended.", "examples": [ "1120-F" ] }, "tax_year": { "type": "integer", "description": "Tax year of the return.", "examples": [ "2026" ] }, "fiscal_year_end": { "type": "string", "format": "date", "description": "Year-end.", "examples": [ "2026-12-31" ] }, "has_us_office": { "type": "boolean", "description": "Decides the original due date.", "examples": [ "true" ] }, "estimated_tax": { "$ref": "#/components/schemas/Money", "description": "Tax estimated to be owed, to be paid by the original due date." }, "officer_signer": { "type": "string", "pattern": "^per_", "description": "Officer who approves the request." } }, "required": [ "return_form", "tax_year", "fiscal_year_end", "has_us_office", "officer_signer" ], "description": "Files Form 7004 to extend the due date of Form 1120-F. Covers the extension step for the foreign-corporation return in this batch." }, "Create_us_tax_return_extension_file": { "type": "object", "properties": { "type": { "const": "us.tax_return_extension.file" }, "params": { "$ref": "#/components/schemas/Params_us_tax_return_extension_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File Form 7004 to extend a business tax return", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_7004", "title": "Form 7004", "source": "generated", "required": true }, { "key": "irs_acknowledgment", "title": "IRS acknowledgment", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "form_7004", "signer_role": "officer", "method": "click_consent", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "IRS", "form": "Form 7004", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "deadline_passed", "type": null, "when": "Original due date is past." }, { "code": "duplicate_filing", "type": null, "when": "A Form 7004 for the same year is on file." }, { "code": "irs_rejected", "type": null, "when": "E-file rejects the request." } ] } }, "Params_us_transparency_standards_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Must be DE; this regime exists only for Delaware entities.", "examples": [ "DE" ] }, "standards_name": { "type": "string", "description": "Name of the standards and assessment measures adopted by the governing body.", "examples": [ "GRI Standards" ] }, "standards_website": { "type": "string", "description": "Internet link where the standards, assessment measures, third-party criteria, adoption process and reports are available at no cost (s.5003E).", "examples": [ "https://example.com/sustainability" ] }, "in_state_notice_address": { "$ref": "#/components/schemas/Address", "description": "In-State address for notices (s.5003E).", "examples": [ "{\"line1\":\"8 The Green\",\"city\":\"Dover\",\"region\":\"DE\",\"postal_code\":\"19901\",\"country\":\"US\"}" ] }, "reporting_period_start": { "type": "string", "format": "date", "description": "First reporting period must begin within one year after the statement is filed (s.5001E).", "examples": [ "2027-01-01" ] }, "governing_body_resolution": { "type": "string", "pattern": "^doc_", "description": "doc_ id of the resolution adopting the standards and assessment measures.", "examples": [ "doc_1QxZ8g" ] }, "authorised_person": { "type": "string", "pattern": "^per_", "description": "Person authorised under the entity's organisational documents and Delaware law who acknowledges the statement under penalty of perjury.", "examples": [ "per_1QxA8eK2" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "general_partnership", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "s_corp_election" ], "description": "Entity type key of the Delaware entity.", "examples": [ "c_corp" ] } }, "required": [ "state", "standards_name", "standards_website", "in_state_notice_address", "reporting_period_start", "governing_body_resolution", "authorised_person", "entity_type" ], "description": "After the governing body adopts resolutions setting standards and assessment measures, files the Standards Statement under 6 Del. C. s.5003E with the Division of Corporations and receives the Certificate of Adoption." }, "Create_us_transparency_standards_adopt": { "type": "object", "properties": { "type": { "const": "us.transparency_standards.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_transparency_standards_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Delaware Standards Statement", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "governing_body_resolution", "title": "Governing body resolution", "source": "generated", "required": true }, { "key": "standards_statement", "title": "Standards Statement", "source": "generated", "required": true }, { "key": "certificate_of_adoption", "title": "Certificate of Adoption", "source": "registry_issued", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "governing_body_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "standards_statement", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Standards Statement", "channel": "online", "government_fee": { "amount": 250, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_delaware_entity", "type": null, "when": "state is not DE." }, { "code": "resolution_missing", "type": null, "when": "No governing body resolution uploaded or signed." }, { "code": "recently_nonreporting", "type": null, "when": "Entity became nonreporting within the prior year; s.5004E." }, { "code": "in_state_address_required", "type": null, "when": "No Delaware notice address." } ] } }, "Params_us_transparency_standards_renew": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Must be DE.", "examples": [ "DE" ] }, "renewal_year": { "type": "integer", "description": "Year of the October 1 to December 31 window.", "examples": [ "2026" ] }, "changes_posted": { "type": "boolean", "description": "Confirms that any changes to the in-State address, standards or assessment measures since the last filing are posted on the website (s.5004E).", "examples": [ "true" ] }, "report_posted_on_time": { "type": "boolean", "description": "Confirms the report due by October 1 was posted on time (s.5004E).", "examples": [ "true" ] }, "latest_report_url": { "type": "string", "description": "Link to the most recent report (s.5004E).", "examples": [ "https://example.com/sustainability/2026-report.pdf" ] }, "authorised_person": { "type": "string", "pattern": "^per_", "description": "Authorised person acknowledging the statement under penalty of perjury.", "examples": [ "per_1QxA8eK2" ] } }, "required": [ "state", "renewal_year", "changes_posted", "report_posted_on_time", "latest_report_url", "authorised_person" ], "description": "Between October 1 and December 31 each year, files the Renewal Statement under 6 Del. C. s.5004E." }, "Create_us_transparency_standards_renew": { "type": "object", "properties": { "type": { "const": "us.transparency_standards.renew" }, "params": { "$ref": "#/components/schemas/Params_us_transparency_standards_renew" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the annual Delaware Renewal Statement for transparency and sustainability standards", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "renewal_statement", "title": "Renewal Statement", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "renewal_statement", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Renewal Statement", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "outside_renewal_window", "type": null, "when": "Filed before October 1 or after December 31; use us.transparency_standards.restore after lapse." }, { "code": "not_a_reporting_entity", "type": null, "when": "Entity has no effective Standards Statement." }, { "code": "report_not_posted", "type": null, "when": "report_posted_on_time is false; Entiva will not sign a false confirmation." } ] } }, "Params_us_transparency_standards_restore": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Must be DE.", "examples": [ "DE" ] }, "lapse_year": { "type": "integer", "description": "Year in which the renewal lapsed.", "examples": [ "2026" ] }, "changes_posted": { "type": "boolean", "description": "Confirms changes are posted on the website (s.5005E).", "examples": [ "true" ] }, "reports_posted": { "type": "boolean", "description": "Confirms reports for all periods that ended more than 90 days before filing are posted (s.5005E).", "examples": [ "true" ] }, "report_urls": { "type": "array", "items": {}, "description": "Links to the most recent report and any other report not previously linked (s.5005E).", "examples": [ "[\"https://example.com/sustainability/2026-report.pdf\"]" ] }, "authorised_person": { "type": "string", "pattern": "^per_", "description": "Authorised person acknowledging under penalty of perjury.", "examples": [ "per_1QxA8eK2" ] } }, "required": [ "state", "lapse_year", "changes_posted", "reports_posted", "report_urls", "authorised_person" ], "description": "Restores reporting status under 6 Del. C. s.5005E after the entity became nonreporting." }, "Create_us_transparency_standards_restore": { "type": "object", "properties": { "type": { "const": "us.transparency_standards.restore" }, "params": { "$ref": "#/components/schemas/Params_us_transparency_standards_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File a Delaware Restoration Statement after a lapsed renewal", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "restoration_statement", "title": "Restoration Statement", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_representative", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "restoration_statement", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Restoration Statement", "channel": "online", "government_fee": { "amount": 5000, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "restoration_window_closed", "type": null, "when": "Calendar year after the lapse has ended." }, { "code": "entity_still_reporting", "type": null, "when": "Entity is not nonreporting." }, { "code": "reports_missing", "type": null, "when": "Reports for earlier periods not posted." } ] } }, "Params_us_unclaimed_property_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Must be DE for this action.", "examples": [ "DE" ] }, "report_year": { "type": "integer", "description": "Year the report is due.", "examples": [ "2027" ] }, "holder_type": { "type": "string", "enum": [ "general", "bank", "insurer" ], "description": "Due date depends on holder type: March 1, November 10, December 20 per s.1144.", "examples": [ "general" ] }, "property_lines": { "type": "array", "items": {}, "description": "Reportable items: property type, owner name, last known address, amount, last contact date.", "examples": [ "[{\"type\":\"uncashed_payroll\",\"owner\":\"J. Smith\",\"amount\":{\"amount\":412.5,\"currency\":\"USD\"},\"last_contact\":\"2023-04-01\"}]" ] }, "remittance": { "$ref": "#/components/schemas/Money", "description": "Total property to remit; passes through at cost.", "examples": [ "{\"amount\":412.5,\"currency\":\"USD\"}" ] }, "voluntary_disclosure": { "type": "boolean", "description": "Use the Voluntary Disclosure Agreement route for prior unreported years; separately quoted and reviewed.", "examples": [ "false" ] }, "certifying_officer": { "type": "string", "pattern": "^per_", "description": "Officer who verifies the report for completeness and accuracy.", "examples": [ "per_1QxA8eK2" ] } }, "required": [ "state", "report_year", "holder_type", "certifying_officer" ], "description": "Files the web-based annual holder report to the Delaware State Escheator and remits reportable property. Covers Delaware-incorporated or formed holders where owner addresses are unknown." }, "Create_us_unclaimed_property_file": { "type": "object", "properties": { "type": { "const": "us.unclaimed_property.file" }, "params": { "$ref": "#/components/schemas/Params_us_unclaimed_property_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the Delaware unclaimed property annual holder report", "x-entiva": { "jurisdiction": "us", "stage": "ongoing_compliance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "owner_data_file", "title": "Owner and property data", "source": "uploaded", "required": false }, { "key": "holder_report", "title": "Holder report", "source": "generated", "required": true }, { "key": "filing_confirmation", "title": "Filing confirmation", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "holder_report", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Delaware State Escheator", "form": "Web-based annual holder report", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_delaware_holder", "type": null, "when": "Entity is not incorporated or formed in Delaware and has no Delaware-owner property." }, { "code": "property_data_missing", "type": null, "when": "Property lines lack owner data needed for the report." }, { "code": "vda_review_required", "type": null, "when": "voluntary_disclosure is true; compliance review and separate quote." } ] } }, "Params_us_annual_meeting_hold": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "mode": { "type": "string", "enum": [ "meeting", "written_consent" ], "description": "meeting holds a meeting; written_consent elects directors by stockholder consent in lieu of a meeting (8 Del.", "examples": [ "meeting" ] }, "meeting_format": { "type": "string", "enum": [ "in_person", "remote", "hybrid" ], "description": "Required when mode is meeting.", "examples": [ "remote" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting, or the date the consent is to take effect.", "examples": [ "2026-12-10" ] }, "record_date": { "type": "string", "format": "date", "description": "Record date fixed by the board for notice and voting.", "examples": [ "2026-11-02" ] }, "directors": { "type": "array", "items": {}, "description": "Directors to elect, each a person reference or new person data, with term end date.", "examples": [ "[\"per_8Kd2\",\"per_5Tw1\",\"per_7Lp4\"]" ] }, "other_business": { "type": "array", "items": {}, "description": "Further matters voted on.", "examples": [ "[{\"title\":\"Ratify 2025 option grants\",\"vote\":\"majority\"}]" ] }, "notice_method": { "type": "string", "enum": [ "email", "post", "both" ], "description": "How notice is given.", "examples": [ "email" ] }, "quorum_percent": { "type": "number", "description": "Quorum from the bylaws; defaults to the bylaws value on file.", "examples": [ "50" ] }, "notice_to_non_consenting": { "type": "boolean", "description": "For written_consent below unanimity: send prompt notice to non-consenting stockholders (8 Del.", "examples": [ "true" ] } }, "required": [ "state", "mode", "directors" ], "description": "Runs the annual election of directors either at a meeting or by stockholder written consent in lieu, and records the result. Internal; nothing is filed with the state." }, "Create_us_annual_meeting_hold": { "type": "object", "properties": { "type": { "const": "us.annual_meeting.hold" }, "params": { "$ref": "#/components/schemas/Params_us_annual_meeting_hold" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Hold the annual meeting of stockholders, or elect directors by written consent in lieu", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution calling the meeting and fixing the record date", "source": "generated", "required": false }, { "key": "meeting_notice", "title": "Notice of annual meeting", "source": "generated", "required": false }, { "key": "stockholder_list", "title": "List of stockholders entitled to vote", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Stockholder resolution or written consent electing the directors", "source": "generated", "required": true }, { "key": "minutes", "title": "Minutes of the annual meeting", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Consent to act of each newly elected director", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "proxy", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "minutes", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "director", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "None", "form": "Annual meeting to elect directors", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "notice_period_too_short", "type": null, "when": "The meeting date leaves less notice than the bylaws or statute require." }, { "code": "quorum_not_reached", "type": null, "when": "Recorded attendance or consents fall below the quorum or the required vote." }, { "code": "director_unverified", "type": null, "when": "An elected director has not completed identity_address verification." }, { "code": "consent_not_unanimous", "type": null, "when": "mode is written_consent and not every stockholder signed where the law needs unanimity." }, { "code": "record_date_invalid", "type": null, "when": "The record date is outside the allowed window." } ] } }, "Params_us_benefit_report_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code.", "examples": [ "DE" ] }, "period_start": { "type": "string", "format": "date", "description": "Start of the period reported on.", "examples": [ "2024-10-01" ] }, "period_end": { "type": "string", "format": "date", "description": "End of the period reported on.", "examples": [ "2026-09-30" ] }, "public_benefits": { "type": "array", "items": {}, "description": "The specific public benefits stated in the charter or certificate.", "examples": [ "[\"Reduce plastic waste in consumer packaging\"]" ] }, "objectives_and_standards": { "type": "object", "description": "Objectives set by the board or managers, and the standard adopted to measure progress.", "examples": [ "{\"objectives\":\"Divert 500 tonnes from landfill\",\"standard\":\"Own metrics, independently reviewed\"}" ] }, "results": { "type": "object", "description": "Factual information on progress against the objectives and standard in the period.", "examples": [ "{\"diverted_tonnes\":310}" ] }, "assessment": { "type": "string", "description": "The board's or managers' assessment of success in meeting the objectives and promoting the public benefit.", "examples": [ "Progress below target; recycled content sourcing delayed." ] }, "recipients": { "type": "array", "items": {}, "description": "Holders who receive the statement.", "examples": [ "[]" ] }, "publish_publicly": { "type": "boolean", "description": "Post the statement publicly, if the charter requires it.", "examples": [ "false" ] }, "delivery_method": { "type": "string", "enum": [ "email", "post", "both" ], "description": "How the statement reaches holders.", "examples": [ "email" ] } }, "required": [ "state", "period_start", "period_end", "public_benefits", "objectives_and_standards", "results", "assessment" ], "description": "Prepares the periodic statement a Delaware public benefit corporation, public benefit LLC or public benefit LP gives its stockholders, members or partners on its public benefit objectives, standards, results and assessment, and delivers." }, "Create_us_benefit_report_file": { "type": "object", "properties": { "type": { "const": "us.benefit_report.file" }, "params": { "$ref": "#/components/schemas/Params_us_benefit_report_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Prepare and deliver the biennial public benefit statement", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "public_benefit_corp", "statutory_public_benefit_llc", "statutory_public_benefit_lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "benefit_report", "title": "Public benefit statement", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board or manager approval of the statement", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Evidence for the results", "source": "uploaded", "required": false } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "benefit_report", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Periodic statement under 8 Del. C. §366", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "public_benefit_not_stated", "type": null, "when": "The entity's charter or certificate states no public benefit, so it is not a public benefit entity." }, { "code": "report_period_gap", "type": null, "when": "The period leaves a gap of more than two years since the last statement." }, { "code": "assessment_missing", "type": null, "when": "Any of objectives, standard, results or assessment is empty." }, { "code": "recipient_not_of_record", "type": null, "when": "A recipient is not on the register." } ] } }, "Params_us_board_resolution_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "subject": { "type": "string", "description": "Title of the resolution.", "examples": [ "Authorise opening of a US operating bank account" ] }, "resolutions": { "type": "array", "items": {}, "description": "Resolution items, each with title and text.", "examples": [ "[{\"title\":\"Bank account\",\"text\":\"RESOLVED, that the Company open an account...\"}]" ] }, "directors": { "type": "array", "items": {}, "description": "Directors who must consent.", "examples": [ "[\"per_8Kd2\",\"per_7Lp4\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date.", "examples": [ "2026-10-20" ] }, "authorised_signatories": { "type": "array", "items": {}, "description": "Officers the resolution authorises to act, by person reference.", "examples": [ "[\"per_3Qm9\"]" ] }, "related_action_type": { "type": "string", "description": "Action type this resolution supports, so the approval is linked to it.", "examples": [ "us.shares.issue" ] }, "conflict_disclosures": { "type": "array", "items": {}, "description": "Interested directors and the nature of the interest, recorded in the resolution.", "examples": [ "[]" ] } }, "required": [ "state", "subject", "resolutions" ], "description": "Prepares a resolution and collects every director's own electronic consent. The board acts without a meeting only if all directors consent in writing or by electronic transmission." }, "Create_us_board_resolution_adopt": { "type": "object", "properties": { "type": { "const": "us.board_resolution.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_board_resolution_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt a board resolution by unanimous written consent", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Unanimous written consent of the board", "source": "generated", "required": true }, { "key": "supporting_documents", "title": "Supporting documents referred to in the resolution", "source": "uploaded", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Unanimous written consent of directors", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "director_missing", "type": null, "when": "A director in office has not been asked to consent or the list omits one." }, { "code": "director_declined", "type": null, "when": "A director declines; the board cannot act by consent." }, { "code": "director_unverified", "type": null, "when": "A director has not completed identity_address verification." }, { "code": "quorum_or_interest_conflict", "type": null, "when": "The resolution is a self-dealing transaction without recorded disclosures." } ] } }, "Params_us_bylaws_amend": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "amendments": { "type": "array", "items": {}, "description": "Each change: article or section, old text, new text.", "examples": [ "[{\"section\":\"3.2\",\"old\":\"The number of directors shall be three.\",\"new\":\"The number of directors shall be five.\"}]" ] }, "adopted_by": { "type": "string", "enum": [ "stockholders", "board", "both" ], "description": "Who adopts. board only if the certificate of incorporation confers the power (8 Del.", "examples": [ "stockholders" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the amendment takes effect.", "examples": [ "2026-10-20" ] }, "restated": { "type": "boolean", "description": "Issue a full restated bylaws document.", "examples": [ "true" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ reference when the amendment varies a class's rights, so that class's consent is collected.", "examples": [ "shc_series_a" ] }, "reason": { "type": "string", "description": "Purpose of the amendment, recorded in the resolution.", "examples": [ "Increase board size to five on Series A closing" ] } }, "required": [ "state", "amendments", "adopted_by" ], "description": "Amends the corporation's bylaws by stockholder action, or by board action where the certificate of incorporation gives the board that power, and issues the restated bylaws. Not filed with the state." }, "Create_us_bylaws_amend": { "type": "object", "properties": { "type": { "const": "us.bylaws.amend" }, "params": { "$ref": "#/components/schemas/Params_us_bylaws_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend the bylaws", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "constitution", "title": "Restated bylaws", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution adopting or recommending the amendment", "source": "generated", "required": false }, { "key": "members_resolution", "title": "Stockholder consent adopting the amendment", "source": "generated", "required": false }, { "key": "secretary_certificate", "title": "Secretary's certificate of the bylaws", "source": "generated", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "secretary_certificate", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Bylaw amendment under 8 Del. C. §109", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "board_power_not_conferred", "type": null, "when": "adopted_by is board but the certificate of incorporation does not give the board the power." }, { "code": "conflicts_with_charter", "type": null, "when": "The new text conflicts with the certificate of incorporation." }, { "code": "class_consent_missing", "type": null, "when": "A class-right change lacks that class's consent." }, { "code": "stockholder_agreement_conflict", "type": null, "when": "The change breaches a stockholders' agreement on file." } ] } }, "Params_us_defective_act_ratify": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code.", "examples": [ "DE" ] }, "defective_acts": { "type": "array", "items": {}, "description": "Each defective act: description, date it purported to occur, the nature of the failure of authorisation, and whether it is a corporate act or putative stock.", "examples": [ "[{\"kind\":\"putative_stock\",\"description\":\"2,000,000 common shares issued to founder without board approval\",\"purported_date\":\"2025-03-04\",\"failure\":\"No board resolution authorising issuance\"}]" ] }, "ratification_resolution_date": { "type": "string", "format": "date", "description": "Date the board adopts the ratifying resolutions.", "examples": [ "2026-10-30" ] }, "stockholder_approval_required": { "type": "boolean", "description": "True if the act, had it been validly taken, would have needed stockholder approval; Entiva computes this from the charter and ledger when omitted.", "examples": [ "true" ] }, "stockholder_meeting_date": { "type": "string", "format": "date", "description": "Meeting date when stockholder approval is by meeting.", "examples": [ "2026-11-25" ] }, "validation_effective_time": { "type": "string", "format": "date", "description": "Effective time of the Certificate of Validation, where one is needed.", "examples": [ "2026-12-01" ] }, "preclearance": { "type": "boolean", "description": "Ask the Division to review the draft certificate before filing.", "examples": [ "false" ] }, "s_corp_check": { "type": "boolean", "description": "For entities with an S election: check whether the ratified issuance affects shareholder eligibility.", "examples": [ "true" ] }, "counsel_reviewed": { "type": "boolean", "description": "Delaware counsel has reviewed the legal analysis.", "examples": [ "false" ] } }, "required": [ "state", "defective_acts", "ratification_resolution_date" ], "description": "Ratifies a corporate act or stock issuance that was defective when made, through board and, where required, stockholder approval, notice to holders, and, where the act would have required a filing, a Certificate of Validation filed in." }, "Create_us_defective_act_ratify": { "type": "object", "properties": { "type": { "const": "us.defective_act.ratify" }, "params": { "$ref": "#/components/schemas/Params_us_defective_act_ratify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Ratify a defective corporate act or putative stock", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board ratification resolutions", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Stockholder approval of the ratification", "source": "generated", "required": false }, { "key": "meeting_notice", "title": "Notice of stockholder meeting", "source": "generated", "required": false }, { "key": "ratification_notice", "title": "Notice of ratification to stockholders", "source": "generated", "required": true }, { "key": "certificate_of_validation", "title": "Certificate of Validation", "source": "generated", "required": false }, { "key": "stock_ledger_evidence", "title": "Cap table and issuance records", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "Division filing receipt and stamped certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "shareholder", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_validation", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "ratification_notice", "signer_role": "company_secretary", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Certificate of Validation", "channel": "online", "government_fee": { "amount": 2599, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "state_not_supported", "type": null, "when": "state is not DE; ratification procedures elsewhere are not yet supported." }, { "code": "notice_period_too_short", "type": null, "when": "The stockholder meeting date leaves less than 20 days' notice." }, { "code": "stockholder_approval_missing", "type": null, "when": "Stockholder approval was required and not obtained." }, { "code": "cap_table_unreconciled", "type": null, "when": "The cap table cannot be reconciled with the defective acts." }, { "code": "legal_review_required", "type": null, "when": "Entiva is outstanding." }, { "code": "s_corp_eligibility_risk", "type": null, "when": "Ratifying putative stock would give shares to an ineligible S corporation shareholder." }, { "code": "registry_rejected", "type": null, "when": "The Division rejects the certificate; the rejection reason is in the event." } ] } }, "Params_us_distribution_approve": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "distribution_type": { "type": "string", "enum": [ "cash", "in_kind", "tax_distribution", "return_of_capital", "liquidating" ], "description": "Kind of distribution.", "examples": [ "tax_distribution" ] }, "total_amount": { "$ref": "#/components/schemas/Money", "description": "Total value distributed.", "examples": [ "{\"amount\":120000,\"currency\":\"USD\"}" ] }, "allocation": { "type": "array", "items": {}, "description": "Per-holder amounts, each with holder reference and amount, following the agreement's waterfall.", "examples": [ "[{\"holder\":\"per_8Kd2\",\"amount\":{\"amount\":84000,\"currency\":\"USD\"}},{\"holder\":\"per_5Tw1\",\"amount\":{\"amount\":36000,\"currency\":\"USD\"}}]" ] }, "declaration_date": { "type": "string", "format": "date", "description": "Date of approval.", "examples": [ "2026-10-20" ] }, "payment_date": { "type": "string", "format": "date", "description": "Date of payment.", "examples": [ "2026-10-30" ] }, "approved_by": { "type": "string", "enum": [ "managers", "members", "general_partner", "partners" ], "description": "Who approves under the agreement.", "examples": [ "managers" ] }, "solvency_confirmation": { "type": "boolean", "description": "The approver confirms that, after the distribution, the entity's liabilities do not exceed the fair value of its assets, and that it can pay its debts as they.", "examples": [ "true" ] }, "balance_sheet_date": { "type": "string", "format": "date", "description": "Date of the figures relied on.", "examples": [ "2026-09-30" ] }, "series": { "type": "string", "description": "For a series LLC, the series paying the distribution; series assets stay separate.", "examples": [ "series_a" ] } }, "required": [ "state", "distribution_type", "total_amount", "allocation", "declaration_date", "payment_date", "approved_by", "solvency_confirmation" ], "description": "Records the manager, member or general partner approval of a distribution and tests it against the statutory limit that bars distributions that would leave liabilities above asset value." }, "Create_us_distribution_approve": { "type": "object", "properties": { "type": { "const": "us.distribution.approve" }, "params": { "$ref": "#/components/schemas/Params_us_distribution_approve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Approve an LLC or partnership distribution", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Resolution approving the distribution", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Balance sheet relied on", "source": "uploaded", "required": true }, { "key": "payment_schedule", "title": "Distribution schedule", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Manager, member or general partner approval of a distribution under the LLC or LP Act and ", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "insolvency_limit", "type": null, "when": "Balance sheet shows liabilities above asset value after the distribution." }, { "code": "allocation_mismatch", "type": null, "when": "Allocations do not sum to the total or do not follow the agreement's waterfall." }, { "code": "payee_sanctions_alert", "type": null, "when": "A payee has an open sanctions alert; the action is paused." }, { "code": "agreement_missing", "type": null, "when": "No operating or partnership agreement is on file." }, { "code": "s_corp_tax_status", "type": null, "when": "The entity is taxed as an S corporation and the allocation is not pro rata." } ] } }, "Params_us_dividend_declare": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "dividend_type": { "type": "string", "enum": [ "cash", "stock", "property" ], "description": "Form of the dividend.", "examples": [ "cash" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ reference of the class receiving the dividend.", "examples": [ "shc_common" ] }, "amount_per_share": { "$ref": "#/components/schemas/Money", "description": "Amount per share in the stated currency.", "examples": [ "{\"amount\":0.05,\"currency\":\"USD\"}" ] }, "total_amount": { "$ref": "#/components/schemas/Money", "description": "Total payment.", "examples": [ "{\"amount\":500000,\"currency\":\"USD\"}" ] }, "declaration_date": { "type": "string", "format": "date", "description": "Date the board declares the dividend.", "examples": [ "2026-10-20" ] }, "record_date": { "type": "string", "format": "date", "description": "Holders of record on this date are paid.", "examples": [ "2026-11-02" ] }, "payment_date": { "type": "string", "format": "date", "description": "Date payment is made.", "examples": [ "2026-11-16" ] }, "funding_source": { "type": "string", "enum": [ "surplus", "net_profits" ], "description": "Surplus, or net profits of the current or preceding fiscal year where there is no surplus.", "examples": [ "surplus" ] }, "surplus_calculation": { "type": "object", "description": "Balance sheet figures the board relies on: total assets, total liabilities, stated capital, resulting surplus.", "examples": [ "{\"total_assets\":4200000,\"total_liabilities\":1100000,\"capital\":10000,\"surplus\":3090000}" ] }, "solvency_confirmation": { "type": "boolean", "description": "The board confirms the corporation will be able to pay its debts as they fall due after the dividend.", "examples": [ "true" ] }, "tax_reporting": { "type": "boolean", "description": "Prepare data for Form 1099-DIV where required.", "examples": [ "true" ] } }, "required": [ "state", "dividend_type", "share_class", "amount_per_share", "declaration_date", "record_date", "payment_date", "funding_source", "solvency_confirmation" ], "description": "Prepares the board resolution declaring a dividend, tests it against the surplus rule, screens the payees, and records the payment in the ledger." }, "Create_us_dividend_declare": { "type": "object", "properties": { "type": { "const": "us.dividend.declare" }, "params": { "$ref": "#/components/schemas/Params_us_dividend_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a dividend", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution declaring the dividend", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Balance sheet supporting the surplus test", "source": "uploaded", "required": true }, { "key": "payment_schedule", "title": "Dividend payment schedule by holder", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Board resolution declaring a dividend from surplus or net profits", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "surplus_test_failed", "type": null, "when": "The balance sheet shows no surplus and no net profits for the current or preceding fiscal year." }, { "code": "solvency_not_confirmed", "type": null, "when": "solvency_confirmation is false or the balance sheet shows the corporation would be unable to pay debts." }, { "code": "payee_sanctions_alert", "type": null, "when": "A payee has an open sanctions alert; the action is paused." }, { "code": "s_corp_second_class_risk", "type": null, "when": "An S corporation dividend is not pro rata and could be a second class of stock." }, { "code": "record_date_invalid", "type": null, "when": "Record date, declaration date and payment date are out of order." } ] } }, "Params_us_member_consent_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "body": { "type": "string", "enum": [ "members", "managers", "general_partner", "limited_partners", "partners" ], "description": "Who decides under the agreement.", "examples": [ "members" ] }, "subject": { "type": "string", "description": "Title of the resolution.", "examples": [ "Admit new member and approve capital contribution" ] }, "resolutions": { "type": "array", "items": {}, "description": "Resolution items with title and text.", "examples": [ "[{\"title\":\"Approve loan\",\"text\":\"RESOLVED, that the Company borrow...\"}]" ] }, "signers": { "type": "array", "items": {}, "description": "Members, managers or partners who will sign.", "examples": [ "[\"per_8Kd2\",\"per_5Tw1\"]" ] }, "vote_required": { "type": "string", "enum": [ "unanimous", "majority", "majority_in_interest", "two_thirds_in_interest", "as_agreement" ], "description": "Threshold from the agreement; defaults to the one on file.", "examples": [ "majority_in_interest" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the resolution takes effect.", "examples": [ "2026-10-20" ] }, "related_action_type": { "type": "string", "description": "Action type this approval supports.", "examples": [ "us.llc_member.admit" ] } }, "required": [ "state", "body", "subject", "resolutions" ], "description": "Records an approval by an LLC's members or managers, or by a partnership's partners, under the operating or partnership agreement, and collects the signatures the agreement requires." }, "Create_us_member_consent_adopt": { "type": "object", "properties": { "type": { "const": "us.member_consent.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_member_consent_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt a member, manager or partner resolution", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Written consent of members, managers or partners", "source": "generated", "required": true }, { "key": "constitution", "title": "Operating or partnership agreement", "source": "uploaded", "required": false }, { "key": "power_of_attorney", "title": "Authority for an agent to sign for a member or partner", "source": "generated", "required": false } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "power_of_attorney", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "LLC or partnership consent under the operating or partnership agreement", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agreement_missing", "type": null, "when": "No operating or partnership agreement is on file to check the vote." }, { "code": "threshold_not_met", "type": null, "when": "Signatures do not reach the agreement's required vote." }, { "code": "proxy_not_permitted", "type": null, "when": "An agent signs for a member and the agreement does not permit proxies." }, { "code": "signer_not_member_of_record", "type": null, "when": "A signer is not on the member or partner register." } ] } }, "Params_us_minutes_record": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "body": { "type": "string", "enum": [ "board", "stockholders", "members", "managers", "partners", "committee" ], "description": "Which body met.", "examples": [ "board" ] }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the meeting.", "examples": [ "2026-10-14" ] }, "format": { "type": "string", "enum": [ "in_person", "remote", "hybrid" ], "description": "How the meeting was held.", "examples": [ "remote" ] }, "attendees": { "type": "array", "items": {}, "description": "Persons present, each with capacity and whether present for the whole meeting.", "examples": [ "[{\"person\":\"per_8Kd2\",\"capacity\":\"director\"}]" ] }, "agenda": { "type": "array", "items": {}, "description": "Items discussed, each with title, discussion summary, decision and vote tally.", "examples": [ "[{\"title\":\"Approve budget\",\"decision\":\"approved\",\"votes\":{\"for\":3,\"against\":0}}]" ] }, "chair": { "type": "string", "pattern": "^per_", "description": "Person who chaired the meeting.", "examples": [ "per_8Kd2" ] }, "secretary": { "type": "string", "pattern": "^per_", "description": "Officer recording the minutes.", "examples": [ "per_3Qm9" ] }, "notes": { "type": "string", "description": "Raw notes or transcript text to draft from.", "examples": [ "Budget presented by CFO..." ] } }, "required": [ "state", "body", "meeting_date", "format", "attendees", "agenda" ], "description": "Drafts minutes from the meeting notes or agenda, has the secretary approve them, and files them in the minute book. Delaware requires an officer to record proceedings." }, "Create_us_minutes_record": { "type": "object", "properties": { "type": { "const": "us.minutes.record" }, "params": { "$ref": "#/components/schemas/Params_us_minutes_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record minutes of a board or stockholder meeting", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "minutes", "title": "Minutes of meeting", "source": "generated", "required": true }, { "key": "meeting_notice", "title": "Notice of meeting and waivers", "source": "uploaded", "required": false }, { "key": "board_resolution", "title": "Resolutions passed at the meeting", "source": "generated", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "person_concerned", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "minutes", "signer_role": "company_secretary", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Minutes recorded", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "attendee_not_authorised", "type": null, "when": "A person recorded as voting is not a director, stockholder or member of record." }, { "code": "vote_arithmetic", "type": null, "when": "Vote tallies do not add up to the attendees entitled to vote." }, { "code": "secretary_not_verified", "type": null, "when": "The recording officer has not completed identity verification." } ] } }, "Params_us_operating_agreement_amend": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "amendments": { "type": "array", "items": {}, "description": "Each change: section, old text, new text.", "examples": [ "[{\"section\":\"5.1\",\"old\":\"Distributions are pro rata.\",\"new\":\"Distributions follow Schedule B.\"}]" ] }, "approval_basis": { "type": "string", "enum": [ "unanimous_members", "majority_in_interest", "manager_authority", "general_partner_authority", "as_agreement" ], "description": "The clause that governs amendment, so Entiva checks the vote.", "examples": [ "majority_in_interest" ] }, "signers": { "type": "array", "items": {}, "description": "Members, managers or partners who sign.", "examples": [ "[\"per_8Kd2\",\"per_5Tw1\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the amendment takes effect.", "examples": [ "2026-10-20" ] }, "restated": { "type": "boolean", "description": "Issue an amended and restated agreement.", "examples": [ "true" ] }, "series": { "type": "string", "description": "For a series LLC, the series the amendment affects; omit for the master agreement.", "examples": [ "series_a" ] }, "reason": { "type": "string", "description": "Purpose of the amendment.", "examples": [ "Add investor protective provisions" ] } }, "required": [ "state", "amendments", "approval_basis" ], "description": "Amends the operating agreement of an LLC, or the partnership agreement of an LP, LLP or LLLP, in the way the agreement itself allows, and issues the amended and restated agreement. Not filed with the state." }, "Create_us_operating_agreement_amend": { "type": "object", "properties": { "type": { "const": "us.operating_agreement.amend" }, "params": { "$ref": "#/components/schemas/Params_us_operating_agreement_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend an LLC operating agreement or partnership agreement", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "constitution", "title": "Amended and restated operating or partnership agreement", "source": "generated", "required": true }, { "key": "prior_constitution", "title": "Current agreement", "source": "uploaded", "required": false }, { "key": "members_resolution", "title": "Consent of members, managers or partners", "source": "generated", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Amendment to the LLC or partnership agreement", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "agreement_missing", "type": null, "when": "No current agreement is on file to check the amendment clause." }, { "code": "threshold_not_met", "type": null, "when": "Signatures fall short of the clause's vote." }, { "code": "affected_member_consent_missing", "type": null, "when": "A member whose rights are varied has not signed." }, { "code": "certificate_conflict", "type": null, "when": "The change requires an amendment to the filed certificate, which is a separate state filing." } ] } }, "Params_us_register_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code whose law governs the entity's records.", "examples": [ "DE" ] }, "register": { "type": "string", "enum": [ "stock_ledger", "member_register", "partner_register" ], "description": "Which record to set up or update.", "examples": [ "stock_ledger" ] }, "operation": { "type": "string", "enum": [ "set_up", "import_opening_balances", "correct", "change_custodian" ], "description": "set_up opens the record and appoints Entiva to keep it; import_opening_balances loads an existing record for a transferred-in entity; correct fixes an.", "examples": [ "import_opening_balances" ] }, "as_of": { "type": "string", "format": "date", "description": "Date the entries are true on.", "examples": [ "2026-10-17" ] }, "entries": { "type": "array", "items": {}, "description": "Holder rows: holder, share_class, quantity or percentage_interest, acquired_on, certificated, consideration.", "examples": [ "[{\"holder\":\"per_8Kd2\",\"share_class\":\"shc_common\",\"quantity\":8000000,\"acquired_on\":\"2025-03-04\"}]" ] }, "certificated": { "type": "boolean", "description": "True if paper or electronic certificates exist.", "examples": [ "false" ] }, "custodian": { "type": "string", "pattern": "^per_", "description": "The officer charged with keeping the record, normally the secretary.", "examples": [ "per_3Qm9" ] }, "electronic_format": { "type": "boolean", "description": "Keep the record on an electronic database.", "examples": [ "true" ] }, "reason": { "type": "string", "description": "Why a correction or custodian change is made.", "examples": [ "Founder transfer to family trust recorded under the wrong class" ] } }, "required": [ "state", "register", "operation", "as_of" ], "description": "Opens or corrects the entity's statutory record of who holds what: the stock ledger and cap table for corporations, the member and manager record for LLCs, the partner record for LPs, LLPs and LLLPs. The record is kept by Entiva and is." }, "Create_us_register_change": { "type": "object", "properties": { "type": { "const": "us.register.change" }, "params": { "$ref": "#/components/schemas/Params_us_register_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Set up or update the stock ledger, member register or partner register", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution appointing Entiva's ledger as the system of record", "source": "generated", "required": false }, { "key": "opening_balance_evidence", "title": "Evidence for opening balances", "source": "uploaded", "required": false }, { "key": "register_extract", "title": "Register extract as of the effective date", "source": "generated", "required": true } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "unanimous", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "register_extract", "signer_role": "company_secretary", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "Stock ledger", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ledger_inconsistent", "type": null, "when": "Entries exceed authorised shares, produce a negative balance or do not add to the stated total." }, { "code": "holder_unverified", "type": null, "when": "A holder at 25% or more has no verification at identity_address." }, { "code": "holder_sanctions_match", "type": null, "when": "An open sanctions alert exists for a holder; live actions are paused." }, { "code": "s_corp_ineligible_holder", "type": null, "when": "The entity has an S election and an entry is a nonresident alien, entity or other ineligible holder, or takes the count above 100." }, { "code": "professional_licence_missing", "type": null, "when": "A professional corporation or PLLC entry has an owner with no verified licence." }, { "code": "evidence_missing", "type": null, "when": "import_opening_balances or correct without opening_balance_evidence." } ] } }, "Params_us_stockholder_consent_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter state code or DC.", "examples": [ "DE" ] }, "subject": { "type": "string", "description": "Short title of the matter approved.", "examples": [ "Approve 2026 equity incentive plan amendment" ] }, "resolutions": { "type": "array", "items": {}, "description": "Resolution text items, each with title, text and the vote required.", "examples": [ "[{\"title\":\"Amend plan\",\"text\":\"RESOLVED, that...\",\"vote\":\"majority\"}]" ] }, "consenting_stockholders": { "type": "array", "items": {}, "description": "Stockholders who will sign, each with share_class and shares held on the record date, and optionally a proxy_holder.", "examples": [ "[{\"stockholder\":\"per_8Kd2\",\"share_class\":\"shc_common\",\"shares\":8000000}]" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ reference when only one class votes or must consent separately.", "examples": [ "shc_common" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date or time the consent takes effect.", "examples": [ "2026-10-20" ] }, "record_date": { "type": "string", "format": "date", "description": "Record date fixed by the board for determining consenting stockholders.", "examples": [ "2026-10-17" ] }, "notify_non_consenting": { "type": "boolean", "description": "Send prompt notice to non-consenting stockholders when consent is less than unanimous (8 Del.", "examples": [ "true" ] }, "delivery_to_entity": { "type": "string", "enum": [ "entiva_system", "registered_office", "principal_place_of_business" ], "description": "Where signed consents are delivered.", "examples": [ "entiva_system" ] } }, "required": [ "state", "subject", "resolutions", "consenting_stockholders" ], "description": "Records stockholders' action without a meeting on any matter they may decide: elections, charter or bylaw changes, approvals of transactions. Collects each stockholder's or proxy holder's electronic signature and sends the prompt notice to." }, "Create_us_stockholder_consent_adopt": { "type": "object", "properties": { "type": { "const": "us.stockholder_consent.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_stockholder_consent_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt a stockholder written consent", "x-entiva": { "jurisdiction": "us", "stage": "governance", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Stockholder written consent", "source": "generated", "required": true }, { "key": "proxy", "title": "Stockholder proxy", "source": "uploaded", "required": false }, { "key": "consent_notice", "title": "Notice of action by written consent to non-consenting stockholders", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Delivery receipt log for the consents", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "proxy", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "proxy", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_notice", "signer_role": "company_secretary", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "None", "form": "Stockholder written consent", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "consent_threshold_not_met", "type": null, "when": "Signed consents do not reach the vote that would be needed at a meeting." }, { "code": "consent_action_restricted", "type": null, "when": "The charter prohibits or limits stockholder action by written consent." }, { "code": "proxy_expired", "type": null, "when": "A proxy older than its term is used." }, { "code": "class_consent_missing", "type": null, "when": "The matter varies a class's rights and that class has not consented." }, { "code": "stockholder_not_of_record", "type": null, "when": "A signer is not on the stock ledger on the record date." } ] } }, "Params_us_director_appoint": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of the entity's registration.", "examples": [ "DE" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The person being elected or appointed.", "examples": [ "per_8Hq2LmWx" ] }, "position": { "type": "string", "enum": [ "director", "manager" ], "description": "director for corporations; manager for manager-managed LLCs and PLLCs.", "examples": [ "director" ] }, "election_method": { "type": "string", "enum": [ "stockholder_meeting", "stockholder_consent", "board_vacancy_fill", "member_consent" ], "description": "How the seat is filled.", "examples": [ "stockholder_consent" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing director this appointment replaces.", "examples": [ "per_3Kd9PqTz" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-11-02" ] }, "term_ends": { "type": "string", "format": "date", "description": "End of term where the charter, bylaws or LLC agreement set one.", "examples": [ "2027-06-30" ] }, "board_class": { "type": "string", "description": "Class of a classified board, if the entity has one.", "examples": [ "Class II" ] }, "board_size_after": { "type": "integer", "description": "Number of directors in office after the change, used to check the bylaws' authorised board size.", "examples": [ "3" ] }, "file_state_update": { "type": "boolean", "description": "Whether Entiva files the state officer/director update where the state offers one.", "examples": [ "true" ] } }, "required": [ "state", "director", "election_method" ], "description": "Records the election or appointment of a director or manager, including filling a vacancy or replacing an outgoing director. Entiva drafts the stockholder or member action and the board resolution, collects the appointee's consent to." }, "Create_us_director_appoint": { "type": "object", "properties": { "type": { "const": "us.director.appoint" }, "params": { "$ref": "#/components/schemas/Params_us_director_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Elect or appoint a director or manager", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_multi_member", "pllc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Stockholder or member action electing the director", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": false }, { "key": "consent_to_act", "title": "Consent to act as director or manager", "source": "generated", "required": true }, { "key": "nv_amended_list", "title": "Nevada amended list of officers and directors", "source": "generated", "required": false }, { "key": "wy_officer_director_update", "title": "Wyoming Update of Officers/Directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "proxy", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "nv_amended_list", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "wy_officer_director_update", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE: none. NV: amended list of officers and directors. WY: Update of Officers/Directors. Ot", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "person_not_verified", "type": null, "when": "The appointee has not reached identity_address." }, { "code": "director_must_be_natural_person", "type": null, "when": "A corporation's director is an entity (8 Del." }, { "code": "sanctions_alert_open", "type": null, "when": "An open screening alert exists on the appointee, which pauses live actions." }, { "code": "board_size_exceeded", "type": null, "when": "The appointment would exceed the authorised number of directors in the bylaws." }, { "code": "wy_annual_report_not_on_file", "type": null, "when": "state is WY and no annual report is on file, so the update form cannot be used." }, { "code": "state_not_supported", "type": null, "when": "The state's filing rules are not yet modelled; Entiva returns a requirement for manual handling." } ] } }, "Params_us_director_remove": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of registration.", "examples": [ "DE" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The director or manager being removed.", "examples": [ "per_3Kd9PqTz" ] }, "removal_method": { "type": "string", "enum": [ "stockholder_meeting", "stockholder_consent", "member_vote", "llc_agreement_process" ], "description": "Stockholders remove directors, with or without cause unless the charter or board structure limits it (DGCL 141); LLC managers are removed as the LLC agreement.", "examples": [ "stockholder_consent" ] }, "for_cause": { "type": "boolean", "description": "Whether the removal is for cause.", "examples": [ "false" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the removal takes effect.", "examples": [ "2026-11-02" ] }, "successor": { "type": "string", "pattern": "^per_", "description": "Person elected in the same action.", "examples": [ "per_8Hq2LmWx" ] }, "reason": { "type": "string", "description": "Internal note for the minute book; not filed.", "examples": [ "Investor board seat reallocated" ] }, "file_state_update": { "type": "boolean", "description": "Whether Entiva files the state update where one exists.", "examples": [ "true" ] } }, "required": [ "state", "director", "removal_method" ], "description": "Removes a director or an LLC manager, end-dates the register entry, and files the NV amended list or WY update where the state has one. Delaware has no filing." }, "Create_us_director_remove": { "type": "object", "properties": { "type": { "const": "us.director.remove" }, "params": { "$ref": "#/components/schemas/Params_us_director_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove a director or manager", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_multi_member", "pllc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Stockholder or member action removing the director", "source": "generated", "required": true }, { "key": "removal_notice", "title": "Notice of removal to the director", "source": "generated", "required": true }, { "key": "nv_amended_list", "title": "Nevada amended list of officers and directors", "source": "generated", "required": false }, { "key": "wy_officer_director_update", "title": "Wyoming Update of Officers/Directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "proxy", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "nv_amended_list", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "wy_officer_director_update", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_director_removal", "type": null, "when": "The removal would leave the board with no director and no successor is named." }, { "code": "removal_not_permitted", "type": null, "when": "The charter, a classified board or cumulative voting bars removal without cause and for_cause is false." }, { "code": "director_not_in_register", "type": null, "when": "The person is not a current director or manager in the register." }, { "code": "insufficient_votes", "type": null, "when": "The signed consents do not reach the threshold in the bylaws or LLC agreement." }, { "code": "state_not_supported", "type": null, "when": "The state's filing rules are not yet modelled." } ] } }, "Params_us_director_resign": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of registration.", "examples": [ "NV" ] }, "director": { "type": "string", "pattern": "^per_", "description": "The director or manager who is resigning.", "examples": [ "per_3Kd9PqTz" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the resignation takes effect, which may be later than delivery if the notice says so.", "examples": [ "2026-11-15" ] }, "resignation_letter": { "type": "string", "pattern": "^doc_", "description": "doc_ id of a signed letter the director already holds.", "examples": [ "doc_5Gh2JkLm" ] }, "reason": { "type": "string", "description": "Internal note for the minute book; not filed.", "examples": [ "Stepping down to focus on another venture" ] }, "file_state_update": { "type": "boolean", "description": "Whether Entiva files the state update where one exists.", "examples": [ "true" ] } }, "required": [ "state", "director", "effective_date" ], "description": "Records a director's or manager's resignation, end-dates the register entry, and files the NV amended list or WY update where the state has one. Delaware has no filing." }, "Create_us_director_resign": { "type": "object", "properties": { "type": { "const": "us.director.resign" }, "params": { "$ref": "#/components/schemas/Params_us_director_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a director or manager resignation", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_multi_member", "pllc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Resignation letter", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board acknowledgment of resignation", "source": "generated", "required": false }, { "key": "nv_amended_list", "title": "Nevada amended list of officers and directors", "source": "generated", "required": false }, { "key": "wy_officer_director_update", "title": "Wyoming Update of Officers/Directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nv_amended_list", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "wy_officer_director_update", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Secretary of State", "form": "", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "last_director_resignation", "type": null, "when": "The resignation would leave the entity with no director or manager and no successor is pending." }, { "code": "director_not_in_register", "type": null, "when": "The person is not a current director or manager." }, { "code": "nv_list_deadline_passed", "type": null, "when": "state is NV and the 60-day no-fee window has passed; a $75 charge applies." }, { "code": "state_not_supported", "type": null, "when": "The state's filing rules are not yet modelled." } ] } }, "Params_us_incumbency_certificate_issue": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of registration; decides notarisation and apostille routes.", "examples": [ "DE" ] }, "certifier": { "type": "string", "pattern": "^per_", "description": "The secretary or other officer who keeps the records and signs the certificate.", "examples": [ "per_7Rb4TnQs" ] }, "officers": { "type": "array", "items": {}, "description": "person_ref list of those to include.", "examples": [ "[\"per_7Rb4TnQs\",\"per_1Mc6WyHd\"]" ] }, "include_specimen_signatures": { "type": "boolean", "description": "Collect a specimen signature from each listed person.", "examples": [ "true" ] }, "as_of_date": { "type": "string", "format": "date", "description": "Date the incumbency is true; defaults to today.", "examples": [ "2026-11-03" ] }, "recipient": { "type": "string", "description": "Bank, counterparty or registry the certificate is for.", "examples": [ "First Example Bank, N.A." ] }, "countersigner": { "type": "string", "pattern": "^per_", "description": "Another officer who certifies the certifier's own incumbency and signature.", "examples": [ "per_1Mc6WyHd" ] }, "legalisation": { "type": "string", "enum": [ "none", "notarised", "notarised_apostilled" ], "description": "As for us.secretary_certificate.issue.", "examples": [ "none" ] }, "notarisation_method": { "type": "string", "enum": [ "in_person", "remote_online" ], "description": "Remote online notarisation is state law and may not be accepted at the destination.", "examples": [ "in_person" ] }, "destination_country": { "type": "string", "description": "ISO 3166 country of use when legalised.", "examples": [ "SG" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "state", "certifier" ], "description": "Prepares a company-issued incumbency certificate listing the current directors and officers, optionally with specimen signatures, for banks and counterparties. No US state issues one." }, "Create_us_incumbency_certificate_issue": { "type": "object", "properties": { "type": { "const": "us.incumbency_certificate.issue" }, "params": { "$ref": "#/components/schemas/Params_us_incumbency_certificate_issue" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Issue an incumbency certificate", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "statutory_trust", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "incumbency_certificate", "title": "Incumbency certificate", "source": "generated", "required": true }, { "key": "specimen_signature", "title": "Specimen signature page", "source": "uploaded", "required": false }, { "key": "notarial_certificate", "title": "Notarial certificate", "source": "uploaded", "required": false }, { "key": "apostille", "title": "Apostille", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "incumbency_certificate", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "incumbency_certificate", "signer_role": "other", "method": "wet_ink_notarised", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "incumbency_certificate", "signer_role": "other", "method": "wet_ink_notarised_apostilled", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "specimen_signature", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None for the certificate itself", "form": "Incumbency certificate", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "certifier_not_in_register", "type": null, "when": "The certifier is not a current secretary, officer, manager or general partner." }, { "code": "listed_person_not_in_register", "type": null, "when": "A person in officers is not a current director or officer." }, { "code": "register_out_of_date", "type": null, "when": "Pending officer actions exist that would change the list; finish or cancel them first." }, { "code": "ron_not_available", "type": null, "when": "Remote online notarisation is requested where it is not available." } ] } }, "Params_us_irs_address_change": { "type": "object", "properties": { "mailing_address": { "$ref": "#/components/schemas/Address", "description": "New mailing address.", "examples": [ "{\"line1\":\"500 Market St\",\"line2\":\"Suite 12\",\"city\":\"Austin\",\"state\":\"TX\",\"postal_code\":\"78701\",\"country\":\"US\"}" ] }, "business_location": { "$ref": "#/components/schemas/Address", "description": "New business location.", "examples": [ "{\"line1\":\"500 Market St\",\"city\":\"Austin\",\"state\":\"TX\",\"postal_code\":\"78701\",\"country\":\"US\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date of the change.", "examples": [ "2026-11-01" ] }, "responsible_party": { "type": "string", "pattern": "^per_", "description": "Set only if the responsible party also changes, so Entiva prepares one form; the responsible-party rules then apply.", "examples": [ "per_7Rb4TnQs" ] }, "ein": { "type": "string", "description": "Nine-digit EIN; defaults to the EIN on the entity record.", "examples": [ "12-3456789" ] } }, "required": [ "effective_date" ], "description": "Reports a new mailing address or business location for the entity's EIN on Form 8822-B. This updates the IRS only; it does not change the state registered office or principal address." }, "Create_us_irs_address_change": { "type": "object", "properties": { "type": { "const": "us.irs_address.change" }, "params": { "$ref": "#/components/schemas/Params_us_irs_address_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the IRS mailing address or business location", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "unincorporated_nonprofit_association", "wy_duna", "corporation_sole", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "irs_form_8822b", "title": "IRS Form 8822-B", "source": "generated", "required": true }, { "key": "signed_irs_form_8822b", "title": "Signed Form 8822-B", "source": "uploaded", "required": true }, { "key": "proof_of_mailing", "title": "Proof of mailing", "source": "generated", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "irs_form_8822b", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form 8822-B, Change of Address or Responsible Party - Business", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "address_required", "type": null, "when": "Neither mailing_address nor business_location is given." }, { "code": "no_ein_on_record", "type": null, "when": "The entity has no EIN yet." }, { "code": "wet_ink_original_missing", "type": null, "when": "The signed original has not reached Entiva." }, { "code": "po_box_as_location", "type": null, "when": "business_location is a PO box; the IRS wants a street address for the location." } ] } }, "Params_us_nominee_arrangement_declare": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of registration.", "examples": [ "WY" ] }, "nominee": { "type": "string", "pattern": "^per_", "description": "The director or manager who acts on another person's instructions.", "examples": [ "per_4Vd8HsKt" ] }, "nominator": { "type": "string", "pattern": "^per_", "description": "The person whose instructions the nominee follows.", "examples": [ "per_6Zn2CpWe" ] }, "position": { "type": "string", "enum": [ "director", "manager" ], "description": "Seat the nominee holds.", "examples": [ "manager" ] }, "arrangement_scope": { "type": "string", "description": "Short description of the instructions or authority the nominator holds.", "examples": [ "Votes as directed by the nominator on all board matters" ] }, "agreement": { "type": "string", "pattern": "^doc_", "description": "doc_ id of a nominee services agreement or signed declaration naming the nominator.", "examples": [ "doc_2Sx9LdVn" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the arrangement starts.", "examples": [ "2026-11-01" ] } }, "required": [ "state", "nominee", "nominator", "position" ], "description": "The US has no residency or nationality requirement for directors, officers, members or managers in Delaware, Wyoming or Nevada, so no resident or nominee director is needed. Only the registered agent must be in-state." }, "Create_us_nominee_arrangement_declare": { "type": "object", "properties": { "type": { "const": "us.nominee_arrangement.declare" }, "params": { "$ref": "#/components/schemas/Params_us_nominee_arrangement_declare" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Declare a nominee director or manager arrangement", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "nominee_declaration", "title": "Nominee declaration", "source": "generated", "required": true }, { "key": "nominee_agreement", "title": "Nominee services agreement", "source": "uploaded", "required": false }, { "key": "passport", "title": "Photo ID of nominee and nominator", "source": "uploaded", "required": false } ], "people": [ { "role": "nominee", "verification_level": "identity_address" }, { "role": "nominator", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "nominee_declaration", "signer_role": "nominee", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "nominee_declaration", "signer_role": "nominator", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "None", "form": "None. DE, WY and NV impose no residency or nationality requirement", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nominator_not_disclosed", "type": null, "when": "The nominee acts on instructions but no nominator is given." }, { "code": "person_not_verified", "type": null, "when": "The nominee or nominator has not reached identity_address." }, { "code": "sanctions_alert_open", "type": null, "when": "An open screening alert exists on either party." }, { "code": "nominee_not_in_register", "type": null, "when": "The nominee is not a current director or manager." } ] } }, "Params_us_officer_appoint": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of registration.", "examples": [ "DE" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "The person being appointed.", "examples": [ "per_7Rb4TnQs" ] }, "title": { "type": "string", "enum": [ "president", "chief_executive_officer", "chief_financial_officer", "chief_operating_officer", "treasurer", "secretary", "vice_president", "general_counsel", "other" ], "description": "Office held.", "examples": [ "secretary" ] }, "title_other": { "type": "string", "description": "Free-text title when title is other.", "examples": [ "Chief Revenue Officer" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the appointment takes effect.", "examples": [ "2026-11-02" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing holder of the same office.", "examples": [ "per_1Mc6WyHd" ] }, "authorised_signatory": { "type": "boolean", "description": "Whether the officer is added to the entity's signing authority for Entiva filings.", "examples": [ "false" ] }, "ein_responsible_party": { "type": "boolean", "description": "True if the officer is to become the IRS responsible party.", "examples": [ "false" ] }, "file_state_update": { "type": "boolean", "description": "Whether Entiva files the state officer update where one exists.", "examples": [ "true" ] } }, "required": [ "state", "officer", "title" ], "description": "Appoints an officer by board resolution, collects the officer's consent and identity checks, updates the officer register, and files the NV amended list or WY update where the state has one. Delaware has no filing; officers appear on the." }, "Create_us_officer_appoint": { "type": "object", "properties": { "type": { "const": "us.officer.appoint" }, "params": { "$ref": "#/components/schemas/Params_us_officer_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint an officer or secretary", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution appointing the officer", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Officer's acceptance of office", "source": "generated", "required": true }, { "key": "nv_amended_list", "title": "Nevada amended list of officers and directors", "source": "generated", "required": false }, { "key": "wy_officer_director_update", "title": "Wyoming Update of Officers/Directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "company_secretary", "verification_level": "identity" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "appointee", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" }, { "document_key": "nv_amended_list", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "wy_officer_director_update", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Secretary of State", "form": "DE: none, reported on the next annual franchise tax report. NV: amended list naming presid", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "person_not_verified", "type": null, "when": "The officer has not reached the verification level for their title." }, { "code": "nv_officer_set_incomplete", "type": null, "when": "state is NV and the list would lack a president, secretary or treasurer." }, { "code": "title_held_by_other", "type": null, "when": "The office is held by someone else and replaces is not set; the bylaws may still allow joint holders." }, { "code": "sanctions_alert_open", "type": null, "when": "An open screening alert exists on the appointee." }, { "code": "state_not_supported", "type": null, "when": "The state's filing rules are not yet modelled." } ] } }, "Params_us_officer_remove": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of registration.", "examples": [ "NV" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "The officer being removed.", "examples": [ "per_1Mc6WyHd" ] }, "title": { "type": "string", "enum": [ "president", "chief_executive_officer", "chief_financial_officer", "chief_operating_officer", "treasurer", "secretary", "vice_president", "general_counsel", "other" ], "description": "The office being ended.", "examples": [ "treasurer" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the removal takes effect.", "examples": [ "2026-11-02" ] }, "successor": { "type": "string", "pattern": "^per_", "description": "Person appointed to the same office in the same action; raises a linked us.officer.appoint.", "examples": [ "per_7Rb4TnQs" ] }, "reason": { "type": "string", "description": "Internal note for the minute book; not filed.", "examples": [ "Role eliminated in restructuring" ] }, "revoke_signing_authority": { "type": "boolean", "description": "Whether to remove the person from the entity's signing authority and Entiva mandates.", "examples": [ "true" ] }, "file_state_update": { "type": "boolean", "description": "Whether Entiva files the state update where one exists.", "examples": [ "true" ] } }, "required": [ "state", "officer" ], "description": "Removes an officer from office by board resolution, end-dates the register and files the NV or WY update where one exists." }, "Create_us_officer_remove": { "type": "object", "properties": { "type": { "const": "us.officer.remove" }, "params": { "$ref": "#/components/schemas/Params_us_officer_remove" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Remove an officer or secretary", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution removing the officer", "source": "generated", "required": true }, { "key": "removal_notice", "title": "Notice of removal to the officer", "source": "generated", "required": false }, { "key": "nv_amended_list", "title": "Nevada amended list of officers and directors", "source": "generated", "required": false }, { "key": "wy_officer_director_update", "title": "Wyoming Update of Officers/Directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "none" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nv_amended_list", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "wy_officer_director_update", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Secretary of State", "form": "", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nv_officer_set_incomplete", "type": null, "when": "state is NV and the removal would leave no president, secretary or treasurer." }, { "code": "officer_not_in_register", "type": null, "when": "The person does not hold the stated office." }, { "code": "active_mandate_depends_on_officer", "type": null, "when": "A mandate was granted by this officer; it must be re-granted by another authorised person." }, { "code": "state_not_supported", "type": null, "when": "The state's filing rules are not yet modelled." } ] } }, "Params_us_officer_resign": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of registration.", "examples": [ "NV" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "The officer who is resigning.", "examples": [ "per_1Mc6WyHd" ] }, "title": { "type": "string", "enum": [ "president", "chief_executive_officer", "chief_financial_officer", "chief_operating_officer", "treasurer", "secretary", "vice_president", "general_counsel", "other" ], "description": "The office resigned.", "examples": [ "treasurer" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the resignation takes effect.", "examples": [ "2026-11-15" ] }, "resignation_letter": { "type": "string", "pattern": "^doc_", "description": "doc_ id of a signed letter the officer already holds; otherwise Entiva generates one.", "examples": [ "doc_9Pt3WqRn" ] }, "successor": { "type": "string", "pattern": "^per_", "description": "Person appointed to the office in the same action.", "examples": [ "per_7Rb4TnQs" ] }, "revoke_signing_authority": { "type": "boolean", "description": "Whether to remove the person from signing authority and mandates.", "examples": [ "true" ] }, "file_state_update": { "type": "boolean", "description": "Whether Entiva files the state update where one exists.", "examples": [ "true" ] } }, "required": [ "state", "officer", "effective_date" ], "description": "Records an officer's resignation, end-dates the register and signing authority, and files the NV or WY update where one exists. Delaware has no filing." }, "Create_us_officer_resign": { "type": "object", "properties": { "type": { "const": "us.officer.resign" }, "params": { "$ref": "#/components/schemas/Params_us_officer_resign" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record an officer or secretary resignation", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "resignation_letter", "title": "Resignation letter", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board acknowledgment of resignation", "source": "generated", "required": false }, { "key": "nv_amended_list", "title": "Nevada amended list of officers and directors", "source": "generated", "required": false }, { "key": "wy_officer_director_update", "title": "Wyoming Update of Officers/Directors", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Registry filing receipt", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "resignation_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "nv_amended_list", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "wy_officer_director_update", "signer_role": "manager", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Nevada Secretary of State", "form": "", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "nv_officer_set_incomplete", "type": null, "when": "state is NV and the resignation would leave no president, secretary or treasurer." }, { "code": "officer_not_in_register", "type": null, "when": "The person does not hold the stated office." }, { "code": "nv_list_deadline_passed", "type": null, "when": "state is NV and the 60-day no-fee window has passed; $75 applies." }, { "code": "state_not_supported", "type": null, "when": "The state's filing rules are not yet modelled." } ] } }, "Params_us_responsible_party_change": { "type": "object", "properties": { "responsible_party": { "type": "string", "pattern": "^per_", "description": "The new responsible party.", "examples": [ "per_7Rb4TnQs" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "The previous responsible party, if on file.", "examples": [ "per_1Mc6WyHd" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the change occurred.", "examples": [ "2026-11-02" ] }, "ein": { "type": "string", "description": "Nine-digit EIN; defaults to the EIN on the entity record.", "examples": [ "12-3456789" ] }, "reason": { "type": "string", "description": "Internal note.", "examples": [ "Founder stepped down as CEO" ] } }, "required": [ "responsible_party", "effective_date" ], "description": "Reports a new EIN responsible party to the IRS on Form 8822-B within 60 days of the change. The responsible party must be an individual." }, "Create_us_responsible_party_change": { "type": "object", "properties": { "type": { "const": "us.responsible_party.change" }, "params": { "$ref": "#/components/schemas/Params_us_responsible_party_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change the IRS responsible party", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "unincorporated_nonprofit_association", "wy_duna", "corporation_sole", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "irs_form_8822b", "title": "IRS Form 8822-B", "source": "generated", "required": true }, { "key": "signed_irs_form_8822b", "title": "Signed Form 8822-B", "source": "uploaded", "required": true }, { "key": "proof_of_mailing", "title": "Proof of mailing", "source": "generated", "required": false } ], "people": [ { "role": "other", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "irs_form_8822b", "signer_role": "member", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form 8822-B, Change of Address or Responsible Party - Business", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "responsible_party_must_be_individual", "type": null, "when": "The chosen person is a legal entity or a nominee." }, { "code": "tin_missing", "type": null, "when": "No SSN or ITIN is on the verification record for the new responsible party." }, { "code": "no_ein_on_record", "type": null, "when": "The entity has no EIN yet; use the EIN application action instead." }, { "code": "deadline_passed", "type": null, "when": "More than 60 days have passed since effective_date." }, { "code": "wet_ink_original_missing", "type": null, "when": "The signed original has not reached Entiva." } ] } }, "Params_us_secretary_certificate_issue": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of registration; decides notarisation and apostille routes.", "examples": [ "DE" ] }, "certifier": { "type": "string", "pattern": "^per_", "description": "The secretary or other officer who keeps the records; for an LLC or LP, a manager or general partner.", "examples": [ "per_7Rb4TnQs" ] }, "certifies": { "type": "array", "items": {}, "description": "What the certificate attests.", "examples": [ "[\"resolutions\",\"bylaws_or_operating_agreement\"]" ] }, "resolutions": { "type": "array", "items": {}, "description": "doc_ ids of the board or member resolutions to attach and certify.", "examples": [ "[\"doc_6Vk1BtYh\"]" ] }, "as_of_date": { "type": "string", "format": "date", "description": "Date the certified facts are true; defaults to today.", "examples": [ "2026-11-03" ] }, "recipient": { "type": "string", "description": "Bank, counterparty or registry the certificate is for.", "examples": [ "First Example Bank, N.A." ] }, "countersigner": { "type": "string", "pattern": "^per_", "description": "Another officer who certifies the certifier's own incumbency and signature, as banks usually ask.", "examples": [ "per_1Mc6WyHd" ] }, "legalisation": { "type": "string", "enum": [ "none", "notarised", "notarised_apostilled" ], "description": "none: signed electronically. notarised: acknowledgment or jurat by a notary. notarised_apostilled: notarised then apostilled by the competent authority of the.", "examples": [ "none" ] }, "notarisation_method": { "type": "string", "enum": [ "in_person", "remote_online" ], "description": "Remote online notarisation is state law and may not be accepted at the destination.", "examples": [ "remote_online" ] }, "destination_country": { "type": "string", "description": "ISO 3166 country of use when legalised.", "examples": [ "GB" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "The share class affected." } }, "required": [ "state", "certifier", "certifies" ], "description": "Prepares a company-issued secretary's certificate that certifies resolutions, constitutional documents and the minute book to a bank or counterparty. US states do not issue incumbency certificates, so this private document is signed by the." }, "Create_us_secretary_certificate_issue": { "type": "object", "properties": { "type": { "const": "us.secretary_certificate.issue" }, "params": { "$ref": "#/components/schemas/Params_us_secretary_certificate_issue" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Issue a secretary's certificate", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "statutory_trust", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "secretary_certificate", "title": "Secretary's certificate", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolutions to be certified", "source": "uploaded", "required": false }, { "key": "notarial_certificate", "title": "Notarial certificate", "source": "uploaded", "required": false }, { "key": "apostille", "title": "Apostille", "source": "registry_issued", "required": false } ], "people": [ { "role": "company_secretary", "verification_level": "identity" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "secretary_certificate", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_certificate", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "secretary_certificate", "signer_role": "other", "method": "wet_ink_notarised", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "secretary_certificate", "signer_role": "other", "method": "wet_ink_notarised_apostilled", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "None for the certificate itself", "form": "Secretary's certificate", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "certifier_not_in_register", "type": null, "when": "The certifier is not a current secretary, officer, manager or general partner." }, { "code": "resolution_not_in_minute_book", "type": null, "when": "A resolution to certify is not in the entity's records and was not uploaded." }, { "code": "ron_not_available", "type": null, "when": "Remote online notarisation is requested in a state or for a destination where it is not available." }, { "code": "destination_requires_legalisation", "type": null, "when": "destination_country is not a Hague Convention state; authentication and consular legalisation are needed outside this action." } ] } }, "Params_us_trustee_appoint": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Must be DE.", "examples": [ "DE" ] }, "trustee": { "type": "string", "pattern": "^per_", "description": "The Delaware trustee being appointed: an individual or a legal-entity person.", "examples": [ "per_5Tc1MqJw" ] }, "trustee_basis": { "type": "string", "enum": [ "delaware_resident_individual", "delaware_principal_place_of_business_entity", "registered_investment_company_exemption" ], "description": "Why the trustee qualifies under 12 Del.", "examples": [ "delaware_principal_place_of_business_entity" ] }, "trustee_address": { "$ref": "#/components/schemas/Address", "description": "Delaware address of the trustee to be named in the certificate.", "examples": [ "{\"line1\":\"1000 N West St\",\"city\":\"Wilmington\",\"state\":\"DE\",\"postal_code\":\"19801\",\"country\":\"US\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the amendment; defaults to filing.", "examples": [ "2026-11-10" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "Outgoing trustee.", "examples": [ "per_9Lb4DsPe" ] }, "expedite": { "type": "string", "enum": [ "standard", "expedited" ], "examples": [ "standard" ] } }, "required": [ "state", "trustee", "trustee_basis", "trustee_address" ], "description": "Appoints a qualifying Delaware trustee and files a Certificate of Amendment to the Certificate of Trust naming the trustee and its Delaware address. A Delaware statutory trust must have at least one such trustee at all times unless it is a." }, "Create_us_trustee_appoint": { "type": "object", "properties": { "type": { "const": "us.trustee.appoint" }, "params": { "$ref": "#/components/schemas/Params_us_trustee_appoint" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Appoint a Delaware trustee of a statutory trust", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_amendment", "title": "Certificate of Amendment to Certificate of Trust", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Trustee's acceptance of appointment", "source": "generated", "required": true }, { "key": "constitution", "title": "Governing instrument or amendment appointing the trustee", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Delaware stamped filing", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "certificate_of_amendment", "signer_role": "trustee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "trustee", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Certificate of Amendment to Certificate of Trust", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trustee_not_delaware_qualified", "type": null, "when": "The trustee is not a Delaware resident or an entity with its principal place of business in Delaware and no 3807 exemption applies." }, { "code": "state_not_supported", "type": null, "when": "state is not DE." }, { "code": "person_not_verified", "type": null, "when": "The trustee or signatory has not reached identity_address." }, { "code": "registry_rejected", "type": null, "when": "The Division rejects the certificate, for example for a name or form defect." } ] } }, "Params_us_trustee_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Must be DE.", "examples": [ "DE" ] }, "trustee": { "type": "string", "pattern": "^per_", "description": "The successor Delaware trustee.", "examples": [ "per_5Tc1MqJw" ] }, "replaces": { "type": "string", "pattern": "^per_", "description": "The outgoing trustee.", "examples": [ "per_9Lb4DsPe" ] }, "trustee_basis": { "type": "string", "enum": [ "delaware_resident_individual", "delaware_principal_place_of_business_entity", "registered_investment_company_exemption" ], "description": "Why the successor qualifies under 12 Del.", "examples": [ "delaware_principal_place_of_business_entity" ] }, "trustee_address": { "$ref": "#/components/schemas/Address", "description": "Delaware address of the successor trustee for the filing.", "examples": [ "{\"line1\":\"1000 N West St\",\"city\":\"Wilmington\",\"state\":\"DE\",\"postal_code\":\"19801\",\"country\":\"US\"}" ] }, "additional_trusts": { "type": "array", "items": {}, "description": "Other statutory trusts covered by the same succession certificate.", "examples": [ "[\"ent_3Jf7LpQa\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the succession takes effect.", "examples": [ "2026-11-10" ] }, "expedite": { "type": "string", "enum": [ "standard", "expedited" ], "description": "Expedited handling for a separate Delaware fee; the schedule was not re-read.", "examples": [ "standard" ] } }, "required": [ "state", "trustee", "replaces", "trustee_basis", "trustee_address" ], "description": "Replaces a Delaware statutory trust's trustee and files a Certificate of Succession of Trustee, which can cover several trusts in one filing. Use us.trustee.appoint when adding a trustee by amendment." }, "Create_us_trustee_change": { "type": "object", "properties": { "type": { "const": "us.trustee.change" }, "params": { "$ref": "#/components/schemas/Params_us_trustee_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Replace a Delaware trustee by certificate of succession", "x-entiva": { "jurisdiction": "us", "stage": "officers_and_people", "applies_to": [ "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_succession", "title": "Certificate of Succession of Trustee", "source": "generated", "required": true }, { "key": "consent_to_act", "title": "Successor trustee's acceptance", "source": "generated", "required": true }, { "key": "constitution", "title": "Governing instrument or removal/resignation instrument", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Delaware stamped filing", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "trustee", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "certificate_of_succession", "signer_role": "trustee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "consent_to_act", "signer_role": "trustee", "method": "click_consent", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Certificate of Succession of Trustee", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "trustee_not_delaware_qualified", "type": null, "when": "The successor is not Delaware-qualified and no 3807 exemption applies." }, { "code": "state_not_supported", "type": null, "when": "state is not DE." }, { "code": "additional_trust_not_found", "type": null, "when": "An entity in additional_trusts is not a Delaware statutory trust in the account." }, { "code": "registry_rejected", "type": null, "when": "The Division rejects the certificate." } ] } }, "Params_us_authorised_share_increase": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class whose authorised number changes." }, "number_of_shares": { "type": "integer", "description": "New total authorised shares of the class." }, "par_value": { "$ref": "#/components/schemas/Money", "description": "Par value per share, if it changes." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "meeting_date": { "type": "string", "format": "date", "description": "Date of the stockholder meeting, if one is held instead of written consent." }, "effective_date": { "type": "string", "format": "date", "description": "Future effective date or time." } }, "required": [ "state", "entity_type", "number_of_shares" ], "description": "Certificate of amendment raising the authorised shares of a class. Board and stockholder approval, then a state filing." }, "Create_us_authorised_share_increase": { "type": "object", "properties": { "type": { "const": "us.authorised_share.increase" }, "params": { "$ref": "#/components/schemas/Params_us_authorised_share_increase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Increase authorised shares", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution declaring the amendment advisable", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder consent or meeting minutes", "source": "generated", "required": true }, { "key": "certificate_of_amendment", "title": "Certificate of amendment / articles of amendment", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Amendment", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "not_an_increase", "type": null, "when": "The new authorised number is not above the current one." }, { "code": "stockholder_approval_missing", "type": null, "when": "Required stockholder or class approval has not been given." }, { "code": "state_name_not_in_good_standing", "type": null, "when": "The registry rejects the filing because the entity is not in good standing or has unpaid franchise tax." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_authorised_share_reduce": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class whose authorised number falls." }, "number_of_shares": { "type": "integer", "description": "New total authorised shares of the class." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date." } }, "required": [ "state", "entity_type", "number_of_shares" ], "description": "Certificate of amendment lowering the authorised shares of a class, never below the shares issued and reserved." }, "Create_us_authorised_share_reduce": { "type": "object", "properties": { "type": { "const": "us.authorised_share.reduce" }, "params": { "$ref": "#/components/schemas/Params_us_authorised_share_reduce" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Decrease authorised shares", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution declaring the amendment advisable", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder consent or meeting minutes", "source": "generated", "required": true }, { "key": "certificate_of_amendment", "title": "Certificate of amendment", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Amendment", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "reduction_below_issued_or_reserved", "type": null, "when": "The new number is below issued shares plus shares reserved for options, warrants and convertibles." }, { "code": "not_a_decrease", "type": null, "when": "The new number is not below the current one." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_blue_sky_notice_file": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "lp", "lllp", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "wy_dao_llc" ], "description": "Entity type of the issuer.", "examples": [ "c_corp" ] }, "notice_type": { "type": "string", "enum": [ "rule_506_offering", "option_grants" ], "description": "What the notice covers.", "examples": [ "rule_506_offering" ] }, "form_d": { "type": "string", "pattern": "^ent_", "description": "act_ reference of the us.form_d.file action, or the EDGAR accession number." }, "states": { "type": "array", "items": {}, "description": "One item per state: {state, investors, amount_sold, date_of_first_sale_in_state}.", "examples": [ "[{\"state\":\"CA\",\"investors\":3,\"amount_sold\":{\"amount\":\"900000\",\"currency\":\"USD\"},\"date_of_first_sale_in_state\":\"2026-11-02\"}]" ] }, "exemption": { "type": "string", "enum": [ "rule_506b", "rule_506c", "rule_701" ], "description": "Federal exemption relied on.", "examples": [ "rule_506b" ] }, "amendment": { "type": "boolean", "description": "Whether this amends an earlier notice." } }, "required": [ "entity_type", "notice_type", "states", "exemption" ], "description": "State notice filings for a Rule 506 offering, one per state where investors reside, mostly through NASAA's Electronic Filing Depository. Also used for state notices on option grants where a state requires them." }, "Create_us_blue_sky_notice_file": { "type": "object", "properties": { "type": { "const": "us.blue_sky_notice.file" }, "params": { "$ref": "#/components/schemas/Params_us_blue_sky_notice_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File state blue-sky notices", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "lp", "lllp", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_d", "title": "Copy of Form D as filed", "source": "generated", "required": true }, { "key": "consent_to_service", "title": "Consent to service of process", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "State filing receipts, one per state", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "consent_to_service", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "self" } ], "filing": { "registry": "State securities regulators", "form": "State notice filing: copy of Form D, consent to service and fee", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "state_not_supported", "type": null, "when": "Entiva cannot file a notice for that state through EFD or directly; the requirement lists what to do." }, { "code": "form_d_not_filed", "type": null, "when": "The linked Form D has not been filed or the accession number is missing." }, { "code": "state_deadline_passed", "type": null, "when": "A state's notice deadline has passed." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_form_3921_file": { "type": "object", "properties": { "tax_year": { "type": "integer", "description": "Calendar year of the exercises.", "examples": [ "2026" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "exercises": { "type": "array", "items": {}, "description": "One item per exercise: {optionee, grant_date, exercise_date, exercise_price_per_share, fair_market_value_per_share, shares_transferred." }, "filing_method": { "type": "string", "enum": [ "electronic", "paper" ], "description": "Paper or electronic.", "examples": [ "electronic" ] } }, "required": [ "tax_year", "entity_type", "exercises" ], "description": "Annual information return and employee statement for each exercise of an incentive stock option in the tax year." }, "Create_us_form_3921_file": { "type": "object", "properties": { "type": { "const": "us.form_3921.file" }, "params": { "$ref": "#/components/schemas/Params_us_form_3921_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File IRS Form 3921", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_3921", "title": "Form 3921 information return", "source": "generated", "required": true }, { "key": "employee_statement", "title": "Statement furnished to each optionee", "source": "generated", "required": true }, { "key": "form_1096", "title": "Form 1096 transmittal", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "IRS acknowledgment", "source": "registry_issued", "required": false } ], "people": [ { "role": "recipient", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "form_3921", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "form_1096", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form 3921, Exercise of an Incentive Stock Option Under Section 422", "channel": "both", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "missing_tax_id", "type": null, "when": "An optionee has no tax ID on the person record." }, { "code": "exercise_not_iso", "type": null, "when": "An exercise was not of an incentive stock option, so no Form 3921 applies." }, { "code": "filing_deadline_passed", "type": null, "when": "The tax-year deadline has passed." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_form_d_file": { "type": "object", "properties": { "type_of_filing": { "type": "string", "enum": [ "new_notice", "amendment" ], "description": "New notice or amendment.", "examples": [ "new_notice" ] }, "share_issue": { "type": "string", "pattern": "^ent_", "description": "act_ reference of the us.share.issue action that made the first sale." }, "exemption": { "type": "string", "enum": [ "rule_504", "rule_506b", "rule_506c", "section_4a5" ], "description": "Federal exemption claimed.", "examples": [ "rule_506b" ] }, "date_of_first_sale": { "type": "string", "format": "date", "description": "Date the first investor was irrevocably contractually committed." }, "securities_offered": { "type": "string", "enum": [ "equity", "debt", "option_or_warrant", "pooled_investment_fund_interest", "other" ], "description": "Type of security.", "examples": [ "equity" ] }, "total_offering_amount": { "$ref": "#/components/schemas/Money", "description": "Total offering amount, or indefinite." }, "total_amount_sold": { "$ref": "#/components/schemas/Money", "description": "Amount sold to date." }, "number_of_investors": { "type": "integer", "description": "Investors who have invested." }, "non_accredited_investors": { "type": "integer", "description": "Non-accredited investors (Rule 506 allows up to 35)." }, "investors_by_state": { "type": "array", "items": {}, "description": "Items {state, investors, amount}." }, "related_persons": { "type": "array", "items": {}, "description": "Executive officers, directors and promoters: person references with relationship." }, "sales_compensation": { "type": "array", "items": {}, "description": "Placement agents or finders: name, CRD number, states solicited, commission." }, "industry_group": { "type": "string", "description": "SEC industry group and issuer size category." }, "offering_over_one_year": { "type": "boolean", "description": "Whether the offering will last more than one year." }, "previous_accession_number": { "type": "string", "description": "Required when type_of_filing is amendment." }, "bad_actor_disqualification": { "type": "boolean", "description": "Issuer confirms no Rule 506 disqualifying event." } }, "required": [ "type_of_filing", "exemption", "date_of_first_sale", "securities_offered", "total_offering_amount", "total_amount_sold", "number_of_investors", "investors_by_state", "related_persons", "industry_group", "bad_actor_disqualification" ], "description": "Notice of an exempt Regulation D offering filed on SEC EDGAR within 15 days after the first sale. Entiva files as the issuer's delegated filing agent through a named, Login.gov-authenticated staff member." }, "Create_us_form_d_file": { "type": "object", "properties": { "type": { "const": "us.form_d.file" }, "params": { "$ref": "#/components/schemas/Params_us_form_d_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File SEC Form D", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "series_llc", "lp", "lllp", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_d", "title": "Form D", "source": "generated", "required": true }, { "key": "edgar_authentication_document", "title": "Rule 302 authentication document signed by the issuer's signatory", "source": "generated", "required": true }, { "key": "edgar_attestation", "title": "One-time manual attestation before first e-signing (Rule 302)", "source": "uploaded", "required": false }, { "key": "edgar_access_form", "title": "Form ID if the issuer has no CIK", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "EDGAR acceptance message", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "board", "threshold": "each", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "edgar_authentication_document", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "edgar_attestation", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "form_d", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "edgar_access_form", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "US Securities and Exchange Commission, EDGAR", "form": "Form D", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "form_d_deadline_passed", "type": null, "when": "More than 15 days since first sale." }, { "code": "edgar_access_missing", "type": null, "when": "The issuer has no CIK or no account administrator with Login.gov credentials." }, { "code": "authentication_document_unsigned", "type": null, "when": "The signatory has not signed the Rule 302 authentication document." }, { "code": "bad_actor_disqualified", "type": null, "when": "The issuer cannot confirm no disqualifying event." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_option_grant": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "plan": { "type": "string", "pattern": "^ent_", "description": "act_ reference of the adopted plan, or its plan id." }, "recipients": { "type": "array", "items": {}, "description": "Items {person, award_type, number_of_shares, exercise_price, relationship, residence_state}." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class underlying the grant." }, "effective_date": { "type": "string", "format": "date", "description": "Grant date." }, "vesting": { "type": "object", "description": "{commencement_date, cliff_months, total_months, schedule, early_exercise, acceleration}." }, "expiry_date": { "type": "string", "format": "date", "description": "Option expiry." }, "valuation": { "type": "string", "pattern": "^ent_", "description": "act_ reference of a us.share_valuation.request, or a doc_ of a 409A report supporting fair market value." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." } }, "required": [ "state", "entity_type", "plan", "recipients", "effective_date", "vesting", "valuation" ], "description": "Board grant of options or restricted awards to an employee, director or consultant under an adopted plan, at an exercise price at or above 409A fair market value." }, "Create_us_option_grant": { "type": "object", "properties": { "type": { "const": "us.option.grant" }, "params": { "$ref": "#/components/schemas/Params_us_option_grant" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Grant stock options", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board consent granting options and determining fair market value", "source": "generated", "required": true }, { "key": "option_agreement", "title": "Stock option agreement and notice of grant", "source": "generated", "required": true }, { "key": "valuation_report", "title": "409A valuation report relied on", "source": "uploaded", "required": true }, { "key": "stock_ledger_extract", "title": "Option ledger and cap table", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "recipient", "verification_level": "none" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "option_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "option_agreement", "signer_role": "recipient", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. No registry filing for a grant", "form": "Board consent", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "exercise_price_below_fair_market_value", "type": null, "when": "The exercise price is below the value in the valuation report." }, { "code": "valuation_stale", "type": null, "when": "The valuation is over 12 months old or a material event has occurred since." }, { "code": "plan_reserve_exceeded", "type": null, "when": "The grant exceeds the plan's remaining reserve." }, { "code": "iso_recipient_ineligible", "type": null, "when": "An incentive stock option is requested for a non-employee." }, { "code": "recipient_sanctions_match", "type": null, "when": "A recipient matches an OFAC list." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_option_plan_adopt": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "name": { "type": "string", "description": "Plan name, e.g. 2026 Equity Incentive Plan." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class reserved for awards." }, "number_of_shares": { "type": "integer", "description": "Shares reserved for the plan." }, "award_types": { "type": "array", "items": {}, "description": "Allowed awards: incentive_stock_option, nonstatutory_stock_option, restricted_stock, restricted_stock_unit, stock_appreciation_right.", "examples": [ "[\"incentive_stock_option\",\"nonstatutory_stock_option\"]" ] }, "eligible_classes": { "type": "array", "items": {}, "description": "Who may receive awards: employee, director, consultant, advisor." }, "administrator": { "type": "string", "enum": [ "board", "committee" ], "description": "Who administers the plan.", "examples": [ "board" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Plan effective date." }, "plan_document": { "type": "string", "pattern": "^doc_", "description": "doc_ reference of a customer-supplied plan." } }, "required": [ "state", "entity_type", "name", "number_of_shares", "award_types", "eligible_classes", "effective_date" ], "description": "Board and stockholder approval of an equity incentive plan and its share reserve. No registry filing." }, "Create_us_option_plan_adopt": { "type": "object", "properties": { "type": { "const": "us.option_plan.adopt" }, "params": { "$ref": "#/components/schemas/Params_us_option_plan_adopt" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Adopt equity incentive plan", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "equity_incentive_plan", "title": "Equity incentive plan and form of option agreement", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution adopting the plan and reserving shares", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder approval of the plan", "source": "generated", "required": true }, { "key": "stock_ledger_extract", "title": "Cap table showing the reserve", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "proxy", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" } ], "filing": { "registry": "None. Not filed with the state", "form": "Board and stockholder approval of the plan", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorised_shares_insufficient", "type": null, "when": "The reserve exceeds authorised but unissued, unreserved shares of the class." }, { "code": "stockholder_approval_missing", "type": null, "when": "Stockholder approval has not been given where required." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_preferred_series_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "series": { "type": "string", "description": "shc_ reference of the series." }, "change_type": { "type": "string", "enum": [ "increase", "decrease", "eliminate" ], "description": "What the certificate does.", "examples": [ "increase" ] }, "number_of_shares": { "type": "integer", "description": "New designated total for increase or decrease." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date." } }, "required": [ "state", "entity_type", "series", "change_type" ], "description": "Certificate of increase, decrease or elimination for a designated series of preferred stock." }, "Create_us_preferred_series_change": { "type": "object", "properties": { "type": { "const": "us.preferred_series.change" }, "params": { "$ref": "#/components/schemas/Params_us_preferred_series_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Increase, decrease or eliminate a preferred series", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution increasing, decreasing or eliminating the series", "source": "generated", "required": true }, { "key": "certificate_of_designation", "title": "Certificate of increase, decrease or elimination", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_designation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Increase or Decrease, or Certificate of Elimination, for a series", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "series_has_outstanding_shares", "type": null, "when": "Elimination was requested while shares of the series are outstanding." }, { "code": "reduction_below_issued", "type": null, "when": "A decrease would go below issued shares of the series." }, { "code": "exceeds_authorised_preferred", "type": null, "when": "An increase exceeds undesignated preferred shares." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_preferred_series_designate": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "name": { "type": "string", "description": "Series name, e.g." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ reference of the blank-check preferred class that the series belongs to." }, "number_of_shares": { "type": "integer", "description": "Shares designated in the series." }, "par_value": { "$ref": "#/components/schemas/Money", "description": "Par value per share." }, "terms": { "type": "object", "description": "{dividend {rate, cumulative, participating}, liquidation_preference {multiple, participating, cap}, conversion {ratio, anti_dilution}, voting {votes_per_share." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date." } }, "required": [ "state", "entity_type", "name", "share_class", "number_of_shares", "terms" ], "description": "Board creates a series of preferred stock under blank-check authority in the charter and files the certificate of designations before any shares of the series are issued." }, "Create_us_preferred_series_designate": { "type": "object", "properties": { "type": { "const": "us.preferred_series.designate" }, "params": { "$ref": "#/components/schemas/Params_us_preferred_series_designate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File certificate of designations", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution fixing the series terms (8 Del.", "source": "generated", "required": true }, { "key": "certificate_of_designation", "title": "Certificate of designations", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_designation", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Designations", "channel": "online", "government_fee": { "amount": 189, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "no_blank_check_authority", "type": null, "when": "The charter does not give the board authority to fix series terms." }, { "code": "exceeds_authorised_preferred", "type": null, "when": "Designated shares exceed the unissued, undesignated preferred shares." }, { "code": "s_corp_second_class_of_stock", "type": null, "when": "The entity has an S election and the preferred terms would create a second class of stock, which the S election does not allow (IRC 1361, recollection)." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_cancel": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class whose shares are retired." }, "number_of_shares": { "type": "integer", "description": "Shares retired." }, "source": { "type": "string", "enum": [ "treasury", "redeemed", "repurchased", "surrendered", "converted" ], "description": "Where the shares come from.", "examples": [ "treasury" ] }, "repurchase": { "type": "string", "pattern": "^ent_", "description": "act_ reference of the us.share.repurchase action." }, "file_certificate": { "type": "boolean", "description": "File a certificate of retirement to reduce authorised shares." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Retirement date." } }, "required": [ "state", "entity_type", "number_of_shares", "source", "file_certificate", "effective_date" ], "description": "Retire repurchased, redeemed or surrendered shares and, where needed, file a certificate of retirement to reduce authorised shares." }, "Create_us_share_cancel": { "type": "object", "properties": { "type": { "const": "us.share.cancel" }, "params": { "$ref": "#/components/schemas/Params_us_share_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Retire shares", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution retiring the shares", "source": "generated", "required": true }, { "key": "certificate_of_retirement", "title": "Certificate of retirement", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": false }, { "key": "stock_ledger_extract", "title": "Updated ledger", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_retirement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Delaware Certificate of Retirement", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "shares_not_available", "type": null, "when": "The shares to retire are not held in treasury or already redeemed." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_consolidate": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class being consolidated." }, "ratio": { "type": "object", "description": "{new_shares, old_shares}: for a 1-for-10 reverse split, {1, 10}.", "examples": [ "{\"new_shares\":1,\"old_shares\":10}" ] }, "number_of_shares": { "type": "integer", "description": "New total authorised shares if they change." }, "par_value": { "$ref": "#/components/schemas/Money", "description": "Par value per share after the split." }, "fractional_shares": { "type": "string", "enum": [ "round_up", "round_down", "cash_in_lieu" ], "description": "Treatment of fractions.", "examples": [ "cash_in_lieu" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date." } }, "required": [ "state", "entity_type", "ratio", "fractional_shares", "effective_date" ], "description": "Reverse split of a class by certificate of amendment, with adjustment of options, warrants and convertibles." }, "Create_us_share_consolidate": { "type": "object", "properties": { "type": { "const": "us.share.consolidate" }, "params": { "$ref": "#/components/schemas/Params_us_share_consolidate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Reverse stock split", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the reverse split", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder consent", "source": "generated", "required": true }, { "key": "certificate_of_amendment", "title": "Certificate of amendment", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": true }, { "key": "stock_ledger_extract", "title": "Ledger restated after split", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Amendment", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ratio_invalid", "type": null, "when": "The ratio is not a reverse split." }, { "code": "cash_in_lieu_unfunded", "type": null, "when": "Cash in lieu is chosen and the company cannot show funds, or payment would impair capital." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_issue": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp" ], "description": "Entity type of the issuer.", "examples": [ "c_corp" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ reference of the class to issue.", "examples": [ "shc_common" ] }, "purchasers": { "type": "array", "items": {}, "description": "One item per purchaser: {person, number_of_shares, price_per_share, accredited_investor, residence_state}.", "examples": [ "[{\"person\":\"per_1Nb\",\"number_of_shares\":1000000,\"price_per_share\":{\"amount\":\"1.20\",\"currency\":\"USD\"},\"accredited_investor\":true,\"residence_state\":\"CA\"}]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Issue date, when title passes and the ledger entry is made." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of the board resolution." }, "consideration_type": { "type": "string", "enum": [ "cash", "ip_assignment", "services", "safe_conversion", "convertible_note_conversion", "other_property" ], "description": "What the company receives for the shares.", "examples": [ "cash" ] }, "consideration_description": { "type": "string", "description": "Description of non-cash consideration." }, "conversion": { "type": "object", "description": "For SAFE or note conversions: {instrument_document, conversion_price, conversion_basis}." }, "restricted_stock": { "type": "object", "description": "Vesting for founder or employee stock: {vesting_commencement_date, cliff_months, total_months, repurchase_right}." }, "exemption": { "type": "string", "enum": [ "rule_506b", "rule_506c", "rule_504", "section_4a2", "rule_701", "regulation_s", "other" ], "description": "Securities-law exemption relied on. rule_506b and rule_506c trigger Form D and state notices.", "examples": [ "rule_506b" ] }, "uncertificated": { "type": "boolean", "description": "Issue uncertificated shares." } }, "required": [ "state", "entity_type", "purchasers", "effective_date", "consideration_type", "exemption" ], "description": "Board-approved issuance of new shares in a financing round, founder grant or SAFE or note conversion. Entiva drafts the resolution and purchase agreements, checks authorised shares and eligibility, and updates the stock ledger." }, "Create_us_share_issue": { "type": "object", "properties": { "type": { "const": "us.share.issue" }, "params": { "$ref": "#/components/schemas/Params_us_share_issue" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Issue new shares", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution or unanimous written consent approving the issuance, price and consideration", "source": "generated", "required": true }, { "key": "stock_purchase_agreement", "title": "Stock purchase or subscription agreement", "source": "generated", "required": true }, { "key": "safe_agreement", "title": "SAFE or convertible note being converted", "source": "uploaded", "required": false }, { "key": "investor_questionnaire", "title": "Accredited-investor questionnaire", "source": "uploaded", "required": false }, { "key": "bad_actor_questionnaire", "title": "Rule 506 bad-actor questionnaire for covered persons", "source": "uploaded", "required": false }, { "key": "stockholder_consent", "title": "Stockholder or preferred class consent", "source": "generated", "required": false }, { "key": "share_certificate", "title": "Share certificate or uncertificated-shares notice", "source": "generated", "required": true }, { "key": "stock_ledger_extract", "title": "Updated stock ledger and cap table", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stock_purchase_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stock_purchase_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "share_certificate", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. The stock ledger is an internal register kept", "form": "Board resolution", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "authorised_shares_exceeded", "type": null, "when": "The issue would take issued shares above the authorised number for the class." }, { "code": "s_corp_ineligible_shareholder", "type": null, "when": "The entity has an S election and a purchaser is a nonresident alien, an ineligible entity, or the 100-shareholder limit would be passed." }, { "code": "purchaser_sanctions_match", "type": null, "when": "A purchaser or an owner behind it matches an OFAC list." }, { "code": "exemption_not_available", "type": null, "when": "A Rule 506 exemption is chosen but a non-accredited purchaser or a bad-actor disclosure blocks it." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_repurchase": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "shareholder": { "type": "string", "pattern": "^per_", "description": "Holder selling or redeeming." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class repurchased." }, "number_of_shares": { "type": "integer", "description": "Shares repurchased." }, "price_per_share": { "$ref": "#/components/schemas/Money", "description": "Price per share." }, "repurchase_type": { "type": "string", "enum": [ "negotiated", "tender_offer", "redemption", "unvested_share_repurchase", "departing_employee" ], "description": "Basis of the repurchase.", "examples": [ "negotiated" ] }, "disposition": { "type": "string", "enum": [ "hold_as_treasury", "retire" ], "description": "What happens to the shares.", "examples": [ "hold_as_treasury" ] }, "surplus_determination": { "type": "object", "description": "{basis, surplus_amount, financial_statements}." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Payment and transfer date." } }, "required": [ "state", "entity_type", "shareholder", "number_of_shares", "price_per_share", "repurchase_type", "disposition", "surplus_determination", "effective_date" ], "description": "Board-approved repurchase or redemption of shares from a holder, with a capital-impairment test. Shares are held as treasury or retired by us.share.cancel." }, "Create_us_share_repurchase": { "type": "object", "properties": { "type": { "const": "us.share.repurchase" }, "params": { "$ref": "#/components/schemas/Params_us_share_repurchase" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Repurchase or redeem shares", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the repurchase with surplus and capital-impairment determination", "source": "generated", "required": true }, { "key": "repurchase_agreement", "title": "Repurchase or redemption agreement", "source": "generated", "required": true }, { "key": "stock_power", "title": "Stock power from the seller", "source": "generated", "required": true }, { "key": "financial_statements", "title": "Balance sheet supporting the surplus determination", "source": "uploaded", "required": true }, { "key": "stock_ledger_extract", "title": "Updated ledger showing treasury or cancelled shares", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "repurchase_agreement", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "repurchase_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "stock_power", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None unless the shares are retired and authorised shares must fall", "form": "Board resolution with capital-impairment test", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "capital_impairment", "type": null, "when": "The surplus determination shows the payment would impair capital." }, { "code": "insufficient_holding", "type": null, "when": "The seller holds fewer shares than the repurchase needs." }, { "code": "transfer_restricted", "type": null, "when": "Charter, bylaws or an agreement bars the repurchase without consent that is missing." }, { "code": "s_corp_second_class_risk", "type": null, "when": "An S corporation repurchase on non-pro-rata terms may raise a second-class-of-stock question." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_subdivide": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class being split." }, "ratio": { "type": "object", "description": "{new_shares, old_shares}: for a 3-for-1 split, {3, 1}.", "examples": [ "{\"new_shares\":3,\"old_shares\":1}" ] }, "number_of_shares": { "type": "integer", "description": "New total authorised shares if authorised shares change with the split." }, "par_value": { "$ref": "#/components/schemas/Money", "description": "Par value per share after the split." }, "fractional_shares": { "type": "string", "enum": [ "round_up", "round_down", "cash_in_lieu" ], "description": "Treatment of fractions.", "examples": [ "round_down" ] }, "record_date": { "type": "string", "format": "date", "description": "Record date for holders." }, "resolution_date": { "type": "string", "format": "date", "description": "Date of board approval." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the split." } }, "required": [ "state", "entity_type", "ratio", "effective_date" ], "description": "Forward split of a class by certificate of amendment, with proportionate adjustment to options, warrants and convertibles." }, "Create_us_share_subdivide": { "type": "object", "properties": { "type": { "const": "us.share.subdivide" }, "params": { "$ref": "#/components/schemas/Params_us_share_subdivide" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Forward stock split", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the split and adjustments", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder consent", "source": "generated", "required": true }, { "key": "certificate_of_amendment", "title": "Certificate of amendment", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed-stamped certificate", "source": "registry_issued", "required": true }, { "key": "stock_ledger_extract", "title": "Ledger restated after split", "source": "generated", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Amendment", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "ratio_invalid", "type": null, "when": "The ratio is not a forward split." }, { "code": "authorised_shares_insufficient", "type": null, "when": "The split would take issued and reserved shares above the authorised number and no new total was given." }, { "code": "registry_rejected", "type": null, "when": "The Secretary of State rejected the certificate." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_transfer": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of formation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "pllc", "lp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "transferor": { "type": "string", "pattern": "^per_", "description": "Current holder." }, "transferee": { "type": "string", "pattern": "^per_", "description": "New holder." }, "share_class": { "type": "string", "pattern": "^shc_", "description": "shc_ class transferred." }, "number_of_shares": { "type": "integer", "description": "Shares transferred." }, "interest_percent": { "type": "number", "description": "Percentage of the LLC or partnership interest transferred." }, "transfer_type": { "type": "string", "enum": [ "sale", "gift", "inheritance", "intra_group", "pledge_enforcement", "other" ], "description": "Nature of the transfer.", "examples": [ "sale" ] }, "consideration": { "$ref": "#/components/schemas/Money", "description": "Price paid, if any." }, "effective_date": { "type": "string", "format": "date", "description": "Date of transfer on the books." }, "restrictions_waived": { "type": "boolean", "description": "Whether rights of first refusal and consent requirements have been waived or satisfied." }, "uncertificated": { "type": "boolean", "description": "Issue an uncertificated notice." }, "surrendered_certificate": { "type": "string", "pattern": "^doc_", "description": "doc_ of the surrendered certificate." } }, "required": [ "state", "entity_type", "transferor", "transferee", "transfer_type", "effective_date" ], "description": "Record a transfer of stock, LLC or LP interests between holders: stock power or assignment, transfer-restriction waivers, ledger update, new certificate or notice. No state filing in DE, WY or NV." }, "Create_us_share_transfer": { "type": "object", "properties": { "type": { "const": "us.share.transfer" }, "params": { "$ref": "#/components/schemas/Params_us_share_transfer" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer shares or LLC interests", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "llc_single_member", "llc_multi_member", "pllc", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "stock_power", "title": "Stock power or assignment of interest", "source": "generated", "required": true }, { "key": "share_transfer_agreement", "title": "Stock purchase, gift or assignment agreement", "source": "generated", "required": false }, { "key": "board_resolution", "title": "Board or manager consent approving the transfer where restrictions apply", "source": "generated", "required": false }, { "key": "joinder", "title": "Joinder to the operating, partnership or stockholders' agreement", "source": "generated", "required": false }, { "key": "share_certificate", "title": "Surrendered certificate, and new certificate or uncertificated notice", "source": "uploaded", "required": false }, { "key": "stock_ledger_extract", "title": "Updated stock ledger or member record", "source": "generated", "required": true } ], "people": [ { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "stock_power", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "share_transfer_agreement", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "joinder", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None. No state filing in DE, WY or NV", "form": "Stock power or assignment", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "transfer_restricted", "type": null, "when": "A transfer restriction or right of first refusal has not been waived or satisfied." }, { "code": "transferee_ineligible_s_corp", "type": null, "when": "The entity has an S election and the transferee is a nonresident alien or ineligible entity, or the 100-holder limit would be passed." }, { "code": "professional_licence_not_verified", "type": null, "when": "A professional corporation or PLLC transferee has no verified licence." }, { "code": "insufficient_holding", "type": null, "when": "The transferor holds fewer shares or less interest than the transfer needs." }, { "code": "certificate_not_surrendered", "type": null, "when": "The shares are certificated and the certificate or a lost-certificate affidavit is missing." }, { "code": "transferee_sanctions_match", "type": null, "when": "The transferee or an owner behind it matches an OFAC list." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_share_valuation_request": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "description": "Entity type.", "examples": [ "c_corp" ] }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of incorporation.", "examples": [ "DE" ] }, "valuation_date": { "type": "string", "format": "date", "description": "As-of date of the valuation." }, "share_classes": { "type": "array", "items": {}, "description": "shc_ references to value, usually the common stock." }, "method": { "type": "string", "enum": [ "independent_appraisal", "illiquid_startup_valuation" ], "description": "Basis for the presumption of reasonableness.", "examples": [ "independent_appraisal" ] }, "purpose": { "type": "string", "enum": [ "option_grants", "restricted_stock", "stock_rights_other" ], "description": "What the valuation supports.", "examples": [ "option_grants" ] }, "previous_valuation_date": { "type": "string", "format": "date", "description": "Date of the last valuation." }, "material_events": { "type": "array", "items": {}, "description": "Financings, offers, milestones or other events since the last valuation." } }, "required": [ "entity_type", "state", "valuation_date", "share_classes", "method", "purpose" ], "description": "Order an independent 409A appraisal of common stock, supported by a data pack from Entiva, and have the board adopt the fair market value before option grants." }, "Create_us_share_valuation_request": { "type": "object", "properties": { "type": { "const": "us.share_valuation.request" }, "params": { "$ref": "#/components/schemas/Params_us_share_valuation_request" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Request a 409A valuation", "x-entiva": { "jurisdiction": "us", "stage": "ownership_and_capital", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Latest financial statements and projections", "source": "uploaded", "required": true }, { "key": "stock_ledger_extract", "title": "Cap table and preferred terms", "source": "generated", "required": true }, { "key": "engagement_letter", "title": "Appraiser engagement letter", "source": "generated", "required": true }, { "key": "valuation_report", "title": "Independent valuation report with fair market value per share", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board consent adopting the fair market value", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "engagement_letter", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "None. No registry filing", "form": "Independent appraisal, or an illiquid-startup valuation, supporting the exercise price", "channel": "none", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "valuation_inputs_incomplete", "type": null, "when": "Financial statements or the cap table are missing." }, { "code": "material_event_since_valuation", "type": null, "when": "A reported event means an earlier valuation can no longer be relied on." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity type cannot take this action." } ] } }, "Params_us_charter_amend": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of formation.", "examples": [ "DE" ] }, "form": { "type": "string", "enum": [ "amendment", "restated_certificate" ], "description": "amendment changes listed provisions; restated_certificate consolidates the whole instrument, with or without further amendments.", "examples": [ "amendment" ] }, "changes": { "type": "array", "items": {}, "description": "List of {article, current_text, amended_text}.", "examples": [ "[{\"article\":\"Article IV\",\"current_text\":\"10,000,000 shares of Common Stock\",\"amended_text\":\"15,000,000 shares of Common Stock\"}]" ] }, "restated_only": { "type": "boolean", "description": "For restated_certificate: true if the restatement does not further amend the certificate.", "examples": [ "false" ] }, "share_class": { "type": "string", "pattern": "^shc_", "description": "Share class whose authorised number, par value or rights change, if any.", "examples": [ "shc_4Gh7Qa" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date or time, if later than filing and allowed by the state.", "examples": [ "2026-11-02" ] }, "meeting_or_consent": { "type": "string", "enum": [ "written_consent", "meeting" ], "description": "How owners approve.", "examples": [ "written_consent" ] }, "expedite": { "type": "string", "enum": [ "none", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Registry expedite service where offered.", "examples": [ "none" ] } }, "required": [ "state", "form", "changes" ], "description": "Amends a corporation's certificate of incorporation or an LLC, LP or statutory trust's formation certificate, or files a restated certificate that consolidates the whole instrument, after board and owner approvals including any class vote." }, "Create_us_charter_amend": { "type": "object", "properties": { "type": { "const": "us.charter.amend" }, "params": { "$ref": "#/components/schemas/Params_us_charter_amend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Amend or restate the certificate of incorporation or formation", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution adopting and declaring the amendment advisable", "source": "generated", "required": true }, { "key": "stockholders_resolution", "title": "Stockholder, member or partner approval", "source": "generated", "required": true }, { "key": "class_consent", "title": "Class or series vote", "source": "generated", "required": false }, { "key": "non_consenting_holder_notice", "title": "Notice to non-consenting holders", "source": "generated", "required": false }, { "key": "certificate_of_amendment", "title": "Certificate of amendment or restated certificate", "source": "generated", "required": true }, { "key": "constitution", "title": "Current certificate and amendments", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Stamped filing", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "majority", "percent": 50, "method": "meeting_or_written" }, { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholders_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "class_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_amendment", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_amendment", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Amendment or Restated Certificate", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "class_consent_missing", "type": null, "when": "The amendment affects a share class but its separate vote has not been captured." }, { "code": "stockholder_approval_insufficient", "type": null, "when": "Consents received do not reach the majority of outstanding stock required." }, { "code": "board_approval_missing", "type": null, "when": "Directors' consent is incomplete." }, { "code": "supermajority_required", "type": null, "when": "The charter requires a greater vote, which a lower vote cannot change (s.242)." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The entity is void, forfeited or suspended." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the instrument." } ] } }, "Params_us_filing_rectify": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC where the instrument was filed.", "examples": [ "DE" ] }, "instrument": { "type": "string", "pattern": "^doc_", "description": "The filed instrument being corrected.", "examples": [ "doc_3VnQe8Lz" ] }, "filed_date": { "type": "string", "format": "date", "description": "Date the instrument was filed.", "examples": [ "2026-03-12" ] }, "correction_type": { "type": "string", "enum": [ "certificate_of_correction", "corrected_instrument", "nullification" ], "description": "certificate_of_correction sets out the defect and corrected portion; corrected_instrument re-files the whole instrument headed as corrected; nullification.", "examples": [ "certificate_of_correction" ] }, "defect": { "type": "string", "enum": [ "inaccurate_record", "defective_execution", "defective_acknowledgement", "other" ], "description": "Why the correction is needed.", "examples": [ "inaccurate_record" ] }, "description": { "type": "string", "description": "Plain statement of the inaccuracy or defect.", "examples": [ "The certificate of amendment stated 12,000,000 authorised shares; the stockholders approved 15,000,000." ] }, "corrected_text": { "type": "string", "description": "The corrected portion, or the full corrected instrument.", "examples": [ "Article IV: The total number of authorized shares is 15,000,000 shares of Common Stock." ] }, "expedite": { "type": "string", "enum": [ "none", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Registry expedite service where offered.", "examples": [ "same_day" ] } }, "required": [ "state", "instrument", "filed_date", "correction_type", "defect", "description" ], "description": "Corrects an already filed instrument that is an inaccurate record of the corporate action or was defectively executed, by filing a certificate of correction, a corrected instrument or a nullification." }, "Create_us_filing_rectify": { "type": "object", "properties": { "type": { "const": "us.filing.rectify" }, "params": { "$ref": "#/components/schemas/Params_us_filing_rectify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Certificate of correction", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "wy_dao_llc", "wy_statutory_foundation" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "original_filing", "title": "Stamped copy of the instrument being corrected", "source": "uploaded", "required": true }, { "key": "supporting_authority", "title": "Resolution or consent showing what was actually approved", "source": "uploaded", "required": true }, { "key": "certificate_of_correction", "title": "Certificate of correction or corrected instrument", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filing", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" } ], "signatures": [ { "document_key": "certificate_of_correction", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_correction", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Delaware Certificate of Correction or corrected instrument", "channel": "online", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "correction_not_available", "type": null, "when": "The error is substantive, such as a corporate act that was never validly approved; a certificate of correction cannot cure it." }, { "code": "instrument_not_found", "type": null, "when": "The referenced filing does not match the registry record." }, { "code": "corrected_text_missing", "type": null, "when": "No corrected text was provided for a non-nullification correction." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The entity is void, forfeited or suspended." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the correction." } ] } }, "Params_us_llc_convert_to_dao": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Always WY.", "examples": [ "WY" ] }, "management": { "type": "string", "enum": [ "member_managed", "algorithmically_managed" ], "description": "How the DAO is managed under its articles: by members or algorithmically.", "examples": [ "algorithmically_managed" ] }, "smart_contract_identifier": { "type": "string", "description": "Publicly available identifier of the smart contract.", "examples": [ "0x5B38Da6a701c568545dCfcB03FcB875f56beddC4" ] }, "network": { "type": "string", "description": "Blockchain or network of the contract.", "examples": [ "Ethereum mainnet" ] }, "transfer_restrictions": { "type": "string", "description": "Text of the statutory notice of restrictions on duties and on transfer of membership interests to be placed in the articles.", "examples": [ "Transfer of membership interests is governed by the smart contract and the operating agreement." ] }, "contract_admin": { "type": "string", "pattern": "^per_", "description": "Person holding admin or upgrade keys; verified and wallet-screened.", "examples": [ "per_6JqHd0Tn" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date; defaults to filing.", "examples": [ "2026-11-02" ] } }, "required": [ "state", "management" ], "description": "Amends the articles of an existing Wyoming LLC to include the statements W.S. 17-31-104 requires, turning it into a DAO LLC. The smart-contract identifier is added at the same time or within 30 days." }, "Create_us_llc_convert_to_dao": { "type": "object", "properties": { "type": { "const": "us.llc.convert_to_dao" }, "params": { "$ref": "#/components/schemas/Params_us_llc_convert_to_dao" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Convert a Wyoming LLC into a DAO LLC", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "llc_single_member", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' approval of the conversion", "source": "generated", "required": true }, { "key": "articles_of_amendment", "title": "Articles of amendment with the DAO statements", "source": "generated", "required": true }, { "key": "constitution", "title": "Operating agreement and any amendment for DAO governance", "source": "uploaded", "required": true }, { "key": "contract_key_attestation", "title": "Attestation of smart-contract key control", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Stamped articles of amendment", "source": "registry_issued", "required": true } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" }, { "role": "member", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_amendment", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "contract_key_attestation", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Articles of Amendment with the DAO statements required", "channel": "online", "government_fee": { "amount": 60, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "entity_not_wyoming_llc", "type": null, "when": "The entity is not a Wyoming LLC in good standing." }, { "code": "member_approval_insufficient", "type": null, "when": "Member approvals do not meet the operating agreement's threshold." }, { "code": "wallet_screening_hit", "type": null, "when": "A controlling wallet or person matches an OFAC SDN entry or digital currency address." }, { "code": "identifier_not_public", "type": null, "when": "The identifier does not resolve on a public network." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the amendment." } ] } }, "Params_us_name_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of formation.", "examples": [ "DE" ] }, "name": { "type": "string", "description": "The new legal name including the required entity designator.", "examples": [ "Northwind Robotics, Inc." ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date; defaults to filing.", "examples": [ "2026-11-02" ] }, "name_reservation": { "type": "string", "pattern": "^doc_", "description": "Existing name reservation to use, if the new name was already reserved.", "examples": [ "doc_9PzXn1Ke" ] }, "stockholder_vote_required": { "type": "boolean", "description": "Set true if the charter or constitution requires members or stockholders to approve a name change.", "examples": [ "false" ] }, "expedite": { "type": "string", "enum": [ "none", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Registry expedite service where offered.", "examples": [ "24_hour" ] }, "keep_former_name_as_trade_name": { "type": "boolean", "description": "Ask Entiva to register the former name as an assumed name where the state allows.", "examples": [ "false" ] } }, "required": [ "state", "name" ], "description": "Changes the legal name of a US entity by filing a certificate of amendment in its state of formation after the required approvals, then updates registers and flags dependent filings." }, "Create_us_name_change": { "type": "object", "properties": { "type": { "const": "us.name.change" }, "params": { "$ref": "#/components/schemas/Params_us_name_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of entity name", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution adopting the name change", "source": "generated", "required": true }, { "key": "stockholders_resolution", "title": "Stockholder or member consent", "source": "generated", "required": false }, { "key": "certificate_of_amendment", "title": "Certificate of amendment", "source": "generated", "required": true }, { "key": "name_availability_report", "title": "Name availability check", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped certificate of amendment", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholders_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_amendment", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_amendment", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Certificate of Amendment", "channel": "online", "government_fee": { "amount": 214, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "name_unavailable", "type": null, "when": "The name is not distinguishable on the state's records or is reserved by another party." }, { "code": "name_designator_missing", "type": null, "when": "The name lacks the entity designator the state requires." }, { "code": "name_restricted", "type": null, "when": "The name needs regulator approval or contains a restricted word." }, { "code": "board_approval_missing", "type": null, "when": "Directors' consent is incomplete." }, { "code": "entity_not_in_good_standing", "type": null, "when": "Entity is void, forfeited or suspended." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the amendment." } ] } }, "Params_us_registered_agent_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC in which the entity is registered.", "examples": [ "DE" ] }, "registered_agent": { "type": "object", "description": "The new registered agent: {name, commercial, agent_id}.", "examples": [ "{\"agent_id\":\"ra_de_entiva\",\"name\":\"Entiva Registered Agent (Delaware) LLC\",\"commercial\":true}" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office address in the state.", "examples": [ "{\"line1\":\"8 The Green, Suite A\",\"city\":\"Dover\",\"state\":\"DE\",\"postal_code\":\"19901\",\"country\":\"US\"}" ] }, "communications_contact": { "type": "string", "pattern": "^per_", "description": "The natural person the agent can contact for the entity.", "examples": [ "per_1N8xK2pQ" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date.", "examples": [ "2026-11-02" ] }, "expedite": { "type": "string", "enum": [ "none", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Registry expedite service where offered.", "examples": [ "24_hour" ] }, "previous_agent_notice": { "type": "boolean", "description": "If true, Entiva sends the outgoing agent a notice that it has been replaced and asks it to release the entity's records.", "examples": [ "true" ] } }, "required": [ "state", "registered_agent", "communications_contact" ], "description": "Replaces an entity's registered agent in its state of formation, and optionally the registered office at the same time. Entiva's commercial registered-agent partner accepts the appointment, the entity approves, and Entiva files the." }, "Create_us_registered_agent_change": { "type": "object", "properties": { "type": { "const": "us.registered_agent.change" }, "params": { "$ref": "#/components/schemas/Params_us_registered_agent_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of registered agent", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving the new registered agent or office", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Manager or member consent", "source": "generated", "required": false }, { "key": "registered_agent_consent", "title": "New registered agent's consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "certificate_of_change", "title": "State change form", "source": "generated", "required": true }, { "key": "evidence_of_authority", "title": "Incumbency or secretary's certificate", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Filing receipt and stamped certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_change", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_change", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Change of Registered Agent/Office", "channel": "online", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_in_good_standing", "type": null, "when": "The registry shows the entity void, forfeited, revoked or suspended; revive it first." }, { "code": "registered_agent_not_accepted", "type": null, "when": "The agent partner has not accepted after KYC and OFAC screening, or an outside agent's in-state office cannot be confirmed." }, { "code": "communications_contact_missing", "type": null, "when": "No verified natural-person communications contact is on file." }, { "code": "board_approval_missing", "type": null, "when": "A corporation's board resolution is not signed by every director." }, { "code": "registered_office_invalid", "type": null, "when": "The office is a PO box or outside the state." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the form, for example because the agent's consent is missing or the file number is wrong." }, { "code": "human_presence_required", "type": null, "when": "An agent tries to give a director's consent or complete a verification step itself." } ] } }, "Params_us_registered_office_change": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC of registration.", "examples": [ "WY" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "New registered office: a physical street address in the state, which must be the registered agent's business office.", "examples": [ "{\"line1\":\"30 N Gould St\",\"city\":\"Sheridan\",\"state\":\"WY\",\"postal_code\":\"82801\",\"country\":\"US\"}" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date; defaults to the filing date.", "examples": [ "2026-11-02" ] }, "expedite": { "type": "string", "enum": [ "none", "24_hour", "same_day", "2_hour", "1_hour" ], "description": "Registry expedite service where offered.", "examples": [ "none" ] } }, "required": [ "state", "registered_office" ], "description": "Moves the registered office address within the state while the registered agent stays the same, for example when the agent relocates its in-state office." }, "Create_us_registered_office_change": { "type": "object", "properties": { "type": { "const": "us.registered_office.change" }, "params": { "$ref": "#/components/schemas/Params_us_registered_office_change" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Change of registered office", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "lllp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Manager or member consent", "source": "generated", "required": false }, { "key": "certificate_of_change", "title": "State change form", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filing receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "governing_body", "threshold": "as_constitution", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_change", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_change", "signer_role": "authorised_representative", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Change of Registered Agent/Office", "channel": "both", "government_fee": { "amount": 50, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "registered_office_invalid", "type": null, "when": "Address is a PO box, outside the state, or not the agent's office." }, { "code": "entity_not_in_good_standing", "type": null, "when": "Entity is void, forfeited or suspended." }, { "code": "board_approval_missing", "type": null, "when": "Not every director has signed the written consent." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the form." } ] } }, "Params_us_smart_contract_identifier_admit": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WY" ], "description": "Always WY.", "examples": [ "WY" ] }, "smart_contract_identifier": { "type": "string", "description": "The publicly available identifier of the smart contract used to manage, facilitate or operate the DAO (W.S. 17-31-106), such as the contract address.", "examples": [ "0x5B38Da6a701c568545dCfcB03FcB875f56beddC4" ] }, "network": { "type": "string", "description": "The blockchain or network on which the contract is deployed.", "examples": [ "Ethereum mainnet" ] }, "contract_admin": { "type": "string", "pattern": "^per_", "description": "Person or entity holding admin or upgrade keys for the contract; Entiva verifies and screens wallets.", "examples": [ "per_6JqHd0Tn" ] }, "articles_filed_date": { "type": "string", "format": "date", "description": "Date the DAO's articles were filed; used to compute the 30-day cure deadline.", "examples": [ "2026-10-05" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date; defaults to filing.", "examples": [ "2026-10-20" ] } }, "required": [ "state", "smart_contract_identifier", "network", "articles_filed_date" ], "description": "Files articles of amendment giving the publicly available smart-contract identifier of a Wyoming DAO LLC, which must be done within 30 days of filing the articles if the identifier was left out, or the DAO is dissolved." }, "Create_us_smart_contract_identifier_admit": { "type": "object", "properties": { "type": { "const": "us.smart_contract_identifier.admit" }, "params": { "$ref": "#/components/schemas/Params_us_smart_contract_identifier_admit" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Wyoming DAO LLC: add smart-contract identifier", "x-entiva": { "jurisdiction": "us", "stage": "changes", "applies_to": [ "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Member or manager approval of the amendment", "source": "generated", "required": true }, { "key": "articles_of_amendment", "title": "Articles of amendment giving the smart-contract identifier", "source": "generated", "required": true }, { "key": "contract_key_attestation", "title": "Attestation of smart-contract key control", "source": "uploaded", "required": true }, { "key": "registry_receipt", "title": "Stamped articles of amendment", "source": "registry_issued", "required": true } ], "people": [ { "role": "manager", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "other", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "governing_body", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "articles_of_amendment", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "contract_key_attestation", "signer_role": "other", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Wyoming Secretary of State, Business Division", "form": "Articles of Amendment giving the smart-contract identifier", "channel": "online", "government_fee": { "amount": 60, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "cure_period_expired", "type": null, "when": "More than 30 days have passed since the articles were filed and the DAO may already be dissolved; use reinstatement." }, { "code": "identifier_not_public", "type": null, "when": "The identifier does not resolve on a public network." }, { "code": "wallet_screening_hit", "type": null, "when": "A controlling wallet or person matches an OFAC SDN entry or digital currency address." }, { "code": "registered_agent_missing", "type": null, "when": "The DAO has no Wyoming registered agent." }, { "code": "registry_rejected", "type": null, "when": "The state rejects the amendment." } ] } }, "Params_us_branch_register": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State or DC where the company registers.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "llc_multi_member", "lp" ], "description": "The US entity type the state treats the foreign company as: corporation, LLC-type or limited partnership.", "examples": [ "c_corp" ] }, "name": { "type": "string", "description": "Home-country legal name, or the name to be used in the state if the home name is unavailable.", "examples": [ "Meridian Analytics Ltd" ] }, "home_jurisdiction": { "type": "string", "description": "ISO 3166 country code of formation.", "examples": [ "GB" ] }, "home_registry_number": { "type": "string", "description": "Registration number at the home registry.", "examples": [ "12345678" ] }, "home_entity_type": { "type": "string", "description": "Legal form under home law.", "examples": [ "private company limited by shares" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office; defaults to Entiva's Entiva.", "examples": [ "{\"line1\":\"1209 Orange St\",\"city\":\"Wilmington\",\"region\":\"DE\",\"postal_code\":\"19801\",\"country\":\"US\"}" ] }, "registered_agent": { "type": "string", "pattern": "^per_", "description": "In-state registered agent; defaults to Entiva.", "examples": [ "per_01JB9A01" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal office.", "examples": [ "{\"line1\":\"1 Canada Square\",\"city\":\"London\",\"postal_code\":\"E14 5AB\",\"country\":\"GB\"}" ] }, "directors": { "type": "array", "items": {}, "description": "Directors, managers or general partners to list, from the home register.", "examples": [ "[\"per_01JB9A11\",\"per_01JB9A12\"]" ] }, "beneficial_owners": { "type": "array", "items": {}, "description": "Individuals owning or controlling 25% or more or with substantial control, directly or indirectly, with ownership chain.", "examples": [ "[\"per_01JB9A21\"]" ] }, "company_applicants": { "type": "array", "items": {}, "description": "Up to two individuals: who directly files the registration and who directs the filing.", "examples": [ "[\"per_01JB9A31\"]" ] }, "us_trade_or_business": { "type": "boolean", "description": "True if the company will have a US trade or business.", "examples": [ "true" ] }, "nature_of_business": { "type": "string", "description": "Business activity in the state.", "examples": [ "Data analytics services" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date; must be before business starts in the state.", "examples": [ "2026-11-15" ] }, "home_good_standing": { "type": "string", "pattern": "^doc_", "description": "Home-registry good standing or existence certificate, apostilled where the state asks, with a certified English translation if not in English.", "examples": [ "doc_01JB9B40" ] } }, "required": [ "state", "entity_type", "name", "home_jurisdiction", "home_registry_number", "home_entity_type", "principal_office", "directors", "beneficial_owners", "home_good_standing" ], "description": "Registers a company formed outside the US in a US state as a foreign entity, with an apostilled home-country good standing certificate, then sets up the federal follow-ons: FinCEN beneficial ownership report within 30 days, the New York." }, "Create_us_branch_register": { "type": "object", "properties": { "type": { "const": "us.branch.register" }, "params": { "$ref": "#/components/schemas/Params_us_branch_register" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Register a non-US company to do business in a US state", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "c_corp", "llc_multi_member", "lp" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_good_standing", "title": "Home-country good standing / existence certificate", "source": "uploaded", "required": true }, { "key": "certificate_of_incorporation", "title": "Home certificate of incorporation or formation", "source": "uploaded", "required": true }, { "key": "constitution", "title": "Home constitutional documents", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified English translation", "source": "uploaded", "required": false }, { "key": "ownership_chart", "title": "Ownership chart signed by an officer", "source": "uploaded", "required": true }, { "key": "board_resolution", "title": "Resolution authorising US registration", "source": "generated", "required": true }, { "key": "application_for_authority", "title": "Application for Certificate of Authority / Registration", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Filed certificate of authority and registry receipt", "source": "registry_issued", "required": true }, { "key": "boi_report_receipt", "title": "FinCEN BOI filing confirmation", "source": "registry_issued", "required": false } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "applicant", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_for_authority", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" }, { "document_key": "certificate_of_good_standing", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Secretary of State", "form": "State foreign qualification", "channel": "both", "government_fee": { "amount": 245, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "home_good_standing_not_apostilled", "type": null, "when": "The state requires an apostille and the certificate lacks it." }, { "code": "home_entity_not_in_good_standing", "type": null, "when": "The home registry shows the company struck off, dissolved or delinquent." }, { "code": "company_applicant_required", "type": null, "when": "A foreign reporting company has no identified applicant, so the BOI report cannot be prepared." }, { "code": "beneficial_owner_incomplete", "type": null, "when": "A non-US owner lacks an ID image or FinCEN ID." }, { "code": "name_unavailable_in_state", "type": null, "when": "The name is not available in the state." }, { "code": "sanctions_hold", "type": null, "when": "A party matches OFAC or other lists." } ] } }, "Params_us_entity_continue_in": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE", "WY", "NV" ], "description": "Destination state.", "examples": [ "WY" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "s_corp_election", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "statutory_trust", "wy_statutory_foundation", "cooperative" ], "description": "Entity type in the destination state.", "examples": [ "llc_multi_member" ] }, "mode": { "type": "string", "enum": [ "domestication", "continuance" ], "description": "WY: domestication is for US-state entities only; continuance is for entities from another state or a foreign country and includes amendments at no extra fee.", "examples": [ "continuance" ] }, "home_jurisdiction": { "type": "string", "description": "Current home: a US state code, or an ISO country code.", "examples": [ "CA" ] }, "home_registry_number": { "type": "string", "description": "File number at the home registry.", "examples": [ "202312345678" ] }, "name": { "type": "string", "description": "Name in the destination state.", "examples": [ "Acme Holdings LLC" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date.", "examples": [ "2026-12-15" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Destination registered office; defaults to Entiva's agent partner.", "examples": [ "{\"line1\":\"30 N Gould St\",\"city\":\"Sheridan\",\"region\":\"WY\",\"postal_code\":\"82801\",\"country\":\"US\"}" ] }, "registered_agent": { "type": "string", "pattern": "^per_", "description": "Destination registered agent; defaults to Entiva.", "examples": [ "per_01JC7A02" ] }, "directors": { "type": "array", "items": {}, "description": "Directors, managers or general partners.", "examples": [ "[\"per_01JC7A11\"]" ] }, "authorised_shares": { "type": "integer", "description": "Authorised shares for corporations.", "examples": [ "10000000" ] }, "home_exit_plan": { "type": "string", "enum": [ "dissolve", "withdraw", "not_required" ], "description": "What happens in the home jurisdiction after the move.", "examples": [ "dissolve" ] }, "home_law_permits": { "type": "boolean", "description": "Confirmation that the home state or country permits the move.", "examples": [ "true" ] }, "nature_of_business": { "type": "string", "description": "Purpose or business.", "examples": [ "Holding company" ] }, "plan_of_domestication": { "type": "string", "pattern": "^doc_", "description": "Optional plan; Entiva generates one if omitted.", "examples": [ "doc_01JC7A30" ] } }, "required": [ "state", "entity_type", "mode", "home_jurisdiction", "home_registry_number", "name", "home_exit_plan", "home_law_permits" ], "description": "Moves an existing entity's legal home into Delaware, Wyoming or Nevada. The entity continues as the same legal person." }, "Create_us_entity_continue_in": { "type": "object", "properties": { "type": { "const": "us.entity.continue_in" }, "params": { "$ref": "#/components/schemas/Params_us_entity_continue_in" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Domesticate or continue an out-of-state or foreign entity into Delaware, Wyoming or Nevada", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "c_corp", "s_corp_election", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "statutory_trust", "wy_statutory_foundation", "cooperative" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_domestication", "title": "Certificate of domestication / articles of continuance / articles of domestication", "source": "generated", "required": true }, { "key": "constitution", "title": "Formation document in the destination state", "source": "generated", "required": true }, { "key": "certified_charter", "title": "Certified copy of the home charter and amendments", "source": "uploaded", "required": true }, { "key": "certificate_of_good_standing", "title": "Home good standing / existence certificate", "source": "registry_issued", "required": false }, { "key": "board_resolution", "title": "Resolution approving the move", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Owner approval", "source": "generated", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent", "source": "generated", "required": true }, { "key": "home_dissolution_articles", "title": "Unfiled home-jurisdiction articles of dissolution", "source": "uploaded", "required": false }, { "key": "certified_translation", "title": "Certified translation", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Filed certificate and registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_domestication", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_domestication", "signer_role": "authorised_signatory", "method": "wet_ink_notarised", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Secretary of State of the destination state: DE Division of Corporations", "form": "DE Certificate of Corporate Domestication with Certificate of Incorporation", "channel": "both", "government_fee": { "amount": 234, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "home_law_prohibits_move", "type": null, "when": "The home jurisdiction does not allow outward continuance or domestication." }, { "code": "certified_charter_expired", "type": null, "when": "The certified charter is older than the destination's age limit." }, { "code": "name_unavailable", "type": null, "when": "The name is not available in the destination." }, { "code": "notarisation_required", "type": null, "when": "WY filing is missing the notarised signature." }, { "code": "home_exit_unconfirmed", "type": null, "when": "The home dissolution or withdrawal stamped copy has not been delivered to Wyoming." }, { "code": "entity_type_not_supported_in_state", "type": null, "when": "The chosen form is not recognised in the destination." }, { "code": "sanctions_hold", "type": null, "when": "A party or owner matches a sanctions list." } ] } }, "Params_us_entity_continue_out": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "State the entity is leaving.", "examples": [ "DE" ] }, "destination": { "type": "string", "description": "Destination: a US state code or ISO country code.", "examples": [ "NV" ] }, "resulting_entity_type": { "type": "string", "description": "The form the entity takes under the destination's law.", "examples": [ "corporation" ] }, "mode": { "type": "string", "enum": [ "transfer", "transfer_and_domestic_continuance" ], "description": "transfer ends Delaware existence; transfer_and_domestic_continuance keeps the entity a Delaware entity as well as one under the foreign law.", "examples": [ "transfer" ] }, "name": { "type": "string", "description": "Name of the resulting entity.", "examples": [ "Acme Robotics, Inc." ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date or time of the certificate.", "examples": [ "2026-12-31" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the board or members adopted the resolution.", "examples": [ "2026-11-20" ] }, "service_address": { "$ref": "#/components/schemas/Address", "description": "Address for the consent to service of process.", "examples": [ "{\"line1\":\"1 Market St\",\"city\":\"Reno\",\"region\":\"NV\",\"postal_code\":\"89501\",\"country\":\"US\"}" ] }, "plan_of_transfer": { "type": "string", "pattern": "^doc_", "description": "Optional plan of transfer.", "examples": [ "doc_01JC8A20" ] }, "meeting_date": { "type": "string", "format": "date", "description": "For corporations: the stockholder meeting date, with notice sent at least 20 days before.", "examples": [ "2026-11-20" ] }, "charitable": { "type": "boolean", "description": "True for a charitable nonstock corporation; the Attorney General must be notified 10 days in advance.", "examples": [ "false" ] } }, "required": [ "state", "destination", "resulting_entity_type", "mode", "service_address" ], "description": "Transfers a Delaware corporation, LLC, LP or statutory trust to another state or country, or records a transfer under which it continues as a Delaware entity too. Delaware franchise or annual taxes must be paid first." }, "Create_us_entity_continue_out": { "type": "object", "properties": { "type": { "const": "us.entity.continue_out" }, "params": { "$ref": "#/components/schemas/Params_us_entity_continue_out" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Transfer a Delaware entity out of Delaware", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certificate_of_transfer", "title": "Certificate of transfer / certificate of transfer and domestic continuance", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board or manager resolution specifying the destination", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Stockholder or member approval", "source": "generated", "required": true }, { "key": "plan_of_transfer", "title": "Plan of transfer", "source": "generated", "required": false }, { "key": "franchise_tax_clearance", "title": "Evidence that Delaware taxes and reports are filed and paid", "source": "generated", "required": true }, { "key": "destination_filing", "title": "Destination-jurisdiction filing", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Filed certificate and registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_transfer", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "DE Certificate of Transfer or Transfer and Domestic Continuance", "channel": "online", "government_fee": { "amount": 1069, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "franchise_tax_unpaid", "type": null, "when": "Delaware taxes or reports outstanding." }, { "code": "destination_does_not_permit_inward_move", "type": null, "when": "The destination jurisdiction does not allow domestication or continuance in." }, { "code": "approval_threshold_not_met", "type": null, "when": "Stockholder or member approval is not recorded, or the 20-day notice has not run." }, { "code": "agreement_prohibits_transfer", "type": null, "when": "The LLC agreement prohibits transfer (s.18-213)." }, { "code": "attorney_general_notice_missing", "type": null, "when": "A charitable nonstock corporation has not given the 10-day notice." } ] } }, "Params_us_entity_convert": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the converting entity.", "examples": [ "DE" ] }, "resulting_entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "description": "Entity type after conversion.", "examples": [ "c_corp" ] }, "resulting_state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the resulting entity if different from state.", "examples": [ "DE" ] }, "name": { "type": "string", "description": "Name of the resulting entity, with the suffix the new form needs.", "examples": [ "Acme Robotics, Inc." ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the conversion; may be future-dated if the state allows.", "examples": [ "2026-12-01" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the conversion was approved.", "examples": [ "2026-11-10" ] }, "plan_of_conversion": { "type": "string", "pattern": "^doc_", "description": "Plan of conversion describing how interests convert.", "examples": [ "doc_01JC6A20" ] }, "interest_conversion": { "type": "object", "description": "How each membership interest, partnership interest, trust interest or share converts: ratio, resulting share class and number of shares.", "examples": [ "{\"basis\":\"pro_rata\",\"resulting_authorized_shares\":10000000,\"par_value\":\"0.0001\"}" ] }, "directors": { "type": "array", "items": {}, "description": "Initial directors, managers or general partners of the resulting entity.", "examples": [ "[\"per_01JC6A11\"]" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Registered office of the resulting entity.", "examples": [ "{\"line1\":\"1209 Orange St\",\"city\":\"Wilmington\",\"region\":\"DE\",\"postal_code\":\"19801\",\"country\":\"US\"}" ] }, "tax_acknowledged": { "type": "boolean", "description": "The customer confirms they understand conversion can change tax classification and that tax advice is not provided by Entiva.", "examples": [ "true" ] }, "reason": { "type": "string", "description": "Purpose of the conversion.", "examples": [ "Convert to a Delaware C corporation before a Series A" ] } }, "required": [ "state", "resulting_entity_type", "interest_conversion", "tax_acknowledged" ], "description": "Converts an entity from one legal form to another under state statute by filing a certificate of conversion with the resulting entity's formation document. The entity continues as the same legal person." }, "Create_us_entity_convert": { "type": "object", "properties": { "type": { "const": "us.entity.convert" }, "params": { "$ref": "#/components/schemas/Params_us_entity_convert" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Statutory conversion of an entity into another entity type", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "c_corp", "public_benefit_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_conversion", "title": "Plan of conversion", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board or manager resolution approving the conversion", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Stockholder, member or partner consent", "source": "generated", "required": true }, { "key": "certificate_of_conversion", "title": "Certificate of conversion", "source": "generated", "required": true }, { "key": "constitution", "title": "Formation document of the resulting entity", "source": "generated", "required": true }, { "key": "franchise_tax_clearance", "title": "Evidence that DE franchise taxes are paid", "source": "generated", "required": true }, { "key": "bylaws", "title": "Bylaws or operating agreement of the resulting entity", "source": "generated", "required": false }, { "key": "certificate_of_good_standing", "title": "Good standing certificate of the converting entity", "source": "registry_issued", "required": false }, { "key": "registered_agent_consent", "title": "Registered agent consent", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Filed certificate of conversion and registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_conversion", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Secretary of State of the relevant state. DE: Division of Corporations", "form": "DE Certificate of Conversion", "channel": "online", "government_fee": { "amount": 184, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "franchise_tax_unpaid", "type": null, "when": "Delaware taxes or annual reports are outstanding and 8 Del." }, { "code": "conversion_not_permitted", "type": null, "when": "The governing documents prohibit conversion or the statute does not allow this pairing of forms." }, { "code": "approval_threshold_not_met", "type": null, "when": "Recorded consents do not reach the required vote." }, { "code": "s_corp_ineligible_holder", "type": null, "when": "An S election is kept and a holder is ineligible." }, { "code": "name_unavailable", "type": null, "when": "The resulting name is not available or lacks the required suffix." }, { "code": "professional_licence_unverified", "type": null, "when": "The resulting form is a professional corporation or PLLC and an owner lacks a verified licence." } ] } }, "Params_us_entity_merge": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "State of the surviving entity, where the certificate is filed.", "examples": [ "DE" ] }, "merger_type": { "type": "string", "enum": [ "merger", "consolidation", "short_form_parent_subsidiary" ], "description": "short_form_parent_subsidiary uses the certificate of ownership and merger (a parent owning at least 90% of each class of a subsidiary, LLC Act s.18-209; the.", "examples": [ "merger" ] }, "merging_entities": { "type": "array", "items": {}, "description": "Each constituent entity other than the entity in the path: name, state or country, entity type, file number and role.", "examples": [ "[{\"name\":\"Beta Labs, Inc.\",\"state\":\"DE\",\"entity_type\":\"c_corp\",\"file_number\":\"7654321\",\"role\":\"disappearing\"}]" ] }, "surviving_entity": { "type": "string", "pattern": "^ent_", "description": "The surviving entity if it is an entity Entiva manages.", "examples": [ "ent_01JB7M3X9D" ] }, "name": { "type": "string", "description": "Name of the surviving or resulting entity if it changes.", "examples": [ "Acme Robotics, Inc." ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date or time of the merger.", "examples": [ "2026-12-31" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the boards approved the agreement.", "examples": [ "2026-11-25" ] }, "agreement_of_merger": { "type": "string", "pattern": "^doc_", "description": "Agreement and plan of merger setting out the terms and consideration.", "examples": [ "doc_01JD3A20" ] }, "merger_consideration": { "type": "object", "description": "Conversion of interests in each constituent: exchange ratio, cash, new shares.", "examples": [ "{\"type\":\"stock\",\"exchange_ratio\":\"1.25\"}" ] }, "charter_amendments": { "type": "object", "description": "Amendments to the surviving entity's charter or certificate of formation effected by the merger.", "examples": [ "{\"authorized_shares\":15000000}" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "Surviving entity's registered office.", "examples": [ "{\"line1\":\"1209 Orange St\",\"city\":\"Wilmington\",\"region\":\"DE\",\"postal_code\":\"19801\",\"country\":\"US\"}" ] }, "directors": { "type": "array", "items": {}, "description": "Directors or managers of the surviving entity after the merger.", "examples": [ "[\"per_01JD3A11\"]" ] }, "tax_acknowledged": { "type": "boolean", "description": "The customer confirms awareness of tax consequences and that Entiva gives no tax advice.", "examples": [ "true" ] } }, "required": [ "state", "merger_type", "merging_entities", "agreement_of_merger", "merger_consideration", "tax_acknowledged" ], "description": "Merges or consolidates two or more entities into a surviving or new entity by filing a certificate of merger with the registry, after board and owner approvals. Covers corporations, LLCs, LPs and statutory trusts, domestic and cross-state." }, "Create_us_entity_merge": { "type": "object", "properties": { "type": { "const": "us.entity.merge" }, "params": { "$ref": "#/components/schemas/Params_us_entity_merge" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Merger or consolidation of US entities", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "agreement_of_merger", "title": "Agreement and plan of merger", "source": "uploaded", "required": true }, { "key": "certificate_of_merger", "title": "Certificate of merger / certificate of ownership and merger / articles of merger", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Board resolution of each constituent", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Owner approval of each constituent", "source": "generated", "required": true }, { "key": "franchise_tax_clearance", "title": "Evidence that Delaware taxes are paid", "source": "generated", "required": true }, { "key": "certificate_of_good_standing", "title": "Good standing certificate of each constituent", "source": "registry_issued", "required": false }, { "key": "registry_receipt", "title": "Filed certificate of merger and registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "class_members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "members_resolution", "signer_role": "shareholder", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "agreement_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_merger", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Secretary of State of the surviving or resulting entity's state", "form": "DE Certificate of Merger or Ownership and Merger", "channel": "online", "government_fee": { "amount": 259, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "approval_threshold_not_met", "type": null, "when": "Recorded consents do not reach the required vote for a constituent." }, { "code": "franchise_tax_unpaid", "type": null, "when": "A Delaware constituent has outstanding taxes." }, { "code": "merger_prohibited_by_agreement", "type": null, "when": "An LLC agreement bars merger (s.18-209)." }, { "code": "constituent_not_in_good_standing", "type": null, "when": "A constituent is not in good standing." }, { "code": "s_corp_ineligible_holder", "type": null, "when": "An S corporation survivor would have an ineligible shareholder." }, { "code": "sanctions_hold", "type": null, "when": "A party matches a sanctions list." } ] } }, "Params_us_entity_division_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Always DE.", "examples": [ "DE" ] }, "surviving": { "type": "boolean", "description": "True if the dividing entity continues to exist after division; false if it ceases and only the resulting entities remain.", "examples": [ "true" ] }, "resulting_entities": { "type": "array", "items": {}, "description": "Each new entity: name, entity type, the assets and liabilities allocated to it, and members or partners with interests.", "examples": [ "[{\"name\":\"Acme Robotics IP LLC\",\"entity_type\":\"llc_multi_member\",\"allocated_assets\":[\"Patent portfolio\"],\"members\":[{\"person\":\"per_01JD4A11\",\"percent\":60},{\"person\":\"per_01JD4A12\",\"percent\":40}]}]" ] }, "plan_of_division": { "type": "string", "pattern": "^doc_", "description": "Plan of division allocating assets, liabilities and interests.", "examples": [ "doc_01JD4A30" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the division.", "examples": [ "2026-12-31" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the members or partners approved.", "examples": [ "2026-11-30" ] }, "registered_agent": { "type": "string", "pattern": "^per_", "description": "Registered agent for the new entities; defaults to Entiva's Delaware partner.", "examples": [ "per_01JD4A02" ] }, "series_handling": { "type": "object", "description": "For series LLC: how each series is allocated among resulting entities.", "examples": [ "{\"series_1\":\"Acme Robotics IP LLC\"}" ] }, "tax_acknowledged": { "type": "boolean", "description": "Customer acknowledges tax and creditor consequences; no tax or legal advice is given.", "examples": [ "true" ] } }, "required": [ "state", "surviving", "resulting_entities", "plan_of_division", "tax_acknowledged" ], "description": "Divides a Delaware LLC or LP into two or more entities by filing a certificate of division together with the certificate of formation of the resulting LLC, allocating assets and liabilities by the plan of division. Delaware only." }, "Create_us_entity_division_file": { "type": "object", "properties": { "type": { "const": "us.entity_division.file" }, "params": { "$ref": "#/components/schemas/Params_us_entity_division_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Division of a Delaware LLC or LP", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "plan_of_division", "title": "Plan of division", "source": "uploaded", "required": true }, { "key": "certificate_of_division", "title": "Certificate of division", "source": "generated", "required": true }, { "key": "constitution", "title": "Certificate of formation of the resulting LLC", "source": "generated", "required": true }, { "key": "operating_agreement", "title": "Operating agreement of each resulting entity", "source": "generated", "required": true }, { "key": "members_resolution", "title": "Member or partner approval", "source": "generated", "required": true }, { "key": "franchise_tax_clearance", "title": "Evidence that Delaware annual taxes are paid", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Filed certificate of division and receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_division", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "constitution", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "entity" }, { "document_key": "operating_agreement", "signer_role": "member", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "DE Certificate of Division", "channel": "online", "government_fee": { "amount": 220, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "division_prohibited_by_agreement", "type": null, "when": "The LLC or partnership agreement prohibits division." }, { "code": "annual_tax_unpaid", "type": null, "when": "The Delaware annual tax is outstanding." }, { "code": "allocation_incomplete", "type": null, "when": "The plan of division leaves assets or liabilities unallocated." }, { "code": "name_unavailable", "type": null, "when": "A resulting entity name is not available." }, { "code": "entity_type_not_supported", "type": null, "when": "The entity form cannot divide." } ] } }, "Params_us_foreign_qualification_file": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "The state in which the entity will be qualified.", "examples": [ "NV" ] }, "name": { "type": "string", "description": "Name to use in the new state if the home name is unavailable there or the state requires a fictitious name.", "examples": [ "Acme Robotics, Inc." ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested effective date.", "examples": [ "2026-11-02" ] }, "registered_office": { "$ref": "#/components/schemas/Address", "description": "In-state registered office.", "examples": [ "{\"line1\":\"401 Ryland St, Suite 200-A\",\"city\":\"Reno\",\"region\":\"NV\",\"postal_code\":\"89502\",\"country\":\"US\"}" ] }, "registered_agent": { "type": "string", "pattern": "^per_", "description": "In-state registered agent.", "examples": [ "per_01JB8Y0A" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Principal office address, asked by most states.", "examples": [ "{\"line1\":\"500 Howard St\",\"city\":\"San Francisco\",\"region\":\"CA\",\"postal_code\":\"94105\",\"country\":\"US\"}" ] }, "nature_of_business": { "type": "string", "description": "Purpose or business activity in the new state.", "examples": [ "Software development" ] }, "directors": { "type": "array", "items": {}, "description": "Directors, managers or general partners to list.", "examples": [ "[\"per_01JB8Y11\",\"per_01JB8Y12\"]" ] }, "authorised_shares": { "type": "integer", "description": "Authorised shares of the home entity.", "examples": [ "10000000" ] }, "home_good_standing": { "type": "string", "pattern": "^doc_", "description": "Certificate of good standing or existence from the home state.", "examples": [ "doc_01JB8Z21" ] }, "professional_licence": { "type": "object", "description": "For professional_corp and pllc: licence number, profession, issuing board and state.", "examples": [ "{\"profession\":\"architecture\",\"licence_number\":\"C-12345\",\"board\":\"CA Architects Board\"}" ] }, "reason": { "type": "string", "description": "Why the entity is entering the state.", "examples": [ "Opening a sales office" ] } }, "required": [ "state" ], "description": "Registers an existing US entity to transact business in another state by filing a Certificate of Authority or Certificate of Registration, with a home-state good standing certificate and an in-state registered agent. Required before." }, "Create_us_foreign_qualification_file": { "type": "object", "properties": { "type": { "const": "us.foreign_qualification.file" }, "params": { "$ref": "#/components/schemas/Params_us_foreign_qualification_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Qualify an entity to do business in another state", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "llp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "application_for_authority", "title": "Application for Certificate of Authority / Certificate of Registration", "source": "generated", "required": true }, { "key": "certificate_of_good_standing", "title": "Home-state certificate of good standing / existence", "source": "registry_issued", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent consent / certificate of acceptance", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution authorising qualification", "source": "generated", "required": true }, { "key": "initial_list", "title": "Initial list of officers and directors/managers", "source": "generated", "required": false }, { "key": "licence_certificate", "title": "Professional licensing board certificate", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Filed Certificate of Authority and registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "application_for_authority", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Secretary of State", "form": "Certificate of Authority / Application for Registration", "channel": "both", "government_fee": { "amount": 245, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "home_good_standing_missing", "type": null, "when": "The home registry shows the entity is not in good standing, or no certificate could be ordered." }, { "code": "name_unavailable_in_state", "type": null, "when": "The name is not distinguishable in the destination state; supply name." }, { "code": "registered_agent_required", "type": null, "when": "No in-state registered agent has accepted the appointment." }, { "code": "entity_type_not_supported_in_state", "type": null, "when": "The state does not recognise this entity type." }, { "code": "professional_licence_unverified", "type": null, "when": "" }, { "code": "sanctions_hold", "type": null, "when": "A person or owner has an open sanctions alert; live actions are paused." } ] } }, "Params_us_temporary_transfer_extend": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Always DE.", "examples": [ "DE" ] }, "emergency_condition": { "type": "string", "enum": [ "war_or_armed_conflict", "revolution_or_insurrection", "foreign_invasion_or_occupation", "extended_civil_unrest", "domination_by_foreign_power", "expropriation_or_impairment_of_property", "trading_with_enemy_action", "immediate_threat", "other_permitted_by_home_law" ], "description": "The emergency condition that still continues.", "examples": [ "war_or_armed_conflict" ] }, "emergency_description": { "type": "string", "description": "Statement that the emergency persists, in management's judgment, and why.", "examples": [ "Conflict continues; premises remain inaccessible." ] }, "authorised_signer": { "type": "string", "pattern": "^per_", "description": "A person on the authorised-signer list who signs the certificate.", "examples": [ "per_01JC9A11" ] }, "directors": { "type": "array", "items": {}, "description": "Changes to officers and directors, with their written service agreements, if any.", "examples": [ "[\"per_01JC9A11\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Filing date; due on or before March 1.", "examples": [ "2027-02-20" ] } }, "required": [ "state", "emergency_condition", "emergency_description", "authorised_signer" ], "description": "Files the annual continuation that keeps a temporary transfer of domicile into Delaware in force. Due on or before March 1 each year; if not filed, the related filings become void on March 2." }, "Create_us_temporary_transfer_extend": { "type": "object", "properties": { "type": { "const": "us.temporary_transfer.extend" }, "params": { "$ref": "#/components/schemas/Params_us_temporary_transfer_extend" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Continue a Delaware temporary transfer of domicile", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "continuation_certificate", "title": "Annual certificate of continuation of temporary transfer", "source": "generated", "required": true }, { "key": "officer_certificate", "title": "Officer's certificate that the emergency continues", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "continuation_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "officer_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Delaware Continuation of Temporary Transfer of Domicile", "channel": "online", "government_fee": { "amount": 2569, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "transfer_void", "type": null, "when": "The March 1 deadline passed and the transfer filings are void; a new us.temporary_transfer.file is needed." }, { "code": "signer_not_authorised", "type": null, "when": "The signer is not on the authorised list." }, { "code": "sanctions_hold", "type": null, "when": "An open sanctions alert on the entity or a person." } ] } }, "Params_us_temporary_transfer_file": { "type": "object", "properties": { "home_jurisdiction": { "type": "string", "description": "ISO 3166 country code of the entity's home jurisdiction.", "examples": [ "UA" ] }, "home_registry_number": { "type": "string", "description": "Registration number at the home registry.", "examples": [ "12345678" ] }, "name": { "type": "string", "description": "Legal name of the non-US entity.", "examples": [ "Dnipro Logistics LLC" ] }, "emergency_condition": { "type": "string", "enum": [ "war_or_armed_conflict", "revolution_or_insurrection", "foreign_invasion_or_occupation", "extended_civil_unrest", "domination_by_foreign_power", "expropriation_or_impairment_of_property", "trading_with_enemy_action", "immediate_threat", "other_permitted_by_home_law" ], "description": "The emergency condition (8 Del.", "examples": [ "war_or_armed_conflict" ] }, "emergency_description": { "type": "string", "description": "Facts of the emergency and why a temporary transfer is needed.", "examples": [ "Active armed conflict at the registered office and data centre; registry access disrupted." ] }, "registered_agent": { "type": "string", "pattern": "^per_", "description": "Delaware registered agent; defaults to Entiva.", "examples": [ "per_01JC9A02" ] }, "authorised_signers": { "type": "array", "items": {}, "description": "List of persons authorised to sign the transfer notice and later filings (s.389).", "examples": [ "[\"per_01JC9A11\"]" ] }, "directors": { "type": "array", "items": {}, "description": "Officers and directors; each gives a written agreement to service of process (s.389).", "examples": [ "[\"per_01JC9A11\",\"per_01JC9A12\"]" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested date of transfer.", "examples": [ "2026-12-01" ] }, "waiver_request": { "type": "object", "description": "Request to waive the 30-day lead time and/or translation requirement, with reasons.", "examples": [ "{\"thirty_day_period\":true,\"translation\":false}" ] }, "home_law_permits": { "type": "boolean", "description": "The entity confirms its governing law does not expressly prohibit the transfer (s.389).", "examples": [ "true" ] }, "principal_office": { "$ref": "#/components/schemas/Address", "description": "Current principal office, which may be outside Delaware.", "examples": [ "{\"line1\":\"12 Soborna St\",\"city\":\"Dnipro\",\"postal_code\":\"49000\",\"country\":\"UA\"}" ] } }, "required": [ "home_jurisdiction", "home_registry_number", "name", "emergency_condition", "emergency_description", "authorised_signers", "directors", "home_law_permits", "principal_office" ], "description": "Files the notice and supporting documents for an emergency temporary transfer of a non-US entity's domicile into Delaware under 8 Del. C. s.389, used when war, armed conflict, revolution, foreign occupation, expropriation or a similar." }, "Create_us_temporary_transfer_file": { "type": "object", "properties": { "type": { "const": "us.temporary_transfer.file" }, "params": { "$ref": "#/components/schemas/Params_us_temporary_transfer_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Delaware temporary transfer of domicile for a non-US corporation", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/formations" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "certified_charter", "title": "Certified charter and bylaws", "source": "uploaded", "required": true }, { "key": "certificate_of_good_standing", "title": "Certificate of existence from the home jurisdiction", "source": "uploaded", "required": true }, { "key": "officer_list", "title": "List of officers and directors with written service-of-process agreements", "source": "uploaded", "required": true }, { "key": "officer_certificate", "title": "Officer's or director's certificate", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution authorising the transfer", "source": "generated", "required": true }, { "key": "certified_translation", "title": "Certified translation", "source": "uploaded", "required": false }, { "key": "registered_agent_consent", "title": "Registered agent consent", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Secretary of State certification of transfer", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "enhanced" }, { "role": "shareholder", "verification_level": "enhanced" }, { "role": "authorised_representative", "verification_level": "identity" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "officer_certificate", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "officer_list", "signer_role": "director", "method": "wet_ink", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "certified_charter", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": null, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Delaware Department of State, Division of Corporations", "form": "Delaware Certificate of Temporary Transfer of Domicile", "channel": "both", "government_fee": { "amount": 10069, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "home_law_prohibits_transfer", "type": null, "when": "The home governing law expressly prohibits the transfer." }, { "code": "emergency_condition_unsupported", "type": null, "when": "The facts do not fit s.389." }, { "code": "documents_incomplete", "type": null, "when": "Charter, certificate of existence or officer list is missing and no waiver has been granted." }, { "code": "sanctions_hold", "type": null, "when": "The entity, an officer or an owner matches OFAC or other lists; Entiva cannot file." }, { "code": "filing_lead_time", "type": null, "when": "The effective_date is less than 30 days away and no waiver was requested." } ] } }, "Params_us_temporary_transfer_withdraw": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ], "description": "Always DE.", "examples": [ "DE" ] }, "effective_date": { "type": "string", "format": "date", "description": "Requested date of withdrawal.", "examples": [ "2027-06-30" ] }, "reason": { "type": "string", "description": "Why the emergency has ended or the transfer is no longer needed.", "examples": [ "Hostilities ended; registry operations restored." ] }, "consular_certificate": { "type": "string", "pattern": "^doc_", "description": "Certificate of consent from the home jurisdiction's consul (s.389).", "examples": [ "doc_01JD2B10" ] }, "authorised_signer": { "type": "string", "pattern": "^per_", "description": "Person on the authorised-signer list.", "examples": [ "per_01JC9A11" ] } }, "required": [ "state", "reason", "consular_certificate", "authorised_signer" ], "description": "Ends a temporary transfer of domicile into Delaware (8 Del. C. s.389) once the emergency condition has ended, by application supported by a board resolution and a consular certificate of consent." }, "Create_us_temporary_transfer_withdraw": { "type": "object", "properties": { "type": { "const": "us.temporary_transfer.withdraw" }, "params": { "$ref": "#/components/schemas/Params_us_temporary_transfer_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a Delaware temporary transfer of domicile", "x-entiva": { "jurisdiction": "us", "stage": "restructuring", "applies_to": [ "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution approving withdrawal", "source": "generated", "required": true }, { "key": "consular_certificate", "title": "Consular certificate of consent", "source": "uploaded", "required": true }, { "key": "withdrawal_application", "title": "Application for withdrawal of temporary transfer", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Registry receipt", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "external", "body": "regulator", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "withdrawal_application", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": null, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "consular_certificate", "signer_role": "authorised_signatory", "method": "wet_ink_notarised_apostilled", "witness_required": null, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Delaware Withdrawal of Temporary Transfer of Domicile", "channel": "both", "government_fee": { "amount": 2569, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "consular_certificate_missing", "type": null, "when": "No consular certificate of consent was uploaded." }, { "code": "transfer_not_active", "type": null, "when": "The temporary transfer is void or already withdrawn." }, { "code": "signer_not_authorised", "type": null, "when": "The signer is not on the authorised list." } ] } }, "Params_us_administrative_dissolution_record": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of formation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "description": "Entity type key." }, "effective_date": { "type": "string", "format": "date", "description": "Date the state treated the entity as void, dissolved, cancelled or revoked.", "examples": [ "2026-03-02" ] }, "cause": { "type": "string", "enum": [ "unpaid_franchise_tax", "unfiled_annual_report", "unpaid_annual_tax", "no_registered_agent", "revoked_in_default", "other" ], "description": "Why the state acted." }, "outstanding_balance": { "$ref": "#/components/schemas/Money", "description": "Back taxes, penalties and interest as shown by the registry." }, "registry_notice_reference": { "type": "string", "description": "Reference on the state's notice." } }, "required": [ "state", "entity_type", "effective_date", "cause" ], "description": "Records that the state has dissolved, voided, cancelled or revoked the entity for non-payment or non-filing. There is no filing." }, "Create_us_administrative_dissolution_record": { "type": "object", "properties": { "type": { "const": "us.administrative_dissolution.record" }, "params": { "$ref": "#/components/schemas/Params_us_administrative_dissolution_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record a state-initiated dissolution, voidance or revocation", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp", "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "registry_notice", "title": "State notice of dissolution or revocation", "source": "uploaded", "required": false }, { "key": "registry_receipt", "title": "Registry status extract", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "none" } ], "approvals": [ { "kind": "none", "body": "none", "threshold": "none", "method": "decision" } ], "signatures": [ { "document_key": "registry_notice", "signer_role": "officer", "method": "none", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None. No filing", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_active_in_registry", "type": null, "when": "The registry shows the entity in good standing." }, { "code": "state_not_supported", "type": null, "when": "Registry status lookup unavailable for the state." } ] } }, "Params_us_corporation_dissolve": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of incorporation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "description": "Entity type key." }, "approval_route": { "type": "string", "enum": [ "board_and_stockholders", "unanimous_stockholders", "before_issuance_of_shares", "nonstock_members" ], "description": "How dissolution is authorised. board_and_stockholders: board resolution plus majority of outstanding voting stock. unanimous_stockholders: written consent of." }, "form_variant": { "type": "string", "enum": [ "standard", "short_form" ], "description": "Delaware only. standard certificate or the short form listed on the fee schedule." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of the dissolution.", "examples": [ "2026-12-31" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the board resolution or stockholder consent was adopted.", "examples": [ "2026-11-20" ] }, "taxes_paid_through": { "type": "string", "format": "date", "description": "Date through which franchise taxes and annual reports are filed and paid.", "examples": [ "2026-11-20" ] }, "directors": { "type": "array", "items": {}, "description": "Directors who sign the board resolution, as person references.", "examples": [ "[\"per_3Fk9\",\"per_7Qd2\"]" ] }, "officer": { "type": "string", "pattern": "^per_", "description": "Authorised officer who signs the certificate.", "examples": [ "per_3Fk9" ] }, "liquidators": { "type": "array", "items": {}, "description": "People who wind up the affairs." }, "forwarding_address": { "$ref": "#/components/schemas/Address", "description": "Delaware s.275 certificates filed from Aug 1, 2026 must give a forwarding address." }, "consent_to_service": { "type": "boolean", "description": "Delaware s.275 certificates from Aug 1, 2026 must consent to service of process through the Secretary of State." }, "expedite": { "type": "boolean", "description": "Ask the registry for expedited handling where offered; fee passes through at cost." }, "certified_copy": { "type": "boolean", "description": "Order a certified copy of the filed certificate for banks and tax authorities." } }, "required": [ "state", "entity_type", "approval_route", "effective_date", "resolution_date", "taxes_paid_through", "directors", "officer" ], "description": "Files the certificate of dissolution for a stock or nonstock corporation after the required board and stockholder approvals, and starts the winding up. Delaware: 8 Del." }, "Create_us_corporation_dissolve": { "type": "object", "properties": { "type": { "const": "us.corporation.dissolve" }, "params": { "$ref": "#/components/schemas/Params_us_corporation_dissolve" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Dissolve a corporation", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution declaring dissolution advisable", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder vote or written consent", "source": "generated", "required": true }, { "key": "certificate_of_dissolution", "title": "Certificate or articles of dissolution", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true }, { "key": "certified_copy", "title": "Certified copy of the certificate", "source": "registry_issued", "required": false } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_dissolution", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Dissolution", "channel": "online", "government_fee": { "amount": 224, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unpaid_franchise_tax", "type": null, "when": "Taxes or annual reports through the dissolution date are outstanding." }, { "code": "approval_threshold_not_met", "type": null, "when": "Stockholder vote below a majority of outstanding voting stock, or a stockholder missing on the unanimous route." }, { "code": "consent_to_service_missing", "type": null, "when": "Delaware s.275 route without consent to service or a forwarding address." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The entity is void, forfeited or revoked; use us.entity.restore first." }, { "code": "sanctions_alert_open", "type": null, "when": "An open sanctions alert on a person in the action pauses live filings." }, { "code": "state_not_supported", "type": null, "when": "State not covered by the dissolution flow." } ] } }, "Params_us_dissolution_revoke": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp" ], "description": "Entity type key." }, "dissolution_filed_date": { "type": "string", "format": "date", "description": "Date the certificate of dissolution was filed.", "examples": [ "2026-12-31" ] }, "resolution_date": { "type": "string", "format": "date", "description": "Date the revocation was approved.", "examples": [ "2027-01-15" ] }, "directors": { "type": "array", "items": {}, "description": "Directors who sign the resolution." }, "officer": { "type": "string", "pattern": "^per_", "description": "Officer who signs the certificate.", "examples": [ "per_3Fk9" ] }, "taxes_current_through": { "type": "string", "format": "date", "description": "Date through which franchise taxes are current; the $189 fee is plus taxes." } }, "required": [ "state", "entity_type", "dissolution_filed_date", "resolution_date", "directors", "officer" ], "description": "Files a Delaware certificate of revocation of dissolution to undo a dissolution that has been filed but not yet completed." }, "Create_us_dissolution_revoke": { "type": "object", "properties": { "type": { "const": "us.dissolution.revoke" }, "params": { "$ref": "#/components/schemas/Params_us_dissolution_revoke" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Revoke a dissolution", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Board resolution revoking dissolution", "source": "generated", "required": true }, { "key": "stockholder_consent", "title": "Stockholder approval", "source": "generated", "required": true }, { "key": "certificate_of_revocation", "title": "Certificate of revocation of dissolution", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "officer", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "corporate", "body": "members", "threshold": "majority", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "stockholder_consent", "signer_role": "shareholder", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "self" }, { "document_key": "certificate_of_revocation", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Certificate of Revocation of Dissolution", "channel": "online", "government_fee": { "amount": 189, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "state_not_supported", "type": null, "when": "state is not DE." }, { "code": "dissolution_not_revocable", "type": null, "when": "The winding-up stage has passed the point at which s.311 allows revocation." }, { "code": "approval_threshold_not_met", "type": null, "when": "Approvals below the required vote." } ] } }, "Params_us_ein_deactivate": { "type": "object", "properties": { "ein": { "type": "string", "description": "EIN to deactivate.", "examples": [ "12-3456789" ] }, "reason": { "type": "string", "enum": [ "dissolved", "cancelled", "merged", "ceased_us_operations", "other" ], "description": "Reason stated in the letter." }, "final_returns_filed": { "type": "boolean", "description": "All outstanding returns filed and taxes paid, including final income and payroll returns." }, "is_exempt_organisation": { "type": "boolean", "description": "True routes the letter to EO Entity, MS 6273 Ogden, or fax 855-214-7520." }, "signer": { "type": "string", "pattern": "^per_", "description": "Authorised officer, member or partner who signs.", "examples": [ "per_3Fk9" ] }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Entity's last mailing address as it appears on IRS records." } }, "required": [ "ein", "reason", "final_returns_filed", "signer" ], "description": "Sends the IRS the closing letter that deactivates the entity's EIN after all outstanding returns are filed and taxes paid. The EIN is deactivated, not cancelled, and stays permanently assigned." }, "Create_us_ein_deactivate": { "type": "object", "properties": { "type": { "const": "us.ein.deactivate" }, "params": { "$ref": "#/components/schemas/Params_us_ein_deactivate" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Deactivate the EIN and close the IRS business account", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "s_corp_election", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "pllc", "lp", "lllp", "llp", "general_partnership", "statutory_trust", "cooperative", "wy_dao_llc", "wy_statutory_foundation", "statutory_public_benefit_llc", "statutory_public_benefit_lp", "l3c", "wy_close_llc", "unincorporated_nonprofit_association", "wy_duna", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "ein_closure_letter", "title": "Letter asking the IRS to close the business account", "source": "generated", "required": true }, { "key": "ein_letter", "title": "EIN assignment notice", "source": "uploaded", "required": false }, { "key": "filing_proof", "title": "Proof of mailing or fax", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "ein_closure_letter", "signer_role": "authorised_signatory", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Closing letter", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "returns_outstanding", "type": null, "when": "final_returns_filed is false or Entiva sees an open final return action." }, { "code": "ein_not_on_record", "type": null, "when": "The entity has no EIN on file." } ] } }, "Params_us_entity_restore": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of formation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc" ], "description": "Entity type key." }, "cause": { "type": "string", "enum": [ "unpaid_franchise_tax", "unfiled_annual_report", "unpaid_annual_tax", "no_registered_agent", "revoked_in_default", "other" ], "description": "Why the entity lost its status." }, "lapse_date": { "type": "string", "format": "date", "description": "Date status was lost.", "examples": [ "2026-03-02" ] }, "back_taxes_authorised": { "$ref": "#/components/schemas/Money", "description": "Maximum back taxes, penalties and interest the customer authorises Entiva to pay at cost." }, "appoint_registered_agent": { "type": "boolean", "description": "Appoint Entiva's registered-agent partner; required when the cause was no registered agent." }, "authorised_signer": { "type": "string", "pattern": "^per_", "description": "Officer, authorised person or director who signs.", "examples": [ "per_3Fk9" ] }, "annual_reports_to_file": { "type": "array", "items": {}, "description": "Missing annual reports Entiva files with the revival." }, "exempt_corporation": { "type": "boolean", "description": "Delaware only: exempt corporation fee tier." } }, "required": [ "state", "entity_type", "cause", "lapse_date", "back_taxes_authorised", "authorised_signer" ], "description": "Files the state revival or reinstatement and pays back taxes, penalties and interest at cost." }, "Create_us_entity_restore": { "type": "object", "properties": { "type": { "const": "us.entity.restore" }, "params": { "$ref": "#/components/schemas/Params_us_entity_restore" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Revive or reinstate a void, cancelled or revoked entity", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "nonprofit_corp", "llc_single_member", "llc_multi_member", "series_llc", "lp", "llp", "lllp", "statutory_trust", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution authorising revival", "source": "generated", "required": true }, { "key": "certificate_of_revival", "title": "Certificate of revival or reinstatement application", "source": "generated", "required": true }, { "key": "registry_balance_statement", "title": "Registry statement of back taxes and penalties", "source": "registry_issued", "required": true }, { "key": "registered_agent_consent", "title": "Registered agent acceptance", "source": "generated", "required": false }, { "key": "registry_receipt", "title": "Stamped filed revival", "source": "registry_issued", "required": true } ], "people": [ { "role": "director", "verification_level": "identity_address" }, { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_revival", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "registered_agent_consent", "signer_role": "registered_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "self" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Revival", "channel": "online", "government_fee": { "amount": 189, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "restoration_window_expired", "type": null, "when": "WY more than 2 years after dissolution, or NV beyond 5 consecutive years of revocation." }, { "code": "back_taxes_exceed_authorisation", "type": null, "when": "The registry balance is above back_taxes_authorised." }, { "code": "name_unavailable", "type": null, "when": "The state name has been taken by another entity while the entity was inactive." }, { "code": "entity_active_in_registry", "type": null, "when": "The entity is in good standing; nothing to restore." }, { "code": "registered_agent_required", "type": null, "when": "Cause is no registered agent and none appointed." } ] } }, "Params_us_final_payroll_return_file": { "type": "object", "properties": { "final_wage_date": { "type": "string", "format": "date", "description": "Date of the last wage payment.", "examples": [ "2026-12-15" ] }, "has_employees": { "type": "boolean", "description": "False returns form_not_required." }, "payroll_provider": { "type": "string", "description": "Name of the payroll provider whose records Entiva reconciles." }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer or responsible person who authorises the filings.", "examples": [ "per_3Fk9" ] } }, "required": [ "final_wage_date", "has_employees", "signer" ], "description": "Files the entity's final payroll tax filings once it stops paying wages." }, "Create_us_final_payroll_return_file": { "type": "object", "properties": { "type": { "const": "us.final_payroll_return.file" }, "params": { "$ref": "#/components/schemas/Params_us_final_payroll_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File final payroll returns", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "s_corp_election", "llc_multi_member", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "payroll_records", "title": "Payroll registers and deposit records for the final period", "source": "uploaded", "required": true }, { "key": "final_payroll_return", "title": "Final payroll returns", "source": "generated", "required": true }, { "key": "efile_acknowledgement", "title": "E-file acknowledgement", "source": "registry_issued", "required": false } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "final_payroll_return", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Final payroll returns", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "form_not_required", "type": null, "when": "The entity never had employees." }, { "code": "unpaid_payroll_tax", "type": null, "when": "Deposits are outstanding." } ] } }, "Params_us_final_return_file": { "type": "object", "properties": { "return_form": { "type": "string", "enum": [ "1120", "1120_s", "1065" ], "description": "Federal return to file." }, "dissolution_date": { "type": "string", "format": "date", "description": "Date the entity dissolved or liquidated; closes the final short tax year.", "examples": [ "2026-12-31" ] }, "final_period_end": { "type": "string", "format": "date", "description": "End of the final tax period.", "examples": [ "2026-12-31" ] }, "signer": { "type": "string", "pattern": "^per_", "description": "Officer or general partner or member who signs the e-file authorisation.", "examples": [ "per_3Fk9" ] }, "liquidating_distributions": { "$ref": "#/components/schemas/Money", "description": "Total liquidating distributions, for the return." }, "foreign_owner": { "type": "boolean", "description": "True if Form 5472 is also due for the final period; Entiva then prepares it." } }, "required": [ "return_form", "dissolution_date", "final_period_end", "signer" ], "description": "Prepares and e-files the final Form 1120, 1120-S or 1065 with the 'final return' box checked. Partnerships and multi-member LLCs taxed as partnerships file only the final 1065." }, "Create_us_final_return_file": { "type": "object", "properties": { "type": { "const": "us.final_return.file" }, "params": { "$ref": "#/components/schemas/Params_us_final_return_file" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "File the final federal income tax return", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "s_corp_election", "llc_multi_member", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "financial_statements", "title": "Final financial statements and trial balance", "source": "uploaded", "required": true }, { "key": "final_return", "title": "Final federal return", "source": "generated", "required": true }, { "key": "efile_authorisation", "title": "E-file authorisation", "source": "generated", "required": true }, { "key": "efile_acknowledgement", "title": "IRS e-file acknowledgement", "source": "registry_issued", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "general_partner", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" }, { "kind": "compliance", "body": "licensed_partner", "threshold": "consent", "method": "decision" } ], "signatures": [ { "document_key": "efile_authorisation", "signer_role": "officer", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form 1120 / 1120-S / 1065 with the final return box checked", "channel": "online", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "wrong_return_form", "type": null, "when": "return_form does not fit the entity's tax classification." }, { "code": "efile_rejected", "type": null, "when": "The IRS rejects the e-file; the rejection code is returned and the action returns to requirements_pending." }, { "code": "financial_statements_missing", "type": null, "when": "No final financial statements uploaded." } ] } }, "Params_us_foreign_qualification_withdraw": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state where the qualification is being withdrawn.", "examples": [ "NV" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "llc_single_member", "llc_multi_member", "lp", "llp", "foreign_company" ], "description": "Entity type key of the entity being withdrawn." }, "home_jurisdiction": { "type": "string", "description": "State code or ISO 3166 country code where the entity is formed.", "examples": [ "DE" ] }, "effective_date": { "type": "string", "format": "date", "description": "Date the entity stops doing business in the state.", "examples": [ "2026-12-31" ] }, "reason": { "type": "string", "enum": [ "ceased_business_in_state", "dissolving_entity", "merger", "other" ], "description": "Why the withdrawal is filed." }, "taxes_paid_through": { "type": "string", "format": "date", "description": "Date through which the state's taxes and reports are paid." }, "authorised_signer": { "type": "string", "pattern": "^per_", "description": "Officer, manager or authorised person who signs.", "examples": [ "per_3Fk9" ] }, "boi_status": { "type": "string", "enum": [ "foreign_reporting_company", "not_reporting" ], "description": "For foreign_company only: whether the entity is a FinCEN reporting company." } }, "required": [ "state", "entity_type", "home_jurisdiction", "effective_date", "reason", "taxes_paid_through", "authorised_signer" ], "description": "Files the state withdrawal that ends an entity's registration to do business in a state other than its home state, or ends a non-US company's registration in a US state." }, "Create_us_foreign_qualification_withdraw": { "type": "object", "properties": { "type": { "const": "us.foreign_qualification.withdraw" }, "params": { "$ref": "#/components/schemas/Params_us_foreign_qualification_withdraw" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Withdraw a foreign qualification", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "llc_single_member", "llc_multi_member", "lp", "llp", "foreign_company" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "board_resolution", "title": "Resolution authorising withdrawal", "source": "generated", "required": true }, { "key": "certificate_of_withdrawal", "title": "Certificate of withdrawal or cancellation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed withdrawal", "source": "registry_issued", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" }, { "role": "director", "verification_level": "identity_address" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "board", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "board_resolution", "signer_role": "director", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_withdrawal", "signer_role": "authorised_signatory", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "State Secretary of State or corporations division of the qualification state", "form": "DE Certificate of Withdrawal", "channel": "online", "government_fee": { "amount": 175, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "not_qualified_in_state", "type": null, "when": "The entity is not registered in the state." }, { "code": "unpaid_state_taxes", "type": null, "when": "The state shows unpaid taxes or reports that block withdrawal." }, { "code": "tax_clearance_required", "type": null, "when": "The state requires tax clearance before withdrawal." }, { "code": "state_not_supported", "type": null, "when": "Withdrawal flow not yet available for the state." } ] } }, "Params_us_inactive_status_record": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter USPS code of the state of formation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "c_corp", "llc_single_member", "llc_multi_member", "lp" ], "description": "Entity type key." }, "effective_date": { "type": "string", "format": "date", "description": "Date the entity stopped operating.", "examples": [ "2026-09-30" ] }, "reason": { "type": "string", "enum": [ "ceased_trading", "awaiting_dissolution", "holding_only", "other" ], "description": "Why the entity is inactive." }, "planned_dissolution_date": { "type": "string", "format": "date", "description": "Date the owners intend to dissolve or cancel, if known." }, "foreign_owner": { "type": "boolean", "description": "True if a foreign person owns a single-member LLC or 25% of a corporation." }, "keep_registered_agent": { "type": "boolean", "description": "Keep the registered agent appointment while inactive.", "examples": [ "true" ] } }, "required": [ "state", "entity_type", "effective_date", "reason" ], "description": "Records in Entiva that the entity has stopped operating. Nothing is filed, because Delaware, Wyoming and Nevada have no dormant regime." }, "Create_us_inactive_status_record": { "type": "object", "properties": { "type": { "const": "us.inactive_status.record" }, "params": { "$ref": "#/components/schemas/Params_us_inactive_status_record" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Record an entity as inactive", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "llc_single_member", "llc_multi_member", "lp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "inactivity_statement", "title": "Statement of inactivity", "source": "generated", "required": true } ], "people": [ { "role": "authorised_signatory", "verification_level": "identity_address" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "inactivity_statement", "signer_role": "authorised_signatory", "method": "click_consent", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "None", "form": "None", "channel": "none", "government_fee": { "amount": null, "currency": "USD" } }, "entiva_fee_basis": "included", "errors": [ { "code": "entity_not_active", "type": null, "when": "The entity is already dissolved, void or cancelled." }, { "code": "dissolution_in_progress", "type": null, "when": "A dissolution or cancellation action is already open for the entity." }, { "code": "state_not_supported", "type": null, "when": "The state value is not a US state or DC." } ] } }, "Params_us_irs_dissolution_notify": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "s_corp_election", "llc_multi_member" ], "description": "Entity type key." }, "tax_classification": { "type": "string", "enum": [ "c_corporation", "s_corporation", "llc_taxed_as_corporation" ], "description": "Federal tax classification." }, "resolution_date": { "type": "string", "format": "date", "description": "Date the resolution or plan to dissolve was adopted.", "examples": [ "2026-11-20" ] }, "ein": { "type": "string", "description": "The entity's EIN.", "examples": [ "12-3456789" ] }, "is_qsub_or_exempt": { "type": "boolean", "description": "Must be false." }, "plan_amended": { "type": "boolean", "description": "True if the plan was amended after a Form 966 was filed; Entiva then prepares the amended filing." }, "officer": { "type": "string", "pattern": "^per_", "description": "Officer who signs the form by hand.", "examples": [ "per_3Fk9" ] } }, "required": [ "entity_type", "tax_classification", "resolution_date", "ein", "officer" ], "description": "Prepares and files IRS Form 966 within 30 days after the resolution or plan to dissolve is adopted. Applies to corporations, including LLCs taxed as corporations and S corporations." }, "Create_us_irs_dissolution_notify": { "type": "object", "properties": { "type": { "const": "us.irs_dissolution.notify" }, "params": { "$ref": "#/components/schemas/Params_us_irs_dissolution_notify" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Notify the IRS of a corporate dissolution", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "c_corp", "public_benefit_corp", "close_corp", "professional_corp", "s_corp_election", "llc_multi_member" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "form_966", "title": "IRS Form 966", "source": "generated", "required": true }, { "key": "board_resolution", "title": "Resolution or plan of dissolution", "source": "uploaded", "required": true }, { "key": "ein_letter", "title": "EIN assignment notice", "source": "uploaded", "required": false }, { "key": "filing_proof", "title": "Proof of fax or mailing", "source": "generated", "required": true } ], "people": [ { "role": "officer", "verification_level": "identity_address" }, { "role": "tax_agent", "verification_level": "none" } ], "approvals": [ { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "form_966", "signer_role": "officer", "method": "wet_ink", "witness_required": false, "agent_signing": "human_wet_ink", "signs_for": "entity" } ], "filing": { "registry": "Internal Revenue Service", "form": "Form 966", "channel": "paper", "government_fee": { "amount": 0, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "form_not_required", "type": null, "when": "The entity is a QSub, exempt organisation, or an LLC taxed as a partnership." }, { "code": "deadline_missed", "type": null, "when": "More than 30 days have passed since resolution_date; Entiva still files and flags late status." }, { "code": "ein_missing", "type": null, "when": "No EIN on the entity record." } ] } }, "Params_us_llc_cancel": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of formation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "wy_dao_llc" ], "description": "Entity type key." }, "dissolution_event": { "type": "string", "enum": [ "member_vote", "agreement_event", "term_expired", "sole_member_decision", "other" ], "description": "What triggered dissolution under the LLC agreement." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of cancellation.", "examples": [ "2026-12-31" ] }, "winding_up_completed": { "type": "boolean", "description": "Confirms debts are paid or provided for and assets distributed." }, "annual_tax_paid_through": { "type": "string", "format": "date", "description": "Date through which the annual tax or license tax is paid.", "examples": [ "2026-12-31" ] }, "registered_series": { "type": "array", "items": {}, "description": "Names of registered series to cancel with the LLC." }, "authorised_person": { "type": "string", "pattern": "^per_", "description": "Person who signs the certificate if not Entiva." }, "members": { "type": "array", "items": {}, "description": "Members who approve, as person references." }, "expedite": { "type": "boolean", "description": "Request expedited handling where offered." } }, "required": [ "state", "entity_type", "dissolution_event", "effective_date", "winding_up_completed", "annual_tax_paid_through", "members" ], "description": "Files the certificate of cancellation or the Wyoming and Nevada equivalents after winding up an LLC, including registered series. Annual tax for the year of cancellation is paid in full first; there is no proration." }, "Create_us_llc_cancel": { "type": "object", "properties": { "type": { "const": "us.llc.cancel" }, "params": { "$ref": "#/components/schemas/Params_us_llc_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel an LLC", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "llc_single_member", "llc_multi_member", "series_llc", "pllc", "wy_dao_llc" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "members_resolution", "title": "Members' consent to dissolve and cancel", "source": "generated", "required": true }, { "key": "certificate_of_cancellation", "title": "Certificate of cancellation or articles of dissolution", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "member", "verification_level": "identity_address" }, { "role": "manager", "verification_level": "identity_address" }, { "role": "filing_agent", "verification_level": "none" }, { "role": "registered_agent", "verification_level": "none" } ], "approvals": [ { "kind": "corporate", "body": "members", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "members_resolution", "signer_role": "member", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_cancellation", "signer_role": "filing_agent", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Cancellation", "channel": "online", "government_fee": { "amount": 220, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unpaid_annual_tax", "type": null, "when": "Annual tax for the cancellation year or earlier years is unpaid." }, { "code": "winding_up_not_confirmed", "type": null, "when": "winding_up_completed is false." }, { "code": "series_not_listed", "type": null, "when": "A registered series on the registry record is missing from registered_series." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The LLC is cancelled, void or revoked; use us.entity.restore first." }, { "code": "approval_threshold_not_met", "type": null, "when": "Member approvals do not meet the LLC agreement." } ] } }, "Params_us_lp_cancel": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of formation.", "examples": [ "DE" ] }, "entity_type": { "type": "string", "enum": [ "lp", "lllp" ], "description": "Entity type key." }, "dissolution_event": { "type": "string", "enum": [ "partner_vote", "agreement_event", "term_expired", "withdrawal_of_last_general_partner", "other" ], "description": "What triggered dissolution under the partnership agreement." }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of cancellation.", "examples": [ "2026-12-31" ] }, "winding_up_completed": { "type": "boolean", "description": "Confirms debts are paid or provided for and assets distributed." }, "annual_tax_paid_through": { "type": "string", "format": "date", "description": "Date through which annual tax is paid.", "examples": [ "2026-12-31" ] }, "registered_series": { "type": "array", "items": {}, "description": "Registered series to cancel; Delaware charges $50 per series." }, "general_partners": { "type": "array", "items": {}, "description": "General partners who sign, as person references." }, "liquidator": { "type": "string", "pattern": "^per_", "description": "Person winding up the partnership, if not the general partners." } }, "required": [ "state", "entity_type", "dissolution_event", "effective_date", "winding_up_completed", "annual_tax_paid_through", "general_partners" ], "description": "Files the certificate of cancellation for a limited partnership or LLLP after winding up. Wyoming and Nevada equivalents are quoted at runtime." }, "Create_us_lp_cancel": { "type": "object", "properties": { "type": { "const": "us.lp.cancel" }, "params": { "$ref": "#/components/schemas/Params_us_lp_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a limited partnership", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "lp", "lllp" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "partners_resolution", "title": "Partners' consent to dissolve", "source": "generated", "required": true }, { "key": "certificate_of_cancellation", "title": "Certificate of cancellation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "general_partner", "verification_level": "identity_address" }, { "role": "limited_partner", "verification_level": "none" }, { "role": "liquidator", "verification_level": "identity" } ], "approvals": [ { "kind": "corporate", "body": "partners", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "partners_resolution", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" }, { "document_key": "certificate_of_cancellation", "signer_role": "general_partner", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "DE Certificate of Cancellation", "channel": "online", "government_fee": { "amount": 200, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unpaid_annual_tax", "type": null, "when": "Annual tax is unpaid." }, { "code": "winding_up_not_confirmed", "type": null, "when": "winding_up_completed is false." }, { "code": "entity_not_in_good_standing", "type": null, "when": "The LP is void or cancelled; restore first." }, { "code": "approval_threshold_not_met", "type": null, "when": "Partner approvals do not meet the partnership agreement." } ] } }, "Params_us_statutory_trust_cancel": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "description": "Two-letter code of the state of formation.", "examples": [ "DE" ] }, "effective_date": { "type": "string", "format": "date", "description": "Effective date of cancellation.", "examples": [ "2026-12-31" ] }, "winding_up_completed": { "type": "boolean", "description": "Confirms trust liabilities are paid or provided for and assets distributed." }, "termination_basis": { "type": "string", "enum": [ "beneficial_owner_vote", "trustee_decision", "term_expired", "event_in_instrument", "other" ], "description": "What ended the trust under its governing instrument." }, "trustees": { "type": "array", "items": {}, "description": "All trustees, as person or entity references, including the Delaware trustee." }, "annual_fees_paid_through": { "type": "string", "format": "date", "description": "Date through which annual taxes or fees are paid." } }, "required": [ "state", "effective_date", "winding_up_completed", "termination_basis", "trustees", "annual_fees_paid_through" ], "description": "Files the certificate of cancellation for a Delaware statutory trust or the equivalent in Wyoming and Nevada, after the trustees wind up the trust." }, "Create_us_statutory_trust_cancel": { "type": "object", "properties": { "type": { "const": "us.statutory_trust.cancel" }, "params": { "$ref": "#/components/schemas/Params_us_statutory_trust_cancel" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "type", "params" ], "description": "Cancel a statutory trust", "x-entiva": { "jurisdiction": "us", "stage": "closure", "applies_to": [ "statutory_trust" ], "endpoint": { "method": "POST", "path": "/v1/entities/{entity_id}/actions" }, "instruction": { "capacities": [ "director", "officer", "company_secretary", "manager", "general_partner", "authorised_representative" ], "evidence": [ "register_of_directors", "register_of_officers", "board_resolution", "power_of_attorney" ] }, "documents": [ { "key": "trustees_resolution", "title": "Trustees' resolution to terminate and cancel", "source": "generated", "required": true }, { "key": "certificate_of_cancellation", "title": "Certificate of cancellation", "source": "generated", "required": true }, { "key": "registry_receipt", "title": "Stamped filed certificate", "source": "registry_issued", "required": true } ], "people": [ { "role": "trustee", "verification_level": "identity_address" }, { "role": "shareholder", "verification_level": "identity_address" } ], "approvals": [ { "kind": "corporate", "body": "trustees", "threshold": "consent", "method": "meeting_or_written" }, { "kind": "customer", "body": "customer_approver", "threshold": "consent", "method": "in_app" } ], "signatures": [ { "document_key": "trustees_resolution", "signer_role": "trustee", "method": "electronic", "witness_required": false, "agent_signing": "human_only_electronic", "signs_for": "entity" }, { "document_key": "certificate_of_cancellation", "signer_role": "trustee", "method": "electronic", "witness_required": false, "agent_signing": "agent_may_sign_with_mandate", "signs_for": "entity" } ], "filing": { "registry": "Delaware Division of Corporations", "form": "Statutory Trust certificate of cancellation", "channel": "online", "government_fee": { "amount": 500, "currency": "USD" } }, "entiva_fee_basis": "fixed", "errors": [ { "code": "unpaid_annual_fees", "type": null, "when": "Annual fees are unpaid." }, { "code": "trustee_missing", "type": null, "when": "Not every trustee, including the Delaware trustee, has approved." }, { "code": "winding_up_not_confirmed", "type": null, "when": "winding_up_completed is false." } ] } }, "ActionCreate": { "oneOf": [ { "$ref": "#/components/schemas/Create_hk_business_branch_register" }, { "$ref": "#/components/schemas/Create_hk_business_registration_particulars_notify" }, { "$ref": "#/components/schemas/Create_hk_company_incorporate" }, { "$ref": "#/components/schemas/Create_hk_company_name_check" }, { "$ref": "#/components/schemas/Create_hk_company_name_approval_request" }, { "$ref": "#/components/schemas/Create_hk_cooperative_society_register" }, { "$ref": "#/components/schemas/Create_hk_first_director_consent_file" }, { "$ref": "#/components/schemas/Create_hk_general_partnership_register" }, { "$ref": "#/components/schemas/Create_hk_guarantee_company_incorporate" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_register" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_fund_register" }, { "$ref": "#/components/schemas/Create_hk_open_ended_fund_company_incorporate" }, { "$ref": "#/components/schemas/Create_hk_registered_trustees_incorporate" }, { "$ref": "#/components/schemas/Create_hk_society_register" }, { "$ref": "#/components/schemas/Create_hk_society_exemption_apply" }, { "$ref": "#/components/schemas/Create_hk_sole_proprietorship_register" }, { "$ref": "#/components/schemas/Create_hk_tcsp_key_person_approve" }, { "$ref": "#/components/schemas/Create_hk_tcsp_licence_apply" }, { "$ref": "#/components/schemas/Create_hk_tcsp_licence_cease" }, { "$ref": "#/components/schemas/Create_hk_tcsp_licence_renew" }, { "$ref": "#/components/schemas/Create_hk_tcsp_licence_annual_information_file" }, { "$ref": "#/components/schemas/Create_hk_tcsp_licence_changes_notify" }, { "$ref": "#/components/schemas/Create_hk_trust_company_register" }, { "$ref": "#/components/schemas/Create_hk_unlimited_company_incorporate" }, { "$ref": "#/components/schemas/Create_hk_accounting_records_record" }, { "$ref": "#/components/schemas/Create_hk_accounts_revision_notify" }, { "$ref": "#/components/schemas/Create_hk_annual_return_file" }, { "$ref": "#/components/schemas/Create_hk_apostille_private_document_apply" }, { "$ref": "#/components/schemas/Create_hk_apostille_public_document_apply" }, { "$ref": "#/components/schemas/Create_hk_business_registration_renew" }, { "$ref": "#/components/schemas/Create_hk_business_registration_exemption_apply" }, { "$ref": "#/components/schemas/Create_hk_certificate_of_resident_status_apply" }, { "$ref": "#/components/schemas/Create_hk_certified_copy_request" }, { "$ref": "#/components/schemas/Create_hk_continuing_registration_certificate_request" }, { "$ref": "#/components/schemas/Create_hk_designated_representative_appoint" }, { "$ref": "#/components/schemas/Create_hk_designated_representative_remove" }, { "$ref": "#/components/schemas/Create_hk_employee_departure_notify" }, { "$ref": "#/components/schemas/Create_hk_employee_hire_notify" }, { "$ref": "#/components/schemas/Create_hk_employee_termination_notify" }, { "$ref": "#/components/schemas/Create_hk_employer_return_file" }, { "$ref": "#/components/schemas/Create_hk_financial_statements_approve" }, { "$ref": "#/components/schemas/Create_hk_financial_statements_prepare" }, { "$ref": "#/components/schemas/Create_hk_financial_statements_revision_notify" }, { "$ref": "#/components/schemas/Create_hk_fsie_chargeability_notify" }, { "$ref": "#/components/schemas/Create_hk_fsie_economic_substance_file" }, { "$ref": "#/components/schemas/Create_hk_guarantee_company_annual_return_file" }, { "$ref": "#/components/schemas/Create_hk_letter_of_confirmation_request" }, { "$ref": "#/components/schemas/Create_hk_lpf_annual_return_file" }, { "$ref": "#/components/schemas/Create_hk_lpf_registered_office_change" }, { "$ref": "#/components/schemas/Create_hk_money_lender_changes_notify" }, { "$ref": "#/components/schemas/Create_hk_money_lender_exemption_apply" }, { "$ref": "#/components/schemas/Create_hk_money_lender_licence_apply" }, { "$ref": "#/components/schemas/Create_hk_money_lender_licence_renew" }, { "$ref": "#/components/schemas/Create_hk_money_lender_third_party_notify" }, { "$ref": "#/components/schemas/Create_hk_profits_tax_chargeability_unincorporated_notify" }, { "$ref": "#/components/schemas/Create_hk_profits_tax_return_file" }, { "$ref": "#/components/schemas/Create_hk_profits_tax_return_unincorporated_file" }, { "$ref": "#/components/schemas/Create_hk_public_company_annual_return_file" }, { "$ref": "#/components/schemas/Create_hk_registered_non_hk_company_annual_return_file" }, { "$ref": "#/components/schemas/Create_hk_registry_search_request" }, { "$ref": "#/components/schemas/Create_hk_significant_controllers_register_change" }, { "$ref": "#/components/schemas/Create_hk_tax_exempt_charity_apply" }, { "$ref": "#/components/schemas/Create_hk_top_up_tax_notification_file" }, { "$ref": "#/components/schemas/Create_hk_top_up_tax_return_file" }, { "$ref": "#/components/schemas/Create_hk_agm_hold" }, { "$ref": "#/components/schemas/Create_hk_agm_waive" }, { "$ref": "#/components/schemas/Create_hk_agm_written_resolution_pass" }, { "$ref": "#/components/schemas/Create_hk_board_minutes_record" }, { "$ref": "#/components/schemas/Create_hk_board_resolution_pass" }, { "$ref": "#/components/schemas/Create_hk_branch_register_debenture_holders_notify" }, { "$ref": "#/components/schemas/Create_hk_branch_register_members_notify" }, { "$ref": "#/components/schemas/Create_hk_members_resolution_pass" }, { "$ref": "#/components/schemas/Create_hk_ofc_registers_location_notify" }, { "$ref": "#/components/schemas/Create_hk_registers_location_notify" }, { "$ref": "#/components/schemas/Create_hk_specified_resolution_file" }, { "$ref": "#/components/schemas/Create_hk_statutory_registers_change" }, { "$ref": "#/components/schemas/Create_hk_statutory_registers_form" }, { "$ref": "#/components/schemas/Create_hk_auditor_remove" }, { "$ref": "#/components/schemas/Create_hk_auditor_resignation_notify" }, { "$ref": "#/components/schemas/Create_hk_authorized_representative_remove" }, { "$ref": "#/components/schemas/Create_hk_company_secretary_appoint" }, { "$ref": "#/components/schemas/Create_hk_company_secretary_change" }, { "$ref": "#/components/schemas/Create_hk_company_secretary_remove" }, { "$ref": "#/components/schemas/Create_hk_director_appoint" }, { "$ref": "#/components/schemas/Create_hk_lpf_general_partner_change" }, { "$ref": "#/components/schemas/Create_hk_lpf_officer_change" }, { "$ref": "#/components/schemas/Create_hk_nominee_director_appoint" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_officer_appoint" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_officer_cease" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_officer_change" }, { "$ref": "#/components/schemas/Create_hk_ofc_custodian_appoint" }, { "$ref": "#/components/schemas/Create_hk_ofc_custodian_cease" }, { "$ref": "#/components/schemas/Create_hk_ofc_director_appoint" }, { "$ref": "#/components/schemas/Create_hk_ofc_director_cease" }, { "$ref": "#/components/schemas/Create_hk_ofc_director_change" }, { "$ref": "#/components/schemas/Create_hk_ofc_investment_manager_appoint" }, { "$ref": "#/components/schemas/Create_hk_ofc_investment_manager_cease" }, { "$ref": "#/components/schemas/Create_hk_officer_change" }, { "$ref": "#/components/schemas/Create_hk_officer_remove" }, { "$ref": "#/components/schemas/Create_hk_principal_office_change" }, { "$ref": "#/components/schemas/Create_hk_protected_information_withhold" }, { "$ref": "#/components/schemas/Create_hk_reserve_director_cease" }, { "$ref": "#/components/schemas/Create_hk_reserve_director_change" }, { "$ref": "#/components/schemas/Create_hk_reserve_director_nominate" }, { "$ref": "#/components/schemas/Create_hk_reserve_director_resignation_notice_file" }, { "$ref": "#/components/schemas/Create_hk_resignation_notice_file" }, { "$ref": "#/components/schemas/Create_hk_trustee_appoint" }, { "$ref": "#/components/schemas/Create_hk_trustee_remove" }, { "$ref": "#/components/schemas/Create_hk_charge_discharge" }, { "$ref": "#/components/schemas/Create_hk_charge_register" }, { "$ref": "#/components/schemas/Create_hk_charge_enforcement_notify" }, { "$ref": "#/components/schemas/Create_hk_debenture_allot" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_admit_partner" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_assign_limited_partner_share" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_convert_partner_status" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_resign_partner" }, { "$ref": "#/components/schemas/Create_hk_members_increase_notify" }, { "$ref": "#/components/schemas/Create_hk_minority_shares_notify" }, { "$ref": "#/components/schemas/Create_hk_share_allot" }, { "$ref": "#/components/schemas/Create_hk_share_repurchase" }, { "$ref": "#/components/schemas/Create_hk_share_repurchase_out_of_capital" }, { "$ref": "#/components/schemas/Create_hk_share_transfer" }, { "$ref": "#/components/schemas/Create_hk_share_capital_change" }, { "$ref": "#/components/schemas/Create_hk_share_capital_reduce" }, { "$ref": "#/components/schemas/Create_hk_share_class_rights_change" }, { "$ref": "#/components/schemas/Create_hk_treasury_share_cancel" }, { "$ref": "#/components/schemas/Create_hk_treasury_share_transfer" }, { "$ref": "#/components/schemas/Create_hk_accounting_reference_date_change" }, { "$ref": "#/components/schemas/Create_hk_articles_amend" }, { "$ref": "#/components/schemas/Create_hk_business_registration_change" }, { "$ref": "#/components/schemas/Create_hk_business_registration_partners_change" }, { "$ref": "#/components/schemas/Create_hk_company_name_change" }, { "$ref": "#/components/schemas/Create_hk_company_name_licence_apply" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_amend" }, { "$ref": "#/components/schemas/Create_hk_lpf_address_change" }, { "$ref": "#/components/schemas/Create_hk_lpf_name_change" }, { "$ref": "#/components/schemas/Create_hk_memorandum_provisions_amend" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_address_change" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_approved_name_file" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_constitution_amend" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_name_change" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_place_of_incorporation_change" }, { "$ref": "#/components/schemas/Create_hk_objects_amend" }, { "$ref": "#/components/schemas/Create_hk_ofc_name_change" }, { "$ref": "#/components/schemas/Create_hk_ofc_registered_office_change" }, { "$ref": "#/components/schemas/Create_hk_registered_document_rectify" }, { "$ref": "#/components/schemas/Create_hk_registered_office_change" }, { "$ref": "#/components/schemas/Create_hk_society_particulars_notify" }, { "$ref": "#/components/schemas/Create_hk_branch_register" }, { "$ref": "#/components/schemas/Create_hk_company_continue_in" }, { "$ref": "#/components/schemas/Create_hk_company_merge" }, { "$ref": "#/components/schemas/Create_hk_company_status_convert_to_private" }, { "$ref": "#/components/schemas/Create_hk_company_status_convert_to_public" }, { "$ref": "#/components/schemas/Create_hk_eligible_company_register" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_as_lpf_register" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_fund_continue_in" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_register" }, { "$ref": "#/components/schemas/Create_hk_open_ended_fund_company_continue_in" }, { "$ref": "#/components/schemas/Create_hk_place_of_incorporation_change" }, { "$ref": "#/components/schemas/Create_hk_redomiciliation_charge_register" }, { "$ref": "#/components/schemas/Create_hk_redomiciliation_deregistration_evidence_file" }, { "$ref": "#/components/schemas/Create_hk_redomiciliation_deregistration_period_extend" }, { "$ref": "#/components/schemas/Create_hk_redomiciliation_director_consent_file" }, { "$ref": "#/components/schemas/Create_hk_redomiciliation_members_return_file" }, { "$ref": "#/components/schemas/Create_hk_scheme_of_arrangement_apply" }, { "$ref": "#/components/schemas/Create_hk_scheme_of_arrangement_order_register" }, { "$ref": "#/components/schemas/Create_hk_unlimited_company_convert_to_limited" }, { "$ref": "#/components/schemas/Create_hk_business_registration_cancel" }, { "$ref": "#/components/schemas/Create_hk_company_deregister" }, { "$ref": "#/components/schemas/Create_hk_company_restore" }, { "$ref": "#/components/schemas/Create_hk_company_restoration_court_apply" }, { "$ref": "#/components/schemas/Create_hk_company_restoration_court_order_register" }, { "$ref": "#/components/schemas/Create_hk_court_winding_up_petition" }, { "$ref": "#/components/schemas/Create_hk_court_winding_up_statement_of_affairs_file" }, { "$ref": "#/components/schemas/Create_hk_creditors_voluntary_winding_up_commence" }, { "$ref": "#/components/schemas/Create_hk_creditors_voluntary_winding_up_complete" }, { "$ref": "#/components/schemas/Create_hk_directors_winding_up_commence" }, { "$ref": "#/components/schemas/Create_hk_dormancy_cease" }, { "$ref": "#/components/schemas/Create_hk_dormancy_declare" }, { "$ref": "#/components/schemas/Create_hk_limited_partnership_wind_up" }, { "$ref": "#/components/schemas/Create_hk_liquidation_final_return_file" }, { "$ref": "#/components/schemas/Create_hk_liquidator_appoint" }, { "$ref": "#/components/schemas/Create_hk_liquidator_cease" }, { "$ref": "#/components/schemas/Create_hk_liquidator_change" }, { "$ref": "#/components/schemas/Create_hk_lpf_deregister" }, { "$ref": "#/components/schemas/Create_hk_lpf_dissolution_notify" }, { "$ref": "#/components/schemas/Create_hk_members_voluntary_winding_up_commence" }, { "$ref": "#/components/schemas/Create_hk_mortgagee_possession_entry_notify" }, { "$ref": "#/components/schemas/Create_hk_mortgagee_possession_exit_notify" }, { "$ref": "#/components/schemas/Create_hk_non_hk_company_liquidation_notify" }, { "$ref": "#/components/schemas/Create_hk_nonhk_company_dissolution_notify" }, { "$ref": "#/components/schemas/Create_hk_nonhk_company_liquidation_change" }, { "$ref": "#/components/schemas/Create_hk_nonhk_company_liquidation_commencement_notify" }, { "$ref": "#/components/schemas/Create_hk_nonhk_company_liquidation_liquidator_appointment_notify" }, { "$ref": "#/components/schemas/Create_hk_nonhk_company_liquidation_liquidator_cessation_notify" }, { "$ref": "#/components/schemas/Create_hk_place_of_business_cease" }, { "$ref": "#/components/schemas/Create_hk_receiver_appoint" }, { "$ref": "#/components/schemas/Create_hk_receiver_cease" }, { "$ref": "#/components/schemas/Create_hk_receiver_change" }, { "$ref": "#/components/schemas/Create_hk_receiver_abstract_of_accounts_file" }, { "$ref": "#/components/schemas/Create_hk_receiver_statement_of_affairs_file" }, { "$ref": "#/components/schemas/Create_hk_registrar_representation_request" }, { "$ref": "#/components/schemas/Create_hk_restored_company_name_change" }, { "$ref": "#/components/schemas/Create_hk_society_dissolution_notify" }, { "$ref": "#/components/schemas/Create_hk_strike_off_notice_respond" }, { "$ref": "#/components/schemas/Create_hk_winding_up_release_certify" }, { "$ref": "#/components/schemas/Create_sg_business_register" }, { "$ref": "#/components/schemas/Create_sg_business_name_register" }, { "$ref": "#/components/schemas/Create_sg_business_name_renew" }, { "$ref": "#/components/schemas/Create_sg_business_trust_register" }, { "$ref": "#/components/schemas/Create_sg_charity_register" }, { "$ref": "#/components/schemas/Create_sg_company_incorporate" }, { "$ref": "#/components/schemas/Create_sg_cooperative_society_register" }, { "$ref": "#/components/schemas/Create_sg_corppass_form" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_register" }, { "$ref": "#/components/schemas/Create_sg_gst_register" }, { "$ref": "#/components/schemas/Create_sg_ipc_apply" }, { "$ref": "#/components/schemas/Create_sg_limited_partnership_register" }, { "$ref": "#/components/schemas/Create_sg_llp_register" }, { "$ref": "#/components/schemas/Create_sg_name_reserve" }, { "$ref": "#/components/schemas/Create_sg_registered_office_provide" }, { "$ref": "#/components/schemas/Create_sg_registered_office_release" }, { "$ref": "#/components/schemas/Create_sg_registers_form" }, { "$ref": "#/components/schemas/Create_sg_representative_office_register" }, { "$ref": "#/components/schemas/Create_sg_society_register" }, { "$ref": "#/components/schemas/Create_sg_vcc_incorporate" }, { "$ref": "#/components/schemas/Create_sg_vcc_eligible_fi_engage" }, { "$ref": "#/components/schemas/Create_sg_vcc_fund_manager_appoint" }, { "$ref": "#/components/schemas/Create_sg_vcc_sub_fund_register" }, { "$ref": "#/components/schemas/Create_sg_accounting_standards_exemption_apply" }, { "$ref": "#/components/schemas/Create_sg_acra_document_legalise" }, { "$ref": "#/components/schemas/Create_sg_acra_information_product_request" }, { "$ref": "#/components/schemas/Create_sg_agm_hold" }, { "$ref": "#/components/schemas/Create_sg_agm_waive" }, { "$ref": "#/components/schemas/Create_sg_agm_financial_statements_notify" }, { "$ref": "#/components/schemas/Create_sg_annual_return_file" }, { "$ref": "#/components/schemas/Create_sg_audit_engage" }, { "$ref": "#/components/schemas/Create_sg_audit_exemption_apply" }, { "$ref": "#/components/schemas/Create_sg_business_registration_renew" }, { "$ref": "#/components/schemas/Create_sg_charity_annual_submission_file" }, { "$ref": "#/components/schemas/Create_sg_climate_assurance_engage" }, { "$ref": "#/components/schemas/Create_sg_climate_disclosure_file" }, { "$ref": "#/components/schemas/Create_sg_controller_notice_notify" }, { "$ref": "#/components/schemas/Create_sg_coop_annual_report_file" }, { "$ref": "#/components/schemas/Create_sg_coop_contribution_election_file" }, { "$ref": "#/components/schemas/Create_sg_coop_fund_contribution_pay" }, { "$ref": "#/components/schemas/Create_sg_coop_wd1_return_file" }, { "$ref": "#/components/schemas/Create_sg_coop_wd1a_return_file" }, { "$ref": "#/components/schemas/Create_sg_corporate_document_legalise_apostille" }, { "$ref": "#/components/schemas/Create_sg_corporate_tax_return_file" }, { "$ref": "#/components/schemas/Create_sg_employee_earnings_form_issue" }, { "$ref": "#/components/schemas/Create_sg_employment_income_amend" }, { "$ref": "#/components/schemas/Create_sg_employment_income_file" }, { "$ref": "#/components/schemas/Create_sg_estimated_chargeable_income_file" }, { "$ref": "#/components/schemas/Create_sg_estimated_chargeable_income_waive" }, { "$ref": "#/components/schemas/Create_sg_extension_of_time_apply" }, { "$ref": "#/components/schemas/Create_sg_financial_statements_file" }, { "$ref": "#/components/schemas/Create_sg_financial_statements_prepare" }, { "$ref": "#/components/schemas/Create_sg_financial_statements_relief_apply" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_annual_return_file" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_branch_waiver_apply" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_filing_extension_apply" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_filing_relief_apply" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_fs_relief_apply" }, { "$ref": "#/components/schemas/Create_sg_gst_filing_extension_request" }, { "$ref": "#/components/schemas/Create_sg_gst_return_file" }, { "$ref": "#/components/schemas/Create_sg_gst_return_rectify" }, { "$ref": "#/components/schemas/Create_sg_ipc_donation_return_file" }, { "$ref": "#/components/schemas/Create_sg_llp_annual_declaration_file" }, { "$ref": "#/components/schemas/Create_sg_llp_annual_declaration_extension_apply" }, { "$ref": "#/components/schemas/Create_sg_nominee_register_change" }, { "$ref": "#/components/schemas/Create_sg_partnership_partner_cessation_notify" }, { "$ref": "#/components/schemas/Create_sg_partnership_tax_return_file" }, { "$ref": "#/components/schemas/Create_sg_register_exemption_declare" }, { "$ref": "#/components/schemas/Create_sg_registrable_controller_change" }, { "$ref": "#/components/schemas/Create_sg_representative_office_declaration_file" }, { "$ref": "#/components/schemas/Create_sg_representative_office_licence_extend" }, { "$ref": "#/components/schemas/Create_sg_revised_financial_statements_file" }, { "$ref": "#/components/schemas/Create_sg_society_annual_return_file" }, { "$ref": "#/components/schemas/Create_sg_society_certified_copy_request" }, { "$ref": "#/components/schemas/Create_sg_society_document_repurchase" }, { "$ref": "#/components/schemas/Create_sg_vcc_annual_return_file" }, { "$ref": "#/components/schemas/Create_sg_xbrl_exemption_apply" }, { "$ref": "#/components/schemas/Create_sg_cooperative_agm_hold" }, { "$ref": "#/components/schemas/Create_sg_cooperative_agm_return_file" }, { "$ref": "#/components/schemas/Create_sg_cooperative_annual_report_file" }, { "$ref": "#/components/schemas/Create_sg_cooperative_office_bearers_change" }, { "$ref": "#/components/schemas/Create_sg_directors_resolution_record" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_member_register_change" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_member_register_location_change" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_nominee_register_change" }, { "$ref": "#/components/schemas/Create_sg_holding_company_minutes_file" }, { "$ref": "#/components/schemas/Create_sg_llp_partners_resolution_record" }, { "$ref": "#/components/schemas/Create_sg_meeting_minutes_record" }, { "$ref": "#/components/schemas/Create_sg_members_resolution_record" }, { "$ref": "#/components/schemas/Create_sg_ordinary_resolution_file" }, { "$ref": "#/components/schemas/Create_sg_special_resolution_file" }, { "$ref": "#/components/schemas/Create_sg_auditor_appoint" }, { "$ref": "#/components/schemas/Create_sg_auditor_withdraw" }, { "$ref": "#/components/schemas/Create_sg_auditor_resignation_consent_request" }, { "$ref": "#/components/schemas/Create_sg_business_details_change" }, { "$ref": "#/components/schemas/Create_sg_business_position_holder_appoint" }, { "$ref": "#/components/schemas/Create_sg_business_position_holder_withdraw" }, { "$ref": "#/components/schemas/Create_sg_ceo_appoint" }, { "$ref": "#/components/schemas/Create_sg_ceo_withdraw" }, { "$ref": "#/components/schemas/Create_sg_director_appoint" }, { "$ref": "#/components/schemas/Create_sg_director_change" }, { "$ref": "#/components/schemas/Create_sg_director_withdraw" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_position_holder_appoint" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_position_holder_withdraw" }, { "$ref": "#/components/schemas/Create_sg_manager_appoint" }, { "$ref": "#/components/schemas/Create_sg_manager_withdraw" }, { "$ref": "#/components/schemas/Create_sg_nominee_director_appoint" }, { "$ref": "#/components/schemas/Create_sg_partner_appoint" }, { "$ref": "#/components/schemas/Create_sg_partner_withdraw" }, { "$ref": "#/components/schemas/Create_sg_position_holder_cease" }, { "$ref": "#/components/schemas/Create_sg_position_holder_change" }, { "$ref": "#/components/schemas/Create_sg_qualified_secretary_appoint" }, { "$ref": "#/components/schemas/Create_sg_secretary_appoint" }, { "$ref": "#/components/schemas/Create_sg_secretary_withdraw" }, { "$ref": "#/components/schemas/Create_sg_society_committee_change" }, { "$ref": "#/components/schemas/Create_sg_charge_register" }, { "$ref": "#/components/schemas/Create_sg_financial_assistance_file" }, { "$ref": "#/components/schemas/Create_sg_notice_of_compliance_file" }, { "$ref": "#/components/schemas/Create_sg_preference_share_redeem" }, { "$ref": "#/components/schemas/Create_sg_prospectus_register" }, { "$ref": "#/components/schemas/Create_sg_share_allot" }, { "$ref": "#/components/schemas/Create_sg_share_convert" }, { "$ref": "#/components/schemas/Create_sg_share_repurchase" }, { "$ref": "#/components/schemas/Create_sg_share_transfer" }, { "$ref": "#/components/schemas/Create_sg_share_capital_change" }, { "$ref": "#/components/schemas/Create_sg_share_capital_redenominate" }, { "$ref": "#/components/schemas/Create_sg_share_capital_reduce" }, { "$ref": "#/components/schemas/Create_sg_share_capital_paid_up_change" }, { "$ref": "#/components/schemas/Create_sg_treasury_share_cancel" }, { "$ref": "#/components/schemas/Create_sg_charge_change" }, { "$ref": "#/components/schemas/Create_sg_charge_satisfy" }, { "$ref": "#/components/schemas/Create_sg_company_name_change" }, { "$ref": "#/components/schemas/Create_sg_company_name_waive_limited" }, { "$ref": "#/components/schemas/Create_sg_constitution_amend" }, { "$ref": "#/components/schemas/Create_sg_constitution_amend_objects" }, { "$ref": "#/components/schemas/Create_sg_constitution_consent_request" }, { "$ref": "#/components/schemas/Create_sg_cooperative_by_laws_amend" }, { "$ref": "#/components/schemas/Create_sg_entity_particulars_change" }, { "$ref": "#/components/schemas/Create_sg_financial_year_end_change" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_constitution_change" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_name_change" }, { "$ref": "#/components/schemas/Create_sg_llp_name_change" }, { "$ref": "#/components/schemas/Create_sg_notice_of_error_file" }, { "$ref": "#/components/schemas/Create_sg_registered_address_change" }, { "$ref": "#/components/schemas/Create_sg_society_address_change" }, { "$ref": "#/components/schemas/Create_sg_society_name_change" }, { "$ref": "#/components/schemas/Create_sg_society_rules_amend" }, { "$ref": "#/components/schemas/Create_sg_vcc_name_change" }, { "$ref": "#/components/schemas/Create_sg_company_continue_in" }, { "$ref": "#/components/schemas/Create_sg_company_continue_out" }, { "$ref": "#/components/schemas/Create_sg_company_convert_to_limited" }, { "$ref": "#/components/schemas/Create_sg_company_convert_to_private" }, { "$ref": "#/components/schemas/Create_sg_company_convert_to_public" }, { "$ref": "#/components/schemas/Create_sg_company_convert_to_unlimited" }, { "$ref": "#/components/schemas/Create_sg_company_merge" }, { "$ref": "#/components/schemas/Create_sg_company_merge_into_new" }, { "$ref": "#/components/schemas/Create_sg_cooperative_society_merge" }, { "$ref": "#/components/schemas/Create_sg_cooperative_society_transfer" }, { "$ref": "#/components/schemas/Create_sg_llp_convert_from_company" }, { "$ref": "#/components/schemas/Create_sg_llp_convert_from_partnership" }, { "$ref": "#/components/schemas/Create_sg_vcc_continue_in" }, { "$ref": "#/components/schemas/Create_sg_business_cease" }, { "$ref": "#/components/schemas/Create_sg_business_restore" }, { "$ref": "#/components/schemas/Create_sg_charity_deregister" }, { "$ref": "#/components/schemas/Create_sg_company_strike_off" }, { "$ref": "#/components/schemas/Create_sg_cooperative_society_wind_up" }, { "$ref": "#/components/schemas/Create_sg_court_restoration_apply" }, { "$ref": "#/components/schemas/Create_sg_creditors_meeting_notify" }, { "$ref": "#/components/schemas/Create_sg_creditors_winding_up_declare_inability" }, { "$ref": "#/components/schemas/Create_sg_dormant_status_apply" }, { "$ref": "#/components/schemas/Create_sg_dormant_tax_return_file" }, { "$ref": "#/components/schemas/Create_sg_dormant_tax_waiver_apply" }, { "$ref": "#/components/schemas/Create_sg_early_dissolution_notify" }, { "$ref": "#/components/schemas/Create_sg_entity_restore" }, { "$ref": "#/components/schemas/Create_sg_final_meeting_return_file" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_cease" }, { "$ref": "#/components/schemas/Create_sg_foreign_company_strike_off" }, { "$ref": "#/components/schemas/Create_sg_gst_final_return_file" }, { "$ref": "#/components/schemas/Create_sg_gst_registration_cancel" }, { "$ref": "#/components/schemas/Create_sg_liquidator_appoint" }, { "$ref": "#/components/schemas/Create_sg_liquidator_accounts_file" }, { "$ref": "#/components/schemas/Create_sg_llp_strike_off" }, { "$ref": "#/components/schemas/Create_sg_members_winding_up_declare_solvency" }, { "$ref": "#/components/schemas/Create_sg_representative_office_cancel" }, { "$ref": "#/components/schemas/Create_sg_restoration_order_file" }, { "$ref": "#/components/schemas/Create_sg_simplified_winding_up_pass" }, { "$ref": "#/components/schemas/Create_sg_simplified_winding_up_record" }, { "$ref": "#/components/schemas/Create_sg_society_dissolve" }, { "$ref": "#/components/schemas/Create_sg_strike_off_withdraw" }, { "$ref": "#/components/schemas/Create_sg_vcc_strike_off" }, { "$ref": "#/components/schemas/Create_sg_vcc_sub_fund_dissolve" }, { "$ref": "#/components/schemas/Create_sg_winding_up_pass" }, { "$ref": "#/components/schemas/Create_uk_acsp_register" }, { "$ref": "#/components/schemas/Create_uk_articles_adopt" }, { "$ref": "#/components/schemas/Create_uk_charity_register" }, { "$ref": "#/components/schemas/Create_uk_charity_interest_register" }, { "$ref": "#/components/schemas/Create_uk_charity_tax_recognition_apply" }, { "$ref": "#/components/schemas/Create_uk_cic_incorporate" }, { "$ref": "#/components/schemas/Create_uk_cio_register" }, { "$ref": "#/components/schemas/Create_uk_company_incorporate" }, { "$ref": "#/components/schemas/Create_uk_company_name_check" }, { "$ref": "#/components/schemas/Create_uk_corporation_tax_register" }, { "$ref": "#/components/schemas/Create_uk_existing_body_register" }, { "$ref": "#/components/schemas/Create_uk_general_partnership_register" }, { "$ref": "#/components/schemas/Create_uk_limited_partnership_register" }, { "$ref": "#/components/schemas/Create_uk_llp_incorporate" }, { "$ref": "#/components/schemas/Create_uk_overseas_entity_register" }, { "$ref": "#/components/schemas/Create_uk_partnership_agreement_adopt" }, { "$ref": "#/components/schemas/Create_uk_partnership_self_assessment_register" }, { "$ref": "#/components/schemas/Create_uk_paye_scheme_register" }, { "$ref": "#/components/schemas/Create_uk_private_fund_limited_partnership_register" }, { "$ref": "#/components/schemas/Create_uk_public_company_trading_certificate_apply" }, { "$ref": "#/components/schemas/Create_uk_register_of_members_form" }, { "$ref": "#/components/schemas/Create_uk_registered_society_register" }, { "$ref": "#/components/schemas/Create_uk_sail_notify" }, { "$ref": "#/components/schemas/Create_uk_scio_register" }, { "$ref": "#/components/schemas/Create_uk_scottish_qualifying_partnership_register" }, { "$ref": "#/components/schemas/Create_uk_vat_register" }, { "$ref": "#/components/schemas/Create_uk_accounting_records_record" }, { "$ref": "#/components/schemas/Create_uk_accounts_filing_extension_apply" }, { "$ref": "#/components/schemas/Create_uk_annual_accounts_file" }, { "$ref": "#/components/schemas/Create_uk_apostille_certify_and_legalise_document" }, { "$ref": "#/components/schemas/Create_uk_apostille_registry_document_request" }, { "$ref": "#/components/schemas/Create_uk_ccni_annual_monitoring_return_file" }, { "$ref": "#/components/schemas/Create_uk_certificate_of_incorporation_request" }, { "$ref": "#/components/schemas/Create_uk_certified_copy_request" }, { "$ref": "#/components/schemas/Create_uk_charity_commission_annual_return_file" }, { "$ref": "#/components/schemas/Create_uk_cic_report_file" }, { "$ref": "#/components/schemas/Create_uk_cio_annual_return_file" }, { "$ref": "#/components/schemas/Create_uk_confirmation_statement_file" }, { "$ref": "#/components/schemas/Create_uk_corporation_tax_pay" }, { "$ref": "#/components/schemas/Create_uk_corporation_tax_return_file" }, { "$ref": "#/components/schemas/Create_uk_data_protection_fee_pay" }, { "$ref": "#/components/schemas/Create_uk_dormant_accounts_file" }, { "$ref": "#/components/schemas/Create_uk_gender_pay_gap_file" }, { "$ref": "#/components/schemas/Create_uk_hmrc_dormancy_cease" }, { "$ref": "#/components/schemas/Create_uk_hmrc_dormancy_notify" }, { "$ref": "#/components/schemas/Create_uk_llp_annual_accounts_file" }, { "$ref": "#/components/schemas/Create_uk_llp_confirmation_statement_file" }, { "$ref": "#/components/schemas/Create_uk_lp_principal_place_of_business_change" }, { "$ref": "#/components/schemas/Create_uk_mail_handling_change" }, { "$ref": "#/components/schemas/Create_uk_oscr_annual_return_file" }, { "$ref": "#/components/schemas/Create_uk_overseas_company_accounts_file" }, { "$ref": "#/components/schemas/Create_uk_overseas_entity_change" }, { "$ref": "#/components/schemas/Create_uk_overseas_entity_address_change" }, { "$ref": "#/components/schemas/Create_uk_partnership_accounts_file" }, { "$ref": "#/components/schemas/Create_uk_partnership_tax_return_file" }, { "$ref": "#/components/schemas/Create_uk_pension_declaration_file" }, { "$ref": "#/components/schemas/Create_uk_plc_annual_accounts_file" }, { "$ref": "#/components/schemas/Create_uk_psc_cease" }, { "$ref": "#/components/schemas/Create_uk_psc_change" }, { "$ref": "#/components/schemas/Create_uk_psc_notify" }, { "$ref": "#/components/schemas/Create_uk_psc_notice_notify" }, { "$ref": "#/components/schemas/Create_uk_psc_statement_file" }, { "$ref": "#/components/schemas/Create_uk_psc_verification_provide" }, { "$ref": "#/components/schemas/Create_uk_psc_verification_extension_request" }, { "$ref": "#/components/schemas/Create_uk_registered_email_change" }, { "$ref": "#/components/schemas/Create_uk_registered_society_annual_return_file" }, { "$ref": "#/components/schemas/Create_uk_slp_confirmation_statement_file" }, { "$ref": "#/components/schemas/Create_uk_sqp_confirmation_statement_file" }, { "$ref": "#/components/schemas/Create_uk_sqp_psc_cease" }, { "$ref": "#/components/schemas/Create_uk_sqp_psc_change" }, { "$ref": "#/components/schemas/Create_uk_sqp_psc_notify" }, { "$ref": "#/components/schemas/Create_uk_sqp_psc_filing_rectify" }, { "$ref": "#/components/schemas/Create_uk_sqp_psc_statement_change" }, { "$ref": "#/components/schemas/Create_uk_sqp_psc_statement_notify" }, { "$ref": "#/components/schemas/Create_uk_sqp_registration_details_change" }, { "$ref": "#/components/schemas/Create_uk_subsidiary_audit_exemption_file" }, { "$ref": "#/components/schemas/Create_uk_uk_establishment_address_change" }, { "$ref": "#/components/schemas/Create_uk_uk_establishment_service_agent_change" }, { "$ref": "#/components/schemas/Create_uk_agm_hold" }, { "$ref": "#/components/schemas/Create_uk_board_meeting_record" }, { "$ref": "#/components/schemas/Create_uk_board_resolution_pass" }, { "$ref": "#/components/schemas/Create_uk_company_records_change" }, { "$ref": "#/components/schemas/Create_uk_dividend_declare" }, { "$ref": "#/components/schemas/Create_uk_general_meeting_hold" }, { "$ref": "#/components/schemas/Create_uk_general_meeting_record" }, { "$ref": "#/components/schemas/Create_uk_interests_register_record" }, { "$ref": "#/components/schemas/Create_uk_register_of_members_change" }, { "$ref": "#/components/schemas/Create_uk_resolution_file" }, { "$ref": "#/components/schemas/Create_uk_sail_register" }, { "$ref": "#/components/schemas/Create_uk_serious_loss_meeting_hold" }, { "$ref": "#/components/schemas/Create_uk_share_transfer_register" }, { "$ref": "#/components/schemas/Create_uk_written_resolution_pass" }, { "$ref": "#/components/schemas/Create_uk_auditor_appoint" }, { "$ref": "#/components/schemas/Create_uk_auditor_remove" }, { "$ref": "#/components/schemas/Create_uk_auditor_resign" }, { "$ref": "#/components/schemas/Create_uk_director_appoint" }, { "$ref": "#/components/schemas/Create_uk_director_remove" }, { "$ref": "#/components/schemas/Create_uk_disclosure_protection_apply" }, { "$ref": "#/components/schemas/Create_uk_limited_partnership_particulars_change" }, { "$ref": "#/components/schemas/Create_uk_limited_partnership_partner_change" }, { "$ref": "#/components/schemas/Create_uk_nominee_director_hold" }, { "$ref": "#/components/schemas/Create_uk_officer_remove" }, { "$ref": "#/components/schemas/Create_uk_officer_details_change" }, { "$ref": "#/components/schemas/Create_uk_officer_identity_verify" }, { "$ref": "#/components/schemas/Create_uk_overseas_company_officer_appoint" }, { "$ref": "#/components/schemas/Create_uk_overseas_company_officer_change" }, { "$ref": "#/components/schemas/Create_uk_overseas_company_verification_statement_file" }, { "$ref": "#/components/schemas/Create_uk_plc_secretary_appoint" }, { "$ref": "#/components/schemas/Create_uk_secretarial_service_engage" }, { "$ref": "#/components/schemas/Create_uk_secretary_appoint" }, { "$ref": "#/components/schemas/Create_uk_ukeig_documents_notify" }, { "$ref": "#/components/schemas/Create_uk_ukeig_manager_appoint" }, { "$ref": "#/components/schemas/Create_uk_ukeig_manager_change" }, { "$ref": "#/components/schemas/Create_uk_capital_payment_approve" }, { "$ref": "#/components/schemas/Create_uk_charge_register" }, { "$ref": "#/components/schemas/Create_uk_charge_release" }, { "$ref": "#/components/schemas/Create_uk_charge_satisfy" }, { "$ref": "#/components/schemas/Create_uk_class_name_assign" }, { "$ref": "#/components/schemas/Create_uk_class_rights_change" }, { "$ref": "#/components/schemas/Create_uk_emi_options_notify" }, { "$ref": "#/components/schemas/Create_uk_ers_return_file" }, { "$ref": "#/components/schemas/Create_uk_ers_scheme_register" }, { "$ref": "#/components/schemas/Create_uk_limited_partner_interest_assign" }, { "$ref": "#/components/schemas/Create_uk_llp_member_appoint" }, { "$ref": "#/components/schemas/Create_uk_llp_member_remove" }, { "$ref": "#/components/schemas/Create_uk_member_class_create" }, { "$ref": "#/components/schemas/Create_uk_own_shares_repurchase" }, { "$ref": "#/components/schemas/Create_uk_redeemable_shares_redeem" }, { "$ref": "#/components/schemas/Create_uk_seis_eis_advance_assurance_request" }, { "$ref": "#/components/schemas/Create_uk_seis_eis_compliance_statement_file" }, { "$ref": "#/components/schemas/Create_uk_share_allot" }, { "$ref": "#/components/schemas/Create_uk_share_transfer" }, { "$ref": "#/components/schemas/Create_uk_share_capital_consolidate" }, { "$ref": "#/components/schemas/Create_uk_share_capital_redenominate" }, { "$ref": "#/components/schemas/Create_uk_share_capital_reduce_court" }, { "$ref": "#/components/schemas/Create_uk_share_capital_reduce_solvency" }, { "$ref": "#/components/schemas/Create_uk_share_capital_subdivide" }, { "$ref": "#/components/schemas/Create_uk_share_option_exercise" }, { "$ref": "#/components/schemas/Create_uk_share_option_grant" }, { "$ref": "#/components/schemas/Create_uk_treasury_share_cancel" }, { "$ref": "#/components/schemas/Create_uk_treasury_share_transfer" }, { "$ref": "#/components/schemas/Create_uk_accounting_reference_date_change" }, { "$ref": "#/components/schemas/Create_uk_articles_amend" }, { "$ref": "#/components/schemas/Create_uk_charitable_company_articles_amend" }, { "$ref": "#/components/schemas/Create_uk_cic_asset_lock_body_change" }, { "$ref": "#/components/schemas/Create_uk_cic_objects_change" }, { "$ref": "#/components/schemas/Create_uk_cio_constitution_amend" }, { "$ref": "#/components/schemas/Create_uk_company_name_change" }, { "$ref": "#/components/schemas/Create_uk_disputed_address_change" }, { "$ref": "#/components/schemas/Create_uk_limited_suffix_exemption_apply" }, { "$ref": "#/components/schemas/Create_uk_llp_name_change" }, { "$ref": "#/components/schemas/Create_uk_overseas_company_name_change" }, { "$ref": "#/components/schemas/Create_uk_register_material_remove" }, { "$ref": "#/components/schemas/Create_uk_registered_office_change" }, { "$ref": "#/components/schemas/Create_uk_registered_office_situation_change" }, { "$ref": "#/components/schemas/Create_uk_registered_society_name_change" }, { "$ref": "#/components/schemas/Create_uk_registered_society_office_change" }, { "$ref": "#/components/schemas/Create_uk_registered_society_rules_amend" }, { "$ref": "#/components/schemas/Create_uk_replacement_document_file" }, { "$ref": "#/components/schemas/Create_uk_scio_constitution_amend" }, { "$ref": "#/components/schemas/Create_uk_second_filing_file" }, { "$ref": "#/components/schemas/Create_uk_administration_appoint" }, { "$ref": "#/components/schemas/Create_uk_charity_convert_to_cio" }, { "$ref": "#/components/schemas/Create_uk_charity_convert_to_scio" }, { "$ref": "#/components/schemas/Create_uk_cic_convert_to_charitable_company" }, { "$ref": "#/components/schemas/Create_uk_cic_convert_to_cio" }, { "$ref": "#/components/schemas/Create_uk_cic_convert_to_registered_society" }, { "$ref": "#/components/schemas/Create_uk_company_convert_to_cic" }, { "$ref": "#/components/schemas/Create_uk_company_convert_to_limited" }, { "$ref": "#/components/schemas/Create_uk_company_convert_to_private" }, { "$ref": "#/components/schemas/Create_uk_company_convert_to_public" }, { "$ref": "#/components/schemas/Create_uk_company_convert_to_registered_society" }, { "$ref": "#/components/schemas/Create_uk_company_convert_to_unlimited" }, { "$ref": "#/components/schemas/Create_uk_company_voluntary_arrangement_propose" }, { "$ref": "#/components/schemas/Create_uk_limited_partnership_designate_pflp" }, { "$ref": "#/components/schemas/Create_uk_moratorium_request" }, { "$ref": "#/components/schemas/Create_uk_mvl_reconstruction_implement" }, { "$ref": "#/components/schemas/Create_uk_public_company_merger_implement" }, { "$ref": "#/components/schemas/Create_uk_redomiciliation_request" }, { "$ref": "#/components/schemas/Create_uk_registered_society_convert_to_company" }, { "$ref": "#/components/schemas/Create_uk_registered_society_merge" }, { "$ref": "#/components/schemas/Create_uk_registered_society_transfer_engagements" }, { "$ref": "#/components/schemas/Create_uk_restructuring_plan_implement" }, { "$ref": "#/components/schemas/Create_uk_scheme_of_arrangement_implement" }, { "$ref": "#/components/schemas/Create_uk_societas_convert_to_plc" }, { "$ref": "#/components/schemas/Create_uk_societas_conversion_draft_terms_notify" }, { "$ref": "#/components/schemas/Create_uk_uk_establishment_register" }, { "$ref": "#/components/schemas/Create_uk_ukeig_alternative_name_register" }, { "$ref": "#/components/schemas/Create_uk_ukeig_establishment_register" }, { "$ref": "#/components/schemas/Create_uk_ukeig_establishment_change_notify" }, { "$ref": "#/components/schemas/Create_uk_administrative_restoration_apply" }, { "$ref": "#/components/schemas/Create_uk_charitable_company_close" }, { "$ref": "#/components/schemas/Create_uk_cio_dissolve" }, { "$ref": "#/components/schemas/Create_uk_compulsory_liquidation_petition" }, { "$ref": "#/components/schemas/Create_uk_court_restoration_apply" }, { "$ref": "#/components/schemas/Create_uk_court_restoration_order_register" }, { "$ref": "#/components/schemas/Create_uk_creditors_voluntary_liquidation_commence" }, { "$ref": "#/components/schemas/Create_uk_creditors_voluntary_liquidation_complete" }, { "$ref": "#/components/schemas/Create_uk_general_partnership_dissolve" }, { "$ref": "#/components/schemas/Create_uk_limited_partnership_dissolve" }, { "$ref": "#/components/schemas/Create_uk_members_voluntary_liquidation_commence" }, { "$ref": "#/components/schemas/Create_uk_members_voluntary_liquidation_complete" }, { "$ref": "#/components/schemas/Create_uk_members_voluntary_liquidation_file" }, { "$ref": "#/components/schemas/Create_uk_overseas_entity_remove" }, { "$ref": "#/components/schemas/Create_uk_paye_scheme_close" }, { "$ref": "#/components/schemas/Create_uk_registered_society_cancel" }, { "$ref": "#/components/schemas/Create_uk_registered_society_dissolve" }, { "$ref": "#/components/schemas/Create_uk_scio_dissolve" }, { "$ref": "#/components/schemas/Create_uk_scottish_qualifying_partnership_cease" }, { "$ref": "#/components/schemas/Create_uk_strike_off_apply" }, { "$ref": "#/components/schemas/Create_uk_strike_off_withdraw" }, { "$ref": "#/components/schemas/Create_uk_uk_establishment_close" }, { "$ref": "#/components/schemas/Create_uk_vat_registration_cancel" }, { "$ref": "#/components/schemas/Create_ky_building_society_incorporate" }, { "$ref": "#/components/schemas/Create_ky_cooperative_society_register" }, { "$ref": "#/components/schemas/Create_ky_ein_apply" }, { "$ref": "#/components/schemas/Create_ky_elp_register" }, { "$ref": "#/components/schemas/Create_ky_exempted_company_incorporate" }, { "$ref": "#/components/schemas/Create_ky_exempted_ldc_convert" }, { "$ref": "#/components/schemas/Create_ky_exempted_ldc_incorporate" }, { "$ref": "#/components/schemas/Create_ky_exempted_spc_convert" }, { "$ref": "#/components/schemas/Create_ky_exempted_spc_incorporate" }, { "$ref": "#/components/schemas/Create_ky_exempted_trust_register" }, { "$ref": "#/components/schemas/Create_ky_exempted_trust_draft_file" }, { "$ref": "#/components/schemas/Create_ky_fit_and_proper_determination_request" }, { "$ref": "#/components/schemas/Create_ky_foreign_company_register" }, { "$ref": "#/components/schemas/Create_ky_foreign_lp_register" }, { "$ref": "#/components/schemas/Create_ky_foundation_company_convert" }, { "$ref": "#/components/schemas/Create_ky_foundation_company_incorporate" }, { "$ref": "#/components/schemas/Create_ky_friendly_society_register" }, { "$ref": "#/components/schemas/Create_ky_general_partnership_form" }, { "$ref": "#/components/schemas/Create_ky_llc_register" }, { "$ref": "#/components/schemas/Create_ky_llc_partnership_name_reserve" }, { "$ref": "#/components/schemas/Create_ky_llp_register" }, { "$ref": "#/components/schemas/Create_ky_local_companies_control_licence_apply" }, { "$ref": "#/components/schemas/Create_ky_lp_register" }, { "$ref": "#/components/schemas/Create_ky_mutual_fund_register" }, { "$ref": "#/components/schemas/Create_ky_name_reserve" }, { "$ref": "#/components/schemas/Create_ky_npo_register" }, { "$ref": "#/components/schemas/Create_ky_ordinary_nonresident_company_incorporate" }, { "$ref": "#/components/schemas/Create_ky_ordinary_resident_company_incorporate" }, { "$ref": "#/components/schemas/Create_ky_private_fund_register" }, { "$ref": "#/components/schemas/Create_ky_private_trust_company_register" }, { "$ref": "#/components/schemas/Create_ky_registered_office_notify" }, { "$ref": "#/components/schemas/Create_ky_registered_office_provide" }, { "$ref": "#/components/schemas/Create_ky_section_80_company_designate" }, { "$ref": "#/components/schemas/Create_ky_section_80_company_incorporate" }, { "$ref": "#/components/schemas/Create_ky_sez_trade_certificate_amend" }, { "$ref": "#/components/schemas/Create_ky_sez_trade_certificate_apply" }, { "$ref": "#/components/schemas/Create_ky_sezc_convert" }, { "$ref": "#/components/schemas/Create_ky_sezc_register" }, { "$ref": "#/components/schemas/Create_ky_siba_registered_person_register" }, { "$ref": "#/components/schemas/Create_ky_tax_undertaking_apply" }, { "$ref": "#/components/schemas/Create_ky_trade_and_business_licence_apply" }, { "$ref": "#/components/schemas/Create_ky_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_beneficial_ownership_change" }, { "$ref": "#/components/schemas/Create_ky_beneficial_ownership_file" }, { "$ref": "#/components/schemas/Create_ky_beneficial_ownership_alternative_route_confirm" }, { "$ref": "#/components/schemas/Create_ky_books_location_file" }, { "$ref": "#/components/schemas/Create_ky_building_society_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_building_society_annual_statement_file" }, { "$ref": "#/components/schemas/Create_ky_building_society_regulatory_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_cbc_notification_file" }, { "$ref": "#/components/schemas/Create_ky_cbc_report_file" }, { "$ref": "#/components/schemas/Create_ky_cima_society_accounts_file" }, { "$ref": "#/components/schemas/Create_ky_cooperative_society_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_cooperative_society_audit_file" }, { "$ref": "#/components/schemas/Create_ky_cooperative_society_audit_prepare" }, { "$ref": "#/components/schemas/Create_ky_crs_compliance_form_file" }, { "$ref": "#/components/schemas/Create_ky_crs_return_file" }, { "$ref": "#/components/schemas/Create_ky_economic_substance_notify" }, { "$ref": "#/components/schemas/Create_ky_economic_substance_return_file" }, { "$ref": "#/components/schemas/Create_ky_economic_substance_tro_file" }, { "$ref": "#/components/schemas/Create_ky_elp_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_fatca_crs_register" }, { "$ref": "#/components/schemas/Create_ky_fatca_return_file" }, { "$ref": "#/components/schemas/Create_ky_foreign_company_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_foreign_lp_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_friendly_society_mortality_return_file" }, { "$ref": "#/components/schemas/Create_ky_friendly_society_sickness_mortality_return_file" }, { "$ref": "#/components/schemas/Create_ky_friendly_society_statement_file" }, { "$ref": "#/components/schemas/Create_ky_fund_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_llc_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_llp_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_llp_provisional_declaration_file" }, { "$ref": "#/components/schemas/Create_ky_lp_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_mail_handling_change" }, { "$ref": "#/components/schemas/Create_ky_mail_item_forward" }, { "$ref": "#/components/schemas/Create_ky_npo_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_npo_filing_extension_request" }, { "$ref": "#/components/schemas/Create_ky_npo_financial_statements_review_report_file" }, { "$ref": "#/components/schemas/Create_ky_npo_review_report_file" }, { "$ref": "#/components/schemas/Create_ky_ordinary_company_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_principal_point_of_contact_appoint" }, { "$ref": "#/components/schemas/Create_ky_ptc_annual_declaration_file" }, { "$ref": "#/components/schemas/Create_ky_section_80_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_sez_trade_certificate_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_sez_trade_certificate_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_sezc_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_siba_annual_declaration_file" }, { "$ref": "#/components/schemas/Create_ky_siba_registration_deregister" }, { "$ref": "#/components/schemas/Create_ky_spc_annual_return_file" }, { "$ref": "#/components/schemas/Create_ky_trust_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_ky_annual_general_meeting_hold" }, { "$ref": "#/components/schemas/Create_ky_apostille_request" }, { "$ref": "#/components/schemas/Create_ky_board_meeting_record" }, { "$ref": "#/components/schemas/Create_ky_board_resolution_pass" }, { "$ref": "#/components/schemas/Create_ky_branch_register_change" }, { "$ref": "#/components/schemas/Create_ky_branch_register_continue_out" }, { "$ref": "#/components/schemas/Create_ky_branch_register_open" }, { "$ref": "#/components/schemas/Create_ky_certified_copy_request" }, { "$ref": "#/components/schemas/Create_ky_charge_record" }, { "$ref": "#/components/schemas/Create_ky_charge_release" }, { "$ref": "#/components/schemas/Create_ky_distribution_declare" }, { "$ref": "#/components/schemas/Create_ky_dividend_declare" }, { "$ref": "#/components/schemas/Create_ky_document_authentication_request" }, { "$ref": "#/components/schemas/Create_ky_general_meeting_hold" }, { "$ref": "#/components/schemas/Create_ky_good_standing_certificate_request" }, { "$ref": "#/components/schemas/Create_ky_member_resolution_pass" }, { "$ref": "#/components/schemas/Create_ky_registry_certificate_request" }, { "$ref": "#/components/schemas/Create_ky_registry_search_request" }, { "$ref": "#/components/schemas/Create_ky_special_resolution_file" }, { "$ref": "#/components/schemas/Create_ky_statutory_register_change" }, { "$ref": "#/components/schemas/Create_ky_aml_officers_designate" }, { "$ref": "#/components/schemas/Create_ky_director_appoint" }, { "$ref": "#/components/schemas/Create_ky_director_remove" }, { "$ref": "#/components/schemas/Create_ky_director_registration_apply" }, { "$ref": "#/components/schemas/Create_ky_director_registration_change" }, { "$ref": "#/components/schemas/Create_ky_director_registration_surrender" }, { "$ref": "#/components/schemas/Create_ky_foundation_secretary_change" }, { "$ref": "#/components/schemas/Create_ky_general_partner_appoint" }, { "$ref": "#/components/schemas/Create_ky_general_partner_remove" }, { "$ref": "#/components/schemas/Create_ky_llc_manager_appoint" }, { "$ref": "#/components/schemas/Create_ky_llc_manager_remove" }, { "$ref": "#/components/schemas/Create_ky_nominee_director_appoint" }, { "$ref": "#/components/schemas/Create_ky_register_of_directors_file" }, { "$ref": "#/components/schemas/Create_ky_register_of_managers_file" }, { "$ref": "#/components/schemas/Create_ky_secretary_appoint" }, { "$ref": "#/components/schemas/Create_ky_secretary_remove" }, { "$ref": "#/components/schemas/Create_ky_elp_interest_transfer" }, { "$ref": "#/components/schemas/Create_ky_llc_interest_transfer" }, { "$ref": "#/components/schemas/Create_ky_lp_interest_transfer" }, { "$ref": "#/components/schemas/Create_ky_minority_shares_acquire" }, { "$ref": "#/components/schemas/Create_ky_resident_company_share_transfer" }, { "$ref": "#/components/schemas/Create_ky_share_allot" }, { "$ref": "#/components/schemas/Create_ky_share_redeem" }, { "$ref": "#/components/schemas/Create_ky_share_transfer" }, { "$ref": "#/components/schemas/Create_ky_share_capital_change" }, { "$ref": "#/components/schemas/Create_ky_share_capital_increase" }, { "$ref": "#/components/schemas/Create_ky_share_capital_reduce" }, { "$ref": "#/components/schemas/Create_ky_share_capital_reduce_court" }, { "$ref": "#/components/schemas/Create_ky_treasury_share_dispose" }, { "$ref": "#/components/schemas/Create_ky_constitution_amend" }, { "$ref": "#/components/schemas/Create_ky_dual_foreign_name_change" }, { "$ref": "#/components/schemas/Create_ky_foreign_company_cease" }, { "$ref": "#/components/schemas/Create_ky_foreign_company_return_file" }, { "$ref": "#/components/schemas/Create_ky_foreign_lp_statement_file" }, { "$ref": "#/components/schemas/Create_ky_name_amend" }, { "$ref": "#/components/schemas/Create_ky_name_change" }, { "$ref": "#/components/schemas/Create_ky_npo_registration_amend" }, { "$ref": "#/components/schemas/Create_ky_npo_registration_cancel" }, { "$ref": "#/components/schemas/Create_ky_registered_office_amend" }, { "$ref": "#/components/schemas/Create_ky_registered_office_change" }, { "$ref": "#/components/schemas/Create_ky_registered_particulars_amend" }, { "$ref": "#/components/schemas/Create_ky_registry_error_rectify" }, { "$ref": "#/components/schemas/Create_ky_society_rules_amend" }, { "$ref": "#/components/schemas/Create_ky_building_society_merge" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_exempted" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_foundation_company" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_ldc" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_llc" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_ordinary_resident" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_sezc" }, { "$ref": "#/components/schemas/Create_ky_company_convert_to_spc" }, { "$ref": "#/components/schemas/Create_ky_company_merge" }, { "$ref": "#/components/schemas/Create_ky_continuation_in_apply" }, { "$ref": "#/components/schemas/Create_ky_continuation_out_apply" }, { "$ref": "#/components/schemas/Create_ky_elp_continue_out" }, { "$ref": "#/components/schemas/Create_ky_exempted_company_convert_resident" }, { "$ref": "#/components/schemas/Create_ky_foreign_partnership_convert_to_elp" }, { "$ref": "#/components/schemas/Create_ky_foundation_company_convert_exempted" }, { "$ref": "#/components/schemas/Create_ky_llc_continue_out" }, { "$ref": "#/components/schemas/Create_ky_llc_convert_exempted" }, { "$ref": "#/components/schemas/Create_ky_llc_merge" }, { "$ref": "#/components/schemas/Create_ky_llp_continue_in" }, { "$ref": "#/components/schemas/Create_ky_llp_continue_out" }, { "$ref": "#/components/schemas/Create_ky_llp_continue_out_complete" }, { "$ref": "#/components/schemas/Create_ky_lp_convert_to_elp" }, { "$ref": "#/components/schemas/Create_ky_partnership_convert_to_elp" }, { "$ref": "#/components/schemas/Create_ky_partnership_convert_to_llp" }, { "$ref": "#/components/schemas/Create_ky_provisional_registration_apply" }, { "$ref": "#/components/schemas/Create_ky_provisional_registration_complete" }, { "$ref": "#/components/schemas/Create_ky_provisional_registration_renew" }, { "$ref": "#/components/schemas/Create_ky_restructuring_officer_appoint" }, { "$ref": "#/components/schemas/Create_ky_scheme_of_arrangement_apply" }, { "$ref": "#/components/schemas/Create_ky_scheme_order_file" }, { "$ref": "#/components/schemas/Create_ky_cooperative_society_dissolve" }, { "$ref": "#/components/schemas/Create_ky_cooperative_society_dissolve_low_membership" }, { "$ref": "#/components/schemas/Create_ky_dormancy_assess" }, { "$ref": "#/components/schemas/Create_ky_exempted_trust_deregister" }, { "$ref": "#/components/schemas/Create_ky_foreign_registration_cease" }, { "$ref": "#/components/schemas/Create_ky_fund_deregister" }, { "$ref": "#/components/schemas/Create_ky_general_partnership_dissolve" }, { "$ref": "#/components/schemas/Create_ky_general_partnership_dissolve_by_court" }, { "$ref": "#/components/schemas/Create_ky_liquidation_annual_meeting_hold" }, { "$ref": "#/components/schemas/Create_ky_llc_restore" }, { "$ref": "#/components/schemas/Create_ky_lp_dissolution_file" }, { "$ref": "#/components/schemas/Create_ky_official_liquidation_petition" }, { "$ref": "#/components/schemas/Create_ky_partnership_restore" }, { "$ref": "#/components/schemas/Create_ky_partnership_dissolution_file" }, { "$ref": "#/components/schemas/Create_ky_partnership_registration_remove" }, { "$ref": "#/components/schemas/Create_ky_partnership_winding_up_commence" }, { "$ref": "#/components/schemas/Create_ky_restoration_apply" }, { "$ref": "#/components/schemas/Create_ky_strike_off_request" }, { "$ref": "#/components/schemas/Create_ky_supervision_order_apply" }, { "$ref": "#/components/schemas/Create_ky_voluntary_liquidation_commence" }, { "$ref": "#/components/schemas/Create_ky_voluntary_liquidation_complete" }, { "$ref": "#/components/schemas/Create_vg_authorised_representative_appoint" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_file" }, { "$ref": "#/components/schemas/Create_vg_company_incorporate" }, { "$ref": "#/components/schemas/Create_vg_company_name_reserve" }, { "$ref": "#/components/schemas/Create_vg_company_without_shares_incorporate" }, { "$ref": "#/components/schemas/Create_vg_director_appoint_first" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_register" }, { "$ref": "#/components/schemas/Create_vg_fund_recognise" }, { "$ref": "#/components/schemas/Create_vg_general_partnership_form" }, { "$ref": "#/components/schemas/Create_vg_incubator_or_approved_fund_apply" }, { "$ref": "#/components/schemas/Create_vg_insurer_spc_incorporate" }, { "$ref": "#/components/schemas/Create_vg_insurer_spc_register" }, { "$ref": "#/components/schemas/Create_vg_insurer_spc_approval_apply" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_register" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_name_reserve" }, { "$ref": "#/components/schemas/Create_vg_lp_beneficial_ownership_file" }, { "$ref": "#/components/schemas/Create_vg_lp_without_legal_personality_register" }, { "$ref": "#/components/schemas/Create_vg_mutual_fund_spc_incorporate" }, { "$ref": "#/components/schemas/Create_vg_mutual_fund_spc_register" }, { "$ref": "#/components/schemas/Create_vg_mutual_fund_spc_approval_apply" }, { "$ref": "#/components/schemas/Create_vg_npo_register" }, { "$ref": "#/components/schemas/Create_vg_private_investment_fund_recognise" }, { "$ref": "#/components/schemas/Create_vg_private_trust_company_incorporate" }, { "$ref": "#/components/schemas/Create_vg_register_of_directors_file" }, { "$ref": "#/components/schemas/Create_vg_register_of_members_file" }, { "$ref": "#/components/schemas/Create_vg_register_of_partners_file" }, { "$ref": "#/components/schemas/Create_vg_restricted_name_consent_apply" }, { "$ref": "#/components/schemas/Create_vg_restricted_name_consent_request" }, { "$ref": "#/components/schemas/Create_vg_restricted_purposes_company_incorporate" }, { "$ref": "#/components/schemas/Create_vg_segregated_portfolio_company_incorporate" }, { "$ref": "#/components/schemas/Create_vg_trade_licence_apply" }, { "$ref": "#/components/schemas/Create_vg_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_annual_return_file" }, { "$ref": "#/components/schemas/Create_vg_annual_return_extension_apply" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_change" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_request" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_access_decision_appeal" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_access_objection_file" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_copy_request" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_disclosure_exemption_apply" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_disclosure_opposition_apply" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_discrepancy_file" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_exemption_file" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_extract_request" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_objection_file" }, { "$ref": "#/components/schemas/Create_vg_beneficial_ownership_opposition_file" }, { "$ref": "#/components/schemas/Create_vg_bvifars_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_bvifars_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_certified_copy_request" }, { "$ref": "#/components/schemas/Create_vg_company_record_request" }, { "$ref": "#/components/schemas/Create_vg_director_annual_return_file" }, { "$ref": "#/components/schemas/Create_vg_directors_annual_return_file" }, { "$ref": "#/components/schemas/Create_vg_economic_substance_file" }, { "$ref": "#/components/schemas/Create_vg_economic_substance_financial_period_change" }, { "$ref": "#/components/schemas/Create_vg_economic_substance_period_change" }, { "$ref": "#/components/schemas/Create_vg_fatca_crs_enrol" }, { "$ref": "#/components/schemas/Create_vg_fatca_crs_file" }, { "$ref": "#/components/schemas/Create_vg_fatca_crs_enrolment_change" }, { "$ref": "#/components/schemas/Create_vg_fatca_crs_enrolment_deactivate" }, { "$ref": "#/components/schemas/Create_vg_financial_statements_file" }, { "$ref": "#/components/schemas/Create_vg_financial_statements_extension_request" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_annual_return_file" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_registered_agent_appoint" }, { "$ref": "#/components/schemas/Create_vg_fund_audit_exemption_apply" }, { "$ref": "#/components/schemas/Create_vg_fund_financial_statements_file" }, { "$ref": "#/components/schemas/Create_vg_fund_financial_statements_deadline_extend" }, { "$ref": "#/components/schemas/Create_vg_good_standing_certificate_request" }, { "$ref": "#/components/schemas/Create_vg_insurer_spc_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_annual_return_file" }, { "$ref": "#/components/schemas/Create_vg_lp_beneficial_ownership_change" }, { "$ref": "#/components/schemas/Create_vg_lp_certified_copy_request" }, { "$ref": "#/components/schemas/Create_vg_lp_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_lp_good_standing_certificate_request" }, { "$ref": "#/components/schemas/Create_vg_mutual_fund_spc_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_npo_renew" }, { "$ref": "#/components/schemas/Create_vg_npo_registration_renew" }, { "$ref": "#/components/schemas/Create_vg_npo_registration_restore" }, { "$ref": "#/components/schemas/Create_vg_registered_agent_appoint" }, { "$ref": "#/components/schemas/Create_vg_registrar_certificate_request" }, { "$ref": "#/components/schemas/Create_vg_registry_inspection_request" }, { "$ref": "#/components/schemas/Create_vg_spc_annual_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_spc_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_spc_insurer_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_spc_mutual_fund_fee_pay" }, { "$ref": "#/components/schemas/Create_vg_status_certificate_request" }, { "$ref": "#/components/schemas/Create_vg_transitional_filing_file" }, { "$ref": "#/components/schemas/Create_vg_transitional_registers_file" }, { "$ref": "#/components/schemas/Create_vg_common_seal_record" }, { "$ref": "#/components/schemas/Create_vg_directors_resolution_pass" }, { "$ref": "#/components/schemas/Create_vg_members_meeting_call" }, { "$ref": "#/components/schemas/Create_vg_members_resolution_pass" }, { "$ref": "#/components/schemas/Create_vg_minutes_record" }, { "$ref": "#/components/schemas/Create_vg_nominee_details_file" }, { "$ref": "#/components/schemas/Create_vg_records_location_change" }, { "$ref": "#/components/schemas/Create_vg_register_rectify" }, { "$ref": "#/components/schemas/Create_vg_register_change_notify" }, { "$ref": "#/components/schemas/Create_vg_alternate_director_appoint" }, { "$ref": "#/components/schemas/Create_vg_alternate_director_remove" }, { "$ref": "#/components/schemas/Create_vg_director_appoint" }, { "$ref": "#/components/schemas/Create_vg_director_cease" }, { "$ref": "#/components/schemas/Create_vg_director_change" }, { "$ref": "#/components/schemas/Create_vg_director_remove" }, { "$ref": "#/components/schemas/Create_vg_director_resign" }, { "$ref": "#/components/schemas/Create_vg_directors_list_request" }, { "$ref": "#/components/schemas/Create_vg_general_partner_admit" }, { "$ref": "#/components/schemas/Create_vg_general_partner_appoint" }, { "$ref": "#/components/schemas/Create_vg_general_partner_remove" }, { "$ref": "#/components/schemas/Create_vg_general_partner_withdraw" }, { "$ref": "#/components/schemas/Create_vg_general_partners_list_request" }, { "$ref": "#/components/schemas/Create_vg_licensed_director_appoint" }, { "$ref": "#/components/schemas/Create_vg_licensed_director_disclosure_change" }, { "$ref": "#/components/schemas/Create_vg_limited_partner_admit" }, { "$ref": "#/components/schemas/Create_vg_limited_partner_withdraw" }, { "$ref": "#/components/schemas/Create_vg_lp_particulars_change" }, { "$ref": "#/components/schemas/Create_vg_nominee_director_appoint" }, { "$ref": "#/components/schemas/Create_vg_nominee_director_change" }, { "$ref": "#/components/schemas/Create_vg_officer_appoint" }, { "$ref": "#/components/schemas/Create_vg_officer_remove" }, { "$ref": "#/components/schemas/Create_vg_partner_change" }, { "$ref": "#/components/schemas/Create_vg_reserve_director_cease" }, { "$ref": "#/components/schemas/Create_vg_reserve_director_nominate" }, { "$ref": "#/components/schemas/Create_vg_authorised_shares_change" }, { "$ref": "#/components/schemas/Create_vg_distribution_declare" }, { "$ref": "#/components/schemas/Create_vg_fair_value_appraisal_hold" }, { "$ref": "#/components/schemas/Create_vg_minority_partnership_interests_redeem" }, { "$ref": "#/components/schemas/Create_vg_minority_share_redeem" }, { "$ref": "#/components/schemas/Create_vg_minority_shares_redeem" }, { "$ref": "#/components/schemas/Create_vg_partnership_interest_redeem" }, { "$ref": "#/components/schemas/Create_vg_partnership_interest_transfer" }, { "$ref": "#/components/schemas/Create_vg_segregated_portfolio_create" }, { "$ref": "#/components/schemas/Create_vg_share_allot" }, { "$ref": "#/components/schemas/Create_vg_share_consolidate" }, { "$ref": "#/components/schemas/Create_vg_share_redeem" }, { "$ref": "#/components/schemas/Create_vg_share_repurchase" }, { "$ref": "#/components/schemas/Create_vg_share_subdivide" }, { "$ref": "#/components/schemas/Create_vg_share_transfer" }, { "$ref": "#/components/schemas/Create_vg_share_option_grant" }, { "$ref": "#/components/schemas/Create_vg_treasury_share_transfer" }, { "$ref": "#/components/schemas/Create_vg_apostille_request" }, { "$ref": "#/components/schemas/Create_vg_charge_change" }, { "$ref": "#/components/schemas/Create_vg_charge_register" }, { "$ref": "#/components/schemas/Create_vg_charge_satisfy" }, { "$ref": "#/components/schemas/Create_vg_company_name_change" }, { "$ref": "#/components/schemas/Create_vg_constitution_amend" }, { "$ref": "#/components/schemas/Create_vg_foreign_character_name_change" }, { "$ref": "#/components/schemas/Create_vg_foreign_character_name_deregister" }, { "$ref": "#/components/schemas/Create_vg_foreign_character_name_register" }, { "$ref": "#/components/schemas/Create_vg_foreign_character_name_remove" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_change" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_name_change" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_particulars_change" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_registered_agent_change" }, { "$ref": "#/components/schemas/Create_vg_lp_agreement_amend" }, { "$ref": "#/components/schemas/Create_vg_lp_charge_change" }, { "$ref": "#/components/schemas/Create_vg_lp_charge_register" }, { "$ref": "#/components/schemas/Create_vg_lp_charge_satisfy" }, { "$ref": "#/components/schemas/Create_vg_lp_name_change" }, { "$ref": "#/components/schemas/Create_vg_lp_registered_agent_change" }, { "$ref": "#/components/schemas/Create_vg_lp_registered_agent_resign" }, { "$ref": "#/components/schemas/Create_vg_lp_registered_agent_transfer_out" }, { "$ref": "#/components/schemas/Create_vg_lp_registered_agent_resignation_revoke" }, { "$ref": "#/components/schemas/Create_vg_lp_registered_office_change" }, { "$ref": "#/components/schemas/Create_vg_lp_registered_particulars_change" }, { "$ref": "#/components/schemas/Create_vg_name_change" }, { "$ref": "#/components/schemas/Create_vg_npo_change" }, { "$ref": "#/components/schemas/Create_vg_partnership_agreement_amend" }, { "$ref": "#/components/schemas/Create_vg_private_document_legalise" }, { "$ref": "#/components/schemas/Create_vg_public_document_legalise" }, { "$ref": "#/components/schemas/Create_vg_registered_agent_change" }, { "$ref": "#/components/schemas/Create_vg_registered_agent_resign" }, { "$ref": "#/components/schemas/Create_vg_registered_agent_transfer_out" }, { "$ref": "#/components/schemas/Create_vg_registered_agent_resignation_revoke" }, { "$ref": "#/components/schemas/Create_vg_registered_office_change" }, { "$ref": "#/components/schemas/Create_vg_segregated_portfolio_remove" }, { "$ref": "#/components/schemas/Create_vg_segregated_portfolio_restore" }, { "$ref": "#/components/schemas/Create_vg_spc_information_change" }, { "$ref": "#/components/schemas/Create_vg_spc_information_change_notify" }, { "$ref": "#/components/schemas/Create_vg_trade_licence_change" }, { "$ref": "#/components/schemas/Create_vg_asset_dispose" }, { "$ref": "#/components/schemas/Create_vg_company_consolidate" }, { "$ref": "#/components/schemas/Create_vg_company_continue_in" }, { "$ref": "#/components/schemas/Create_vg_company_continue_out" }, { "$ref": "#/components/schemas/Create_vg_company_convert_to_spc" }, { "$ref": "#/components/schemas/Create_vg_company_merge" }, { "$ref": "#/components/schemas/Create_vg_company_merge_into_foreign" }, { "$ref": "#/components/schemas/Create_vg_company_merge_out" }, { "$ref": "#/components/schemas/Create_vg_company_merge_with_subsidiary" }, { "$ref": "#/components/schemas/Create_vg_company_as_spc_register" }, { "$ref": "#/components/schemas/Create_vg_continuance_notice_file" }, { "$ref": "#/components/schemas/Create_vg_continuation_intention_withdraw" }, { "$ref": "#/components/schemas/Create_vg_continuation_notice_revoke" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_consolidate" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_continue_in" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_continue_out" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_convert" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_merge" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_merge_into_foreign" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_continuation_revoke" }, { "$ref": "#/components/schemas/Create_vg_lp_plan_of_arrangement_file" }, { "$ref": "#/components/schemas/Create_vg_lp_scheme_of_arrangement_file" }, { "$ref": "#/components/schemas/Create_vg_plan_of_arrangement_file" }, { "$ref": "#/components/schemas/Create_vg_scheme_of_arrangement_file" }, { "$ref": "#/components/schemas/Create_vg_company_restore" }, { "$ref": "#/components/schemas/Create_vg_company_restore_by_court" }, { "$ref": "#/components/schemas/Create_vg_company_wind_up_insolvent" }, { "$ref": "#/components/schemas/Create_vg_dormancy_record" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_deregister" }, { "$ref": "#/components/schemas/Create_vg_foreign_company_restore" }, { "$ref": "#/components/schemas/Create_vg_general_partnership_dissolve" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_restore" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_restore_by_court" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_strike_off" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_wind_up" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_wind_up_insolvent" }, { "$ref": "#/components/schemas/Create_vg_limited_partnership_insolvency_file" }, { "$ref": "#/components/schemas/Create_vg_liquidation_commence" }, { "$ref": "#/components/schemas/Create_vg_liquidation_complete" }, { "$ref": "#/components/schemas/Create_vg_liquidation_remove" }, { "$ref": "#/components/schemas/Create_vg_liquidation_insolvency_file" }, { "$ref": "#/components/schemas/Create_vg_liquidation_notice_publish" }, { "$ref": "#/components/schemas/Create_vg_strike_off_notice_respond" }, { "$ref": "#/components/schemas/Create_us_bank_account_package_prepare" }, { "$ref": "#/components/schemas/Create_us_bea_survey_file" }, { "$ref": "#/components/schemas/Create_us_board_consent_adopt" }, { "$ref": "#/components/schemas/Create_us_bylaws_adopt" }, { "$ref": "#/components/schemas/Create_us_cooperative_form" }, { "$ref": "#/components/schemas/Create_us_corporation_incorporate" }, { "$ref": "#/components/schemas/Create_us_ein_request" }, { "$ref": "#/components/schemas/Create_us_ein_foreign_party_request" }, { "$ref": "#/components/schemas/Create_us_entity_classification_elect" }, { "$ref": "#/components/schemas/Create_us_expedite_request" }, { "$ref": "#/components/schemas/Create_us_foundation_form" }, { "$ref": "#/components/schemas/Create_us_founder_stock_issue" }, { "$ref": "#/components/schemas/Create_us_general_partnership_register" }, { "$ref": "#/components/schemas/Create_us_incorporator_consent_adopt" }, { "$ref": "#/components/schemas/Create_us_itin_apply" }, { "$ref": "#/components/schemas/Create_us_llc_form" }, { "$ref": "#/components/schemas/Create_us_llp_register" }, { "$ref": "#/components/schemas/Create_us_lp_form" }, { "$ref": "#/components/schemas/Create_us_name_reserve" }, { "$ref": "#/components/schemas/Create_us_name_reservation_cancel" }, { "$ref": "#/components/schemas/Create_us_name_reservation_transfer" }, { "$ref": "#/components/schemas/Create_us_operating_agreement_adopt" }, { "$ref": "#/components/schemas/Create_us_partnership_agreement_adopt" }, { "$ref": "#/components/schemas/Create_us_partnership_authority_file" }, { "$ref": "#/components/schemas/Create_us_s_corp_election_file" }, { "$ref": "#/components/schemas/Create_us_section_83b_election_file" }, { "$ref": "#/components/schemas/Create_us_series_convert" }, { "$ref": "#/components/schemas/Create_us_series_register" }, { "$ref": "#/components/schemas/Create_us_state_business_licence_register" }, { "$ref": "#/components/schemas/Create_us_state_tax_register" }, { "$ref": "#/components/schemas/Create_us_statutory_trust_form" }, { "$ref": "#/components/schemas/Create_us_tax_exemption_apply" }, { "$ref": "#/components/schemas/Create_us_trade_name_assign" }, { "$ref": "#/components/schemas/Create_us_trade_name_cancel" }, { "$ref": "#/components/schemas/Create_us_trade_name_register" }, { "$ref": "#/components/schemas/Create_us_trade_name_renew" }, { "$ref": "#/components/schemas/Create_us_trust_agreement_adopt" }, { "$ref": "#/components/schemas/Create_us_unincorporated_association_form" }, { "$ref": "#/components/schemas/Create_us_annual_accounts_prepare" }, { "$ref": "#/components/schemas/Create_us_annual_list_file" }, { "$ref": "#/components/schemas/Create_us_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_annual_tax_pay" }, { "$ref": "#/components/schemas/Create_us_apostille_request" }, { "$ref": "#/components/schemas/Create_us_bea_quarterly_survey_file" }, { "$ref": "#/components/schemas/Create_us_boi_report_change" }, { "$ref": "#/components/schemas/Create_us_boi_report_file" }, { "$ref": "#/components/schemas/Create_us_certified_copy_request" }, { "$ref": "#/components/schemas/Create_us_commerce_tax_exemption_file" }, { "$ref": "#/components/schemas/Create_us_commerce_tax_return_file" }, { "$ref": "#/components/schemas/Create_us_exempt_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_exempt_postcard_file" }, { "$ref": "#/components/schemas/Create_us_exempt_return_file" }, { "$ref": "#/components/schemas/Create_us_exempt_return_extension_file" }, { "$ref": "#/components/schemas/Create_us_fbar_file" }, { "$ref": "#/components/schemas/Create_us_federal_return_file" }, { "$ref": "#/components/schemas/Create_us_federal_return_extension_file" }, { "$ref": "#/components/schemas/Create_us_financial_statements_file" }, { "$ref": "#/components/schemas/Create_us_foreign_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_form_1042_file" }, { "$ref": "#/components/schemas/Create_us_form_1099_file" }, { "$ref": "#/components/schemas/Create_us_form_1120f_file" }, { "$ref": "#/components/schemas/Create_us_form_5472_file" }, { "$ref": "#/components/schemas/Create_us_foundation_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_franchise_tax_pay" }, { "$ref": "#/components/schemas/Create_us_franchise_tax_installment_pay" }, { "$ref": "#/components/schemas/Create_us_franchise_tax_report_file" }, { "$ref": "#/components/schemas/Create_us_good_standing_request" }, { "$ref": "#/components/schemas/Create_us_irs_authorization_file" }, { "$ref": "#/components/schemas/Create_us_irs_authorization_revoke" }, { "$ref": "#/components/schemas/Create_us_llp_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_mail_scan" }, { "$ref": "#/components/schemas/Create_us_nonprofit_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_ny_llcta_disclosure_change" }, { "$ref": "#/components/schemas/Create_us_ny_llcta_disclosure_file" }, { "$ref": "#/components/schemas/Create_us_registered_agent_appoint" }, { "$ref": "#/components/schemas/Create_us_registered_agent_resign" }, { "$ref": "#/components/schemas/Create_us_service_of_process_forward" }, { "$ref": "#/components/schemas/Create_us_statutory_trust_annual_report_file" }, { "$ref": "#/components/schemas/Create_us_tax_return_extension_file" }, { "$ref": "#/components/schemas/Create_us_transparency_standards_adopt" }, { "$ref": "#/components/schemas/Create_us_transparency_standards_renew" }, { "$ref": "#/components/schemas/Create_us_transparency_standards_restore" }, { "$ref": "#/components/schemas/Create_us_unclaimed_property_file" }, { "$ref": "#/components/schemas/Create_us_annual_meeting_hold" }, { "$ref": "#/components/schemas/Create_us_benefit_report_file" }, { "$ref": "#/components/schemas/Create_us_board_resolution_adopt" }, { "$ref": "#/components/schemas/Create_us_bylaws_amend" }, { "$ref": "#/components/schemas/Create_us_defective_act_ratify" }, { "$ref": "#/components/schemas/Create_us_distribution_approve" }, { "$ref": "#/components/schemas/Create_us_dividend_declare" }, { "$ref": "#/components/schemas/Create_us_member_consent_adopt" }, { "$ref": "#/components/schemas/Create_us_minutes_record" }, { "$ref": "#/components/schemas/Create_us_operating_agreement_amend" }, { "$ref": "#/components/schemas/Create_us_register_change" }, { "$ref": "#/components/schemas/Create_us_stockholder_consent_adopt" }, { "$ref": "#/components/schemas/Create_us_director_appoint" }, { "$ref": "#/components/schemas/Create_us_director_remove" }, { "$ref": "#/components/schemas/Create_us_director_resign" }, { "$ref": "#/components/schemas/Create_us_incumbency_certificate_issue" }, { "$ref": "#/components/schemas/Create_us_irs_address_change" }, { "$ref": "#/components/schemas/Create_us_nominee_arrangement_declare" }, { "$ref": "#/components/schemas/Create_us_officer_appoint" }, { "$ref": "#/components/schemas/Create_us_officer_remove" }, { "$ref": "#/components/schemas/Create_us_officer_resign" }, { "$ref": "#/components/schemas/Create_us_responsible_party_change" }, { "$ref": "#/components/schemas/Create_us_secretary_certificate_issue" }, { "$ref": "#/components/schemas/Create_us_trustee_appoint" }, { "$ref": "#/components/schemas/Create_us_trustee_change" }, { "$ref": "#/components/schemas/Create_us_authorised_share_increase" }, { "$ref": "#/components/schemas/Create_us_authorised_share_reduce" }, { "$ref": "#/components/schemas/Create_us_blue_sky_notice_file" }, { "$ref": "#/components/schemas/Create_us_form_3921_file" }, { "$ref": "#/components/schemas/Create_us_form_d_file" }, { "$ref": "#/components/schemas/Create_us_option_grant" }, { "$ref": "#/components/schemas/Create_us_option_plan_adopt" }, { "$ref": "#/components/schemas/Create_us_preferred_series_change" }, { "$ref": "#/components/schemas/Create_us_preferred_series_designate" }, { "$ref": "#/components/schemas/Create_us_share_cancel" }, { "$ref": "#/components/schemas/Create_us_share_consolidate" }, { "$ref": "#/components/schemas/Create_us_share_issue" }, { "$ref": "#/components/schemas/Create_us_share_repurchase" }, { "$ref": "#/components/schemas/Create_us_share_subdivide" }, { "$ref": "#/components/schemas/Create_us_share_transfer" }, { "$ref": "#/components/schemas/Create_us_share_valuation_request" }, { "$ref": "#/components/schemas/Create_us_charter_amend" }, { "$ref": "#/components/schemas/Create_us_filing_rectify" }, { "$ref": "#/components/schemas/Create_us_llc_convert_to_dao" }, { "$ref": "#/components/schemas/Create_us_name_change" }, { "$ref": "#/components/schemas/Create_us_registered_agent_change" }, { "$ref": "#/components/schemas/Create_us_registered_office_change" }, { "$ref": "#/components/schemas/Create_us_smart_contract_identifier_admit" }, { "$ref": "#/components/schemas/Create_us_branch_register" }, { "$ref": "#/components/schemas/Create_us_entity_continue_in" }, { "$ref": "#/components/schemas/Create_us_entity_continue_out" }, { "$ref": "#/components/schemas/Create_us_entity_convert" }, { "$ref": "#/components/schemas/Create_us_entity_merge" }, { "$ref": "#/components/schemas/Create_us_entity_division_file" }, { "$ref": "#/components/schemas/Create_us_foreign_qualification_file" }, { "$ref": "#/components/schemas/Create_us_temporary_transfer_extend" }, { "$ref": "#/components/schemas/Create_us_temporary_transfer_file" }, { "$ref": "#/components/schemas/Create_us_temporary_transfer_withdraw" }, { "$ref": "#/components/schemas/Create_us_administrative_dissolution_record" }, { "$ref": "#/components/schemas/Create_us_corporation_dissolve" }, { "$ref": "#/components/schemas/Create_us_dissolution_revoke" }, { "$ref": "#/components/schemas/Create_us_ein_deactivate" }, { "$ref": "#/components/schemas/Create_us_entity_restore" }, { "$ref": "#/components/schemas/Create_us_final_payroll_return_file" }, { "$ref": "#/components/schemas/Create_us_final_return_file" }, { "$ref": "#/components/schemas/Create_us_foreign_qualification_withdraw" }, { "$ref": "#/components/schemas/Create_us_inactive_status_record" }, { "$ref": "#/components/schemas/Create_us_irs_dissolution_notify" }, { "$ref": "#/components/schemas/Create_us_llc_cancel" }, { "$ref": "#/components/schemas/Create_us_lp_cancel" }, { "$ref": "#/components/schemas/Create_us_statutory_trust_cancel" } ], "discriminator": { "propertyName": "type", "mapping": { "hk.business_branch.register": "#/components/schemas/Create_hk_business_branch_register", "hk.business_registration_particulars.notify": "#/components/schemas/Create_hk_business_registration_particulars_notify", "hk.company.incorporate": "#/components/schemas/Create_hk_company_incorporate", "hk.company_name.check": "#/components/schemas/Create_hk_company_name_check", "hk.company_name_approval.request": "#/components/schemas/Create_hk_company_name_approval_request", "hk.cooperative_society.register": "#/components/schemas/Create_hk_cooperative_society_register", "hk.first_director_consent.file": "#/components/schemas/Create_hk_first_director_consent_file", "hk.general_partnership.register": "#/components/schemas/Create_hk_general_partnership_register", "hk.guarantee_company.incorporate": "#/components/schemas/Create_hk_guarantee_company_incorporate", "hk.limited_partnership.register": "#/components/schemas/Create_hk_limited_partnership_register", "hk.limited_partnership_fund.register": "#/components/schemas/Create_hk_limited_partnership_fund_register", "hk.open_ended_fund_company.incorporate": "#/components/schemas/Create_hk_open_ended_fund_company_incorporate", "hk.registered_trustees.incorporate": "#/components/schemas/Create_hk_registered_trustees_incorporate", "hk.society.register": "#/components/schemas/Create_hk_society_register", "hk.society_exemption.apply": "#/components/schemas/Create_hk_society_exemption_apply", "hk.sole_proprietorship.register": "#/components/schemas/Create_hk_sole_proprietorship_register", "hk.tcsp_key_person.approve": "#/components/schemas/Create_hk_tcsp_key_person_approve", "hk.tcsp_licence.apply": "#/components/schemas/Create_hk_tcsp_licence_apply", "hk.tcsp_licence.cease": "#/components/schemas/Create_hk_tcsp_licence_cease", "hk.tcsp_licence.renew": "#/components/schemas/Create_hk_tcsp_licence_renew", "hk.tcsp_licence_annual_information.file": "#/components/schemas/Create_hk_tcsp_licence_annual_information_file", "hk.tcsp_licence_changes.notify": "#/components/schemas/Create_hk_tcsp_licence_changes_notify", "hk.trust_company.register": "#/components/schemas/Create_hk_trust_company_register", "hk.unlimited_company.incorporate": "#/components/schemas/Create_hk_unlimited_company_incorporate", "hk.accounting_records.record": "#/components/schemas/Create_hk_accounting_records_record", "hk.accounts_revision.notify": "#/components/schemas/Create_hk_accounts_revision_notify", "hk.annual_return.file": "#/components/schemas/Create_hk_annual_return_file", "hk.apostille_private_document.apply": "#/components/schemas/Create_hk_apostille_private_document_apply", "hk.apostille_public_document.apply": "#/components/schemas/Create_hk_apostille_public_document_apply", "hk.business_registration.renew": "#/components/schemas/Create_hk_business_registration_renew", "hk.business_registration_exemption.apply": "#/components/schemas/Create_hk_business_registration_exemption_apply", "hk.certificate_of_resident_status.apply": "#/components/schemas/Create_hk_certificate_of_resident_status_apply", "hk.certified_copy.request": "#/components/schemas/Create_hk_certified_copy_request", "hk.continuing_registration_certificate.request": "#/components/schemas/Create_hk_continuing_registration_certificate_request", "hk.designated_representative.appoint": "#/components/schemas/Create_hk_designated_representative_appoint", "hk.designated_representative.remove": "#/components/schemas/Create_hk_designated_representative_remove", "hk.employee_departure.notify": "#/components/schemas/Create_hk_employee_departure_notify", "hk.employee_hire.notify": "#/components/schemas/Create_hk_employee_hire_notify", "hk.employee_termination.notify": "#/components/schemas/Create_hk_employee_termination_notify", "hk.employer_return.file": "#/components/schemas/Create_hk_employer_return_file", "hk.financial_statements.approve": "#/components/schemas/Create_hk_financial_statements_approve", "hk.financial_statements.prepare": "#/components/schemas/Create_hk_financial_statements_prepare", "hk.financial_statements_revision.notify": "#/components/schemas/Create_hk_financial_statements_revision_notify", "hk.fsie_chargeability.notify": "#/components/schemas/Create_hk_fsie_chargeability_notify", "hk.fsie_economic_substance.file": "#/components/schemas/Create_hk_fsie_economic_substance_file", "hk.guarantee_company_annual_return.file": "#/components/schemas/Create_hk_guarantee_company_annual_return_file", "hk.letter_of_confirmation.request": "#/components/schemas/Create_hk_letter_of_confirmation_request", "hk.lpf_annual_return.file": "#/components/schemas/Create_hk_lpf_annual_return_file", "hk.lpf_registered_office.change": "#/components/schemas/Create_hk_lpf_registered_office_change", "hk.money_lender_changes.notify": "#/components/schemas/Create_hk_money_lender_changes_notify", "hk.money_lender_exemption.apply": "#/components/schemas/Create_hk_money_lender_exemption_apply", "hk.money_lender_licence.apply": "#/components/schemas/Create_hk_money_lender_licence_apply", "hk.money_lender_licence.renew": "#/components/schemas/Create_hk_money_lender_licence_renew", "hk.money_lender_third_party.notify": "#/components/schemas/Create_hk_money_lender_third_party_notify", "hk.profits_tax_chargeability_unincorporated.notify": "#/components/schemas/Create_hk_profits_tax_chargeability_unincorporated_notify", "hk.profits_tax_return.file": "#/components/schemas/Create_hk_profits_tax_return_file", "hk.profits_tax_return_unincorporated.file": "#/components/schemas/Create_hk_profits_tax_return_unincorporated_file", "hk.public_company_annual_return.file": "#/components/schemas/Create_hk_public_company_annual_return_file", "hk.registered_non_hk_company_annual_return.file": "#/components/schemas/Create_hk_registered_non_hk_company_annual_return_file", "hk.registry_search.request": "#/components/schemas/Create_hk_registry_search_request", "hk.significant_controllers_register.change": "#/components/schemas/Create_hk_significant_controllers_register_change", "hk.tax_exempt_charity.apply": "#/components/schemas/Create_hk_tax_exempt_charity_apply", "hk.top_up_tax_notification.file": "#/components/schemas/Create_hk_top_up_tax_notification_file", "hk.top_up_tax_return.file": "#/components/schemas/Create_hk_top_up_tax_return_file", "hk.agm.hold": "#/components/schemas/Create_hk_agm_hold", "hk.agm.waive": "#/components/schemas/Create_hk_agm_waive", "hk.agm_written_resolution.pass": "#/components/schemas/Create_hk_agm_written_resolution_pass", "hk.board_minutes.record": "#/components/schemas/Create_hk_board_minutes_record", "hk.board_resolution.pass": "#/components/schemas/Create_hk_board_resolution_pass", "hk.branch_register_debenture_holders.notify": "#/components/schemas/Create_hk_branch_register_debenture_holders_notify", "hk.branch_register_members.notify": "#/components/schemas/Create_hk_branch_register_members_notify", "hk.members_resolution.pass": "#/components/schemas/Create_hk_members_resolution_pass", "hk.ofc_registers_location.notify": "#/components/schemas/Create_hk_ofc_registers_location_notify", "hk.registers_location.notify": "#/components/schemas/Create_hk_registers_location_notify", "hk.specified_resolution.file": "#/components/schemas/Create_hk_specified_resolution_file", "hk.statutory_registers.change": "#/components/schemas/Create_hk_statutory_registers_change", "hk.statutory_registers.form": "#/components/schemas/Create_hk_statutory_registers_form", "hk.auditor.remove": "#/components/schemas/Create_hk_auditor_remove", "hk.auditor_resignation.notify": "#/components/schemas/Create_hk_auditor_resignation_notify", "hk.authorized_representative.remove": "#/components/schemas/Create_hk_authorized_representative_remove", "hk.company_secretary.appoint": "#/components/schemas/Create_hk_company_secretary_appoint", "hk.company_secretary.change": "#/components/schemas/Create_hk_company_secretary_change", "hk.company_secretary.remove": "#/components/schemas/Create_hk_company_secretary_remove", "hk.director.appoint": "#/components/schemas/Create_hk_director_appoint", "hk.lpf_general_partner.change": "#/components/schemas/Create_hk_lpf_general_partner_change", "hk.lpf_officer.change": "#/components/schemas/Create_hk_lpf_officer_change", "hk.nominee_director.appoint": "#/components/schemas/Create_hk_nominee_director_appoint", "hk.non_hk_company_officer.appoint": "#/components/schemas/Create_hk_non_hk_company_officer_appoint", "hk.non_hk_company_officer.cease": "#/components/schemas/Create_hk_non_hk_company_officer_cease", "hk.non_hk_company_officer.change": "#/components/schemas/Create_hk_non_hk_company_officer_change", "hk.ofc_custodian.appoint": "#/components/schemas/Create_hk_ofc_custodian_appoint", "hk.ofc_custodian.cease": "#/components/schemas/Create_hk_ofc_custodian_cease", "hk.ofc_director.appoint": "#/components/schemas/Create_hk_ofc_director_appoint", "hk.ofc_director.cease": "#/components/schemas/Create_hk_ofc_director_cease", "hk.ofc_director.change": "#/components/schemas/Create_hk_ofc_director_change", "hk.ofc_investment_manager.appoint": "#/components/schemas/Create_hk_ofc_investment_manager_appoint", "hk.ofc_investment_manager.cease": "#/components/schemas/Create_hk_ofc_investment_manager_cease", "hk.officer.change": "#/components/schemas/Create_hk_officer_change", "hk.officer.remove": "#/components/schemas/Create_hk_officer_remove", "hk.principal_office.change": "#/components/schemas/Create_hk_principal_office_change", "hk.protected_information.withhold": "#/components/schemas/Create_hk_protected_information_withhold", "hk.reserve_director.cease": "#/components/schemas/Create_hk_reserve_director_cease", "hk.reserve_director.change": "#/components/schemas/Create_hk_reserve_director_change", "hk.reserve_director.nominate": "#/components/schemas/Create_hk_reserve_director_nominate", "hk.reserve_director_resignation_notice.file": "#/components/schemas/Create_hk_reserve_director_resignation_notice_file", "hk.resignation_notice.file": "#/components/schemas/Create_hk_resignation_notice_file", "hk.trustee.appoint": "#/components/schemas/Create_hk_trustee_appoint", "hk.trustee.remove": "#/components/schemas/Create_hk_trustee_remove", "hk.charge.discharge": "#/components/schemas/Create_hk_charge_discharge", "hk.charge.register": "#/components/schemas/Create_hk_charge_register", "hk.charge_enforcement.notify": "#/components/schemas/Create_hk_charge_enforcement_notify", "hk.debenture.allot": "#/components/schemas/Create_hk_debenture_allot", "hk.limited_partnership.admit_partner": "#/components/schemas/Create_hk_limited_partnership_admit_partner", "hk.limited_partnership.assign_limited_partner_share": "#/components/schemas/Create_hk_limited_partnership_assign_limited_partner_share", "hk.limited_partnership.convert_partner_status": "#/components/schemas/Create_hk_limited_partnership_convert_partner_status", "hk.limited_partnership.resign_partner": "#/components/schemas/Create_hk_limited_partnership_resign_partner", "hk.members_increase.notify": "#/components/schemas/Create_hk_members_increase_notify", "hk.minority_shares.notify": "#/components/schemas/Create_hk_minority_shares_notify", "hk.share.allot": "#/components/schemas/Create_hk_share_allot", "hk.share.repurchase": "#/components/schemas/Create_hk_share_repurchase", "hk.share.repurchase_out_of_capital": "#/components/schemas/Create_hk_share_repurchase_out_of_capital", "hk.share.transfer": "#/components/schemas/Create_hk_share_transfer", "hk.share_capital.change": "#/components/schemas/Create_hk_share_capital_change", "hk.share_capital.reduce": "#/components/schemas/Create_hk_share_capital_reduce", "hk.share_class_rights.change": "#/components/schemas/Create_hk_share_class_rights_change", "hk.treasury_share.cancel": "#/components/schemas/Create_hk_treasury_share_cancel", "hk.treasury_share.transfer": "#/components/schemas/Create_hk_treasury_share_transfer", "hk.accounting_reference_date.change": "#/components/schemas/Create_hk_accounting_reference_date_change", "hk.articles.amend": "#/components/schemas/Create_hk_articles_amend", "hk.business_registration.change": "#/components/schemas/Create_hk_business_registration_change", "hk.business_registration_partners.change": "#/components/schemas/Create_hk_business_registration_partners_change", "hk.company_name.change": "#/components/schemas/Create_hk_company_name_change", "hk.company_name_licence.apply": "#/components/schemas/Create_hk_company_name_licence_apply", "hk.limited_partnership.amend": "#/components/schemas/Create_hk_limited_partnership_amend", "hk.lpf_address.change": "#/components/schemas/Create_hk_lpf_address_change", "hk.lpf_name.change": "#/components/schemas/Create_hk_lpf_name_change", "hk.memorandum_provisions.amend": "#/components/schemas/Create_hk_memorandum_provisions_amend", "hk.non_hk_company_address.change": "#/components/schemas/Create_hk_non_hk_company_address_change", "hk.non_hk_company_approved_name.file": "#/components/schemas/Create_hk_non_hk_company_approved_name_file", "hk.non_hk_company_constitution.amend": "#/components/schemas/Create_hk_non_hk_company_constitution_amend", "hk.non_hk_company_name.change": "#/components/schemas/Create_hk_non_hk_company_name_change", "hk.non_hk_company_place_of_incorporation.change": "#/components/schemas/Create_hk_non_hk_company_place_of_incorporation_change", "hk.objects.amend": "#/components/schemas/Create_hk_objects_amend", "hk.ofc_name.change": "#/components/schemas/Create_hk_ofc_name_change", "hk.ofc_registered_office.change": "#/components/schemas/Create_hk_ofc_registered_office_change", "hk.registered_document.rectify": "#/components/schemas/Create_hk_registered_document_rectify", "hk.registered_office.change": "#/components/schemas/Create_hk_registered_office_change", "hk.society_particulars.notify": "#/components/schemas/Create_hk_society_particulars_notify", "hk.branch.register": "#/components/schemas/Create_hk_branch_register", "hk.company.continue_in": "#/components/schemas/Create_hk_company_continue_in", "hk.company.merge": "#/components/schemas/Create_hk_company_merge", "hk.company_status.convert_to_private": "#/components/schemas/Create_hk_company_status_convert_to_private", "hk.company_status.convert_to_public": "#/components/schemas/Create_hk_company_status_convert_to_public", "hk.eligible_company.register": "#/components/schemas/Create_hk_eligible_company_register", "hk.limited_partnership_as_lpf.register": "#/components/schemas/Create_hk_limited_partnership_as_lpf_register", "hk.limited_partnership_fund.continue_in": "#/components/schemas/Create_hk_limited_partnership_fund_continue_in", "hk.non_hk_company.register": "#/components/schemas/Create_hk_non_hk_company_register", "hk.open_ended_fund_company.continue_in": "#/components/schemas/Create_hk_open_ended_fund_company_continue_in", "hk.place_of_incorporation.change": "#/components/schemas/Create_hk_place_of_incorporation_change", "hk.redomiciliation_charge.register": "#/components/schemas/Create_hk_redomiciliation_charge_register", "hk.redomiciliation_deregistration_evidence.file": "#/components/schemas/Create_hk_redomiciliation_deregistration_evidence_file", "hk.redomiciliation_deregistration_period.extend": "#/components/schemas/Create_hk_redomiciliation_deregistration_period_extend", "hk.redomiciliation_director_consent.file": "#/components/schemas/Create_hk_redomiciliation_director_consent_file", "hk.redomiciliation_members_return.file": "#/components/schemas/Create_hk_redomiciliation_members_return_file", "hk.scheme_of_arrangement.apply": "#/components/schemas/Create_hk_scheme_of_arrangement_apply", "hk.scheme_of_arrangement_order.register": "#/components/schemas/Create_hk_scheme_of_arrangement_order_register", "hk.unlimited_company.convert_to_limited": "#/components/schemas/Create_hk_unlimited_company_convert_to_limited", "hk.business_registration.cancel": "#/components/schemas/Create_hk_business_registration_cancel", "hk.company.deregister": "#/components/schemas/Create_hk_company_deregister", "hk.company.restore": "#/components/schemas/Create_hk_company_restore", "hk.company_restoration_court.apply": "#/components/schemas/Create_hk_company_restoration_court_apply", "hk.company_restoration_court_order.register": "#/components/schemas/Create_hk_company_restoration_court_order_register", "hk.court_winding_up.petition": "#/components/schemas/Create_hk_court_winding_up_petition", "hk.court_winding_up_statement_of_affairs.file": "#/components/schemas/Create_hk_court_winding_up_statement_of_affairs_file", "hk.creditors_voluntary_winding_up.commence": "#/components/schemas/Create_hk_creditors_voluntary_winding_up_commence", "hk.creditors_voluntary_winding_up.complete": "#/components/schemas/Create_hk_creditors_voluntary_winding_up_complete", "hk.directors_winding_up.commence": "#/components/schemas/Create_hk_directors_winding_up_commence", "hk.dormancy.cease": "#/components/schemas/Create_hk_dormancy_cease", "hk.dormancy.declare": "#/components/schemas/Create_hk_dormancy_declare", "hk.limited_partnership.wind_up": "#/components/schemas/Create_hk_limited_partnership_wind_up", "hk.liquidation_final_return.file": "#/components/schemas/Create_hk_liquidation_final_return_file", "hk.liquidator.appoint": "#/components/schemas/Create_hk_liquidator_appoint", "hk.liquidator.cease": "#/components/schemas/Create_hk_liquidator_cease", "hk.liquidator.change": "#/components/schemas/Create_hk_liquidator_change", "hk.lpf.deregister": "#/components/schemas/Create_hk_lpf_deregister", "hk.lpf_dissolution.notify": "#/components/schemas/Create_hk_lpf_dissolution_notify", "hk.members_voluntary_winding_up.commence": "#/components/schemas/Create_hk_members_voluntary_winding_up_commence", "hk.mortgagee_possession_entry.notify": "#/components/schemas/Create_hk_mortgagee_possession_entry_notify", "hk.mortgagee_possession_exit.notify": "#/components/schemas/Create_hk_mortgagee_possession_exit_notify", "hk.non_hk_company_liquidation.notify": "#/components/schemas/Create_hk_non_hk_company_liquidation_notify", "hk.nonhk_company_dissolution.notify": "#/components/schemas/Create_hk_nonhk_company_dissolution_notify", "hk.nonhk_company_liquidation.change": "#/components/schemas/Create_hk_nonhk_company_liquidation_change", "hk.nonhk_company_liquidation_commencement.notify": "#/components/schemas/Create_hk_nonhk_company_liquidation_commencement_notify", "hk.nonhk_company_liquidation_liquidator_appointment.notify": "#/components/schemas/Create_hk_nonhk_company_liquidation_liquidator_appointment_notify", "hk.nonhk_company_liquidation_liquidator_cessation.notify": "#/components/schemas/Create_hk_nonhk_company_liquidation_liquidator_cessation_notify", "hk.place_of_business.cease": "#/components/schemas/Create_hk_place_of_business_cease", "hk.receiver.appoint": "#/components/schemas/Create_hk_receiver_appoint", "hk.receiver.cease": "#/components/schemas/Create_hk_receiver_cease", "hk.receiver.change": "#/components/schemas/Create_hk_receiver_change", "hk.receiver_abstract_of_accounts.file": "#/components/schemas/Create_hk_receiver_abstract_of_accounts_file", "hk.receiver_statement_of_affairs.file": "#/components/schemas/Create_hk_receiver_statement_of_affairs_file", "hk.registrar_representation.request": "#/components/schemas/Create_hk_registrar_representation_request", "hk.restored_company_name.change": "#/components/schemas/Create_hk_restored_company_name_change", "hk.society_dissolution.notify": "#/components/schemas/Create_hk_society_dissolution_notify", "hk.strike_off_notice.respond": "#/components/schemas/Create_hk_strike_off_notice_respond", "hk.winding_up_release.certify": "#/components/schemas/Create_hk_winding_up_release_certify", "sg.business.register": "#/components/schemas/Create_sg_business_register", "sg.business_name.register": "#/components/schemas/Create_sg_business_name_register", "sg.business_name.renew": "#/components/schemas/Create_sg_business_name_renew", "sg.business_trust.register": "#/components/schemas/Create_sg_business_trust_register", "sg.charity.register": "#/components/schemas/Create_sg_charity_register", "sg.company.incorporate": "#/components/schemas/Create_sg_company_incorporate", "sg.cooperative_society.register": "#/components/schemas/Create_sg_cooperative_society_register", "sg.corppass.form": "#/components/schemas/Create_sg_corppass_form", "sg.foreign_company.register": "#/components/schemas/Create_sg_foreign_company_register", "sg.gst.register": "#/components/schemas/Create_sg_gst_register", "sg.ipc.apply": "#/components/schemas/Create_sg_ipc_apply", "sg.limited_partnership.register": "#/components/schemas/Create_sg_limited_partnership_register", "sg.llp.register": "#/components/schemas/Create_sg_llp_register", "sg.name.reserve": "#/components/schemas/Create_sg_name_reserve", "sg.registered_office.provide": "#/components/schemas/Create_sg_registered_office_provide", "sg.registered_office.release": "#/components/schemas/Create_sg_registered_office_release", "sg.registers.form": "#/components/schemas/Create_sg_registers_form", "sg.representative_office.register": "#/components/schemas/Create_sg_representative_office_register", "sg.society.register": "#/components/schemas/Create_sg_society_register", "sg.vcc.incorporate": "#/components/schemas/Create_sg_vcc_incorporate", "sg.vcc_eligible_fi.engage": "#/components/schemas/Create_sg_vcc_eligible_fi_engage", "sg.vcc_fund_manager.appoint": "#/components/schemas/Create_sg_vcc_fund_manager_appoint", "sg.vcc_sub_fund.register": "#/components/schemas/Create_sg_vcc_sub_fund_register", "sg.accounting_standards_exemption.apply": "#/components/schemas/Create_sg_accounting_standards_exemption_apply", "sg.acra_document.legalise": "#/components/schemas/Create_sg_acra_document_legalise", "sg.acra_information_product.request": "#/components/schemas/Create_sg_acra_information_product_request", "sg.agm.hold": "#/components/schemas/Create_sg_agm_hold", "sg.agm.waive": "#/components/schemas/Create_sg_agm_waive", "sg.agm_financial_statements.notify": "#/components/schemas/Create_sg_agm_financial_statements_notify", "sg.annual_return.file": "#/components/schemas/Create_sg_annual_return_file", "sg.audit.engage": "#/components/schemas/Create_sg_audit_engage", "sg.audit_exemption.apply": "#/components/schemas/Create_sg_audit_exemption_apply", "sg.business_registration.renew": "#/components/schemas/Create_sg_business_registration_renew", "sg.charity_annual_submission.file": "#/components/schemas/Create_sg_charity_annual_submission_file", "sg.climate_assurance.engage": "#/components/schemas/Create_sg_climate_assurance_engage", "sg.climate_disclosure.file": "#/components/schemas/Create_sg_climate_disclosure_file", "sg.controller_notice.notify": "#/components/schemas/Create_sg_controller_notice_notify", "sg.coop_annual_report.file": "#/components/schemas/Create_sg_coop_annual_report_file", "sg.coop_contribution_election.file": "#/components/schemas/Create_sg_coop_contribution_election_file", "sg.coop_fund_contribution.pay": "#/components/schemas/Create_sg_coop_fund_contribution_pay", "sg.coop_wd1_return.file": "#/components/schemas/Create_sg_coop_wd1_return_file", "sg.coop_wd1a_return.file": "#/components/schemas/Create_sg_coop_wd1a_return_file", "sg.corporate_document.legalise_apostille": "#/components/schemas/Create_sg_corporate_document_legalise_apostille", "sg.corporate_tax_return.file": "#/components/schemas/Create_sg_corporate_tax_return_file", "sg.employee_earnings_form.issue": "#/components/schemas/Create_sg_employee_earnings_form_issue", "sg.employment_income.amend": "#/components/schemas/Create_sg_employment_income_amend", "sg.employment_income.file": "#/components/schemas/Create_sg_employment_income_file", "sg.estimated_chargeable_income.file": "#/components/schemas/Create_sg_estimated_chargeable_income_file", "sg.estimated_chargeable_income.waive": "#/components/schemas/Create_sg_estimated_chargeable_income_waive", "sg.extension_of_time.apply": "#/components/schemas/Create_sg_extension_of_time_apply", "sg.financial_statements.file": "#/components/schemas/Create_sg_financial_statements_file", "sg.financial_statements.prepare": "#/components/schemas/Create_sg_financial_statements_prepare", "sg.financial_statements_relief.apply": "#/components/schemas/Create_sg_financial_statements_relief_apply", "sg.foreign_company_annual_return.file": "#/components/schemas/Create_sg_foreign_company_annual_return_file", "sg.foreign_company_branch_waiver.apply": "#/components/schemas/Create_sg_foreign_company_branch_waiver_apply", "sg.foreign_company_filing_extension.apply": "#/components/schemas/Create_sg_foreign_company_filing_extension_apply", "sg.foreign_company_filing_relief.apply": "#/components/schemas/Create_sg_foreign_company_filing_relief_apply", "sg.foreign_company_fs_relief.apply": "#/components/schemas/Create_sg_foreign_company_fs_relief_apply", "sg.gst_filing_extension.request": "#/components/schemas/Create_sg_gst_filing_extension_request", "sg.gst_return.file": "#/components/schemas/Create_sg_gst_return_file", "sg.gst_return.rectify": "#/components/schemas/Create_sg_gst_return_rectify", "sg.ipc_donation_return.file": "#/components/schemas/Create_sg_ipc_donation_return_file", "sg.llp_annual_declaration.file": "#/components/schemas/Create_sg_llp_annual_declaration_file", "sg.llp_annual_declaration_extension.apply": "#/components/schemas/Create_sg_llp_annual_declaration_extension_apply", "sg.nominee_register.change": "#/components/schemas/Create_sg_nominee_register_change", "sg.partnership_partner_cessation.notify": "#/components/schemas/Create_sg_partnership_partner_cessation_notify", "sg.partnership_tax_return.file": "#/components/schemas/Create_sg_partnership_tax_return_file", "sg.register_exemption.declare": "#/components/schemas/Create_sg_register_exemption_declare", "sg.registrable_controller.change": "#/components/schemas/Create_sg_registrable_controller_change", "sg.representative_office_declaration.file": "#/components/schemas/Create_sg_representative_office_declaration_file", "sg.representative_office_licence.extend": "#/components/schemas/Create_sg_representative_office_licence_extend", "sg.revised_financial_statements.file": "#/components/schemas/Create_sg_revised_financial_statements_file", "sg.society_annual_return.file": "#/components/schemas/Create_sg_society_annual_return_file", "sg.society_certified_copy.request": "#/components/schemas/Create_sg_society_certified_copy_request", "sg.society_document.repurchase": "#/components/schemas/Create_sg_society_document_repurchase", "sg.vcc_annual_return.file": "#/components/schemas/Create_sg_vcc_annual_return_file", "sg.xbrl_exemption.apply": "#/components/schemas/Create_sg_xbrl_exemption_apply", "sg.cooperative_agm.hold": "#/components/schemas/Create_sg_cooperative_agm_hold", "sg.cooperative_agm_return.file": "#/components/schemas/Create_sg_cooperative_agm_return_file", "sg.cooperative_annual_report.file": "#/components/schemas/Create_sg_cooperative_annual_report_file", "sg.cooperative_office_bearers.change": "#/components/schemas/Create_sg_cooperative_office_bearers_change", "sg.directors_resolution.record": "#/components/schemas/Create_sg_directors_resolution_record", "sg.foreign_company_member_register.change": "#/components/schemas/Create_sg_foreign_company_member_register_change", "sg.foreign_company_member_register_location.change": "#/components/schemas/Create_sg_foreign_company_member_register_location_change", "sg.foreign_company_nominee_register.change": "#/components/schemas/Create_sg_foreign_company_nominee_register_change", "sg.holding_company_minutes.file": "#/components/schemas/Create_sg_holding_company_minutes_file", "sg.llp_partners_resolution.record": "#/components/schemas/Create_sg_llp_partners_resolution_record", "sg.meeting_minutes.record": "#/components/schemas/Create_sg_meeting_minutes_record", "sg.members_resolution.record": "#/components/schemas/Create_sg_members_resolution_record", "sg.ordinary_resolution.file": "#/components/schemas/Create_sg_ordinary_resolution_file", "sg.special_resolution.file": "#/components/schemas/Create_sg_special_resolution_file", "sg.auditor.appoint": "#/components/schemas/Create_sg_auditor_appoint", "sg.auditor.withdraw": "#/components/schemas/Create_sg_auditor_withdraw", "sg.auditor_resignation_consent.request": "#/components/schemas/Create_sg_auditor_resignation_consent_request", "sg.business_details.change": "#/components/schemas/Create_sg_business_details_change", "sg.business_position_holder.appoint": "#/components/schemas/Create_sg_business_position_holder_appoint", "sg.business_position_holder.withdraw": "#/components/schemas/Create_sg_business_position_holder_withdraw", "sg.ceo.appoint": "#/components/schemas/Create_sg_ceo_appoint", "sg.ceo.withdraw": "#/components/schemas/Create_sg_ceo_withdraw", "sg.director.appoint": "#/components/schemas/Create_sg_director_appoint", "sg.director.change": "#/components/schemas/Create_sg_director_change", "sg.director.withdraw": "#/components/schemas/Create_sg_director_withdraw", "sg.foreign_company_position_holder.appoint": "#/components/schemas/Create_sg_foreign_company_position_holder_appoint", "sg.foreign_company_position_holder.withdraw": "#/components/schemas/Create_sg_foreign_company_position_holder_withdraw", "sg.manager.appoint": "#/components/schemas/Create_sg_manager_appoint", "sg.manager.withdraw": "#/components/schemas/Create_sg_manager_withdraw", "sg.nominee_director.appoint": "#/components/schemas/Create_sg_nominee_director_appoint", "sg.partner.appoint": "#/components/schemas/Create_sg_partner_appoint", "sg.partner.withdraw": "#/components/schemas/Create_sg_partner_withdraw", "sg.position_holder.cease": "#/components/schemas/Create_sg_position_holder_cease", "sg.position_holder.change": "#/components/schemas/Create_sg_position_holder_change", "sg.qualified_secretary.appoint": "#/components/schemas/Create_sg_qualified_secretary_appoint", "sg.secretary.appoint": "#/components/schemas/Create_sg_secretary_appoint", "sg.secretary.withdraw": "#/components/schemas/Create_sg_secretary_withdraw", "sg.society_committee.change": "#/components/schemas/Create_sg_society_committee_change", "sg.charge.register": "#/components/schemas/Create_sg_charge_register", "sg.financial_assistance.file": "#/components/schemas/Create_sg_financial_assistance_file", "sg.notice_of_compliance.file": "#/components/schemas/Create_sg_notice_of_compliance_file", "sg.preference_share.redeem": "#/components/schemas/Create_sg_preference_share_redeem", "sg.prospectus.register": "#/components/schemas/Create_sg_prospectus_register", "sg.share.allot": "#/components/schemas/Create_sg_share_allot", "sg.share.convert": "#/components/schemas/Create_sg_share_convert", "sg.share.repurchase": "#/components/schemas/Create_sg_share_repurchase", "sg.share.transfer": "#/components/schemas/Create_sg_share_transfer", "sg.share_capital.change": "#/components/schemas/Create_sg_share_capital_change", "sg.share_capital.redenominate": "#/components/schemas/Create_sg_share_capital_redenominate", "sg.share_capital.reduce": "#/components/schemas/Create_sg_share_capital_reduce", "sg.share_capital_paid_up.change": "#/components/schemas/Create_sg_share_capital_paid_up_change", "sg.treasury_share.cancel": "#/components/schemas/Create_sg_treasury_share_cancel", "sg.charge.change": "#/components/schemas/Create_sg_charge_change", "sg.charge.satisfy": "#/components/schemas/Create_sg_charge_satisfy", "sg.company_name.change": "#/components/schemas/Create_sg_company_name_change", "sg.company_name.waive_limited": "#/components/schemas/Create_sg_company_name_waive_limited", "sg.constitution.amend": "#/components/schemas/Create_sg_constitution_amend", "sg.constitution.amend_objects": "#/components/schemas/Create_sg_constitution_amend_objects", "sg.constitution_consent.request": "#/components/schemas/Create_sg_constitution_consent_request", "sg.cooperative_by_laws.amend": "#/components/schemas/Create_sg_cooperative_by_laws_amend", "sg.entity_particulars.change": "#/components/schemas/Create_sg_entity_particulars_change", "sg.financial_year_end.change": "#/components/schemas/Create_sg_financial_year_end_change", "sg.foreign_company_constitution.change": "#/components/schemas/Create_sg_foreign_company_constitution_change", "sg.foreign_company_name.change": "#/components/schemas/Create_sg_foreign_company_name_change", "sg.llp_name.change": "#/components/schemas/Create_sg_llp_name_change", "sg.notice_of_error.file": "#/components/schemas/Create_sg_notice_of_error_file", "sg.registered_address.change": "#/components/schemas/Create_sg_registered_address_change", "sg.society_address.change": "#/components/schemas/Create_sg_society_address_change", "sg.society_name.change": "#/components/schemas/Create_sg_society_name_change", "sg.society_rules.amend": "#/components/schemas/Create_sg_society_rules_amend", "sg.vcc_name.change": "#/components/schemas/Create_sg_vcc_name_change", "sg.company.continue_in": "#/components/schemas/Create_sg_company_continue_in", "sg.company.continue_out": "#/components/schemas/Create_sg_company_continue_out", "sg.company.convert_to_limited": "#/components/schemas/Create_sg_company_convert_to_limited", "sg.company.convert_to_private": "#/components/schemas/Create_sg_company_convert_to_private", "sg.company.convert_to_public": "#/components/schemas/Create_sg_company_convert_to_public", "sg.company.convert_to_unlimited": "#/components/schemas/Create_sg_company_convert_to_unlimited", "sg.company.merge": "#/components/schemas/Create_sg_company_merge", "sg.company.merge_into_new": "#/components/schemas/Create_sg_company_merge_into_new", "sg.cooperative_society.merge": "#/components/schemas/Create_sg_cooperative_society_merge", "sg.cooperative_society.transfer": "#/components/schemas/Create_sg_cooperative_society_transfer", "sg.llp.convert_from_company": "#/components/schemas/Create_sg_llp_convert_from_company", "sg.llp.convert_from_partnership": "#/components/schemas/Create_sg_llp_convert_from_partnership", "sg.vcc.continue_in": "#/components/schemas/Create_sg_vcc_continue_in", "sg.business.cease": "#/components/schemas/Create_sg_business_cease", "sg.business.restore": "#/components/schemas/Create_sg_business_restore", "sg.charity.deregister": "#/components/schemas/Create_sg_charity_deregister", "sg.company.strike_off": "#/components/schemas/Create_sg_company_strike_off", "sg.cooperative_society.wind_up": "#/components/schemas/Create_sg_cooperative_society_wind_up", "sg.court_restoration.apply": "#/components/schemas/Create_sg_court_restoration_apply", "sg.creditors_meeting.notify": "#/components/schemas/Create_sg_creditors_meeting_notify", "sg.creditors_winding_up.declare_inability": "#/components/schemas/Create_sg_creditors_winding_up_declare_inability", "sg.dormant_status.apply": "#/components/schemas/Create_sg_dormant_status_apply", "sg.dormant_tax_return.file": "#/components/schemas/Create_sg_dormant_tax_return_file", "sg.dormant_tax_waiver.apply": "#/components/schemas/Create_sg_dormant_tax_waiver_apply", "sg.early_dissolution.notify": "#/components/schemas/Create_sg_early_dissolution_notify", "sg.entity.restore": "#/components/schemas/Create_sg_entity_restore", "sg.final_meeting_return.file": "#/components/schemas/Create_sg_final_meeting_return_file", "sg.foreign_company.cease": "#/components/schemas/Create_sg_foreign_company_cease", "sg.foreign_company.strike_off": "#/components/schemas/Create_sg_foreign_company_strike_off", "sg.gst_final_return.file": "#/components/schemas/Create_sg_gst_final_return_file", "sg.gst_registration.cancel": "#/components/schemas/Create_sg_gst_registration_cancel", "sg.liquidator.appoint": "#/components/schemas/Create_sg_liquidator_appoint", "sg.liquidator_accounts.file": "#/components/schemas/Create_sg_liquidator_accounts_file", "sg.llp.strike_off": "#/components/schemas/Create_sg_llp_strike_off", "sg.members_winding_up.declare_solvency": "#/components/schemas/Create_sg_members_winding_up_declare_solvency", "sg.representative_office.cancel": "#/components/schemas/Create_sg_representative_office_cancel", "sg.restoration_order.file": "#/components/schemas/Create_sg_restoration_order_file", "sg.simplified_winding_up.pass": "#/components/schemas/Create_sg_simplified_winding_up_pass", "sg.simplified_winding_up.record": "#/components/schemas/Create_sg_simplified_winding_up_record", "sg.society.dissolve": "#/components/schemas/Create_sg_society_dissolve", "sg.strike_off.withdraw": "#/components/schemas/Create_sg_strike_off_withdraw", "sg.vcc.strike_off": "#/components/schemas/Create_sg_vcc_strike_off", "sg.vcc_sub_fund.dissolve": "#/components/schemas/Create_sg_vcc_sub_fund_dissolve", "sg.winding_up.pass": "#/components/schemas/Create_sg_winding_up_pass", "uk.acsp.register": "#/components/schemas/Create_uk_acsp_register", "uk.articles.adopt": "#/components/schemas/Create_uk_articles_adopt", "uk.charity.register": "#/components/schemas/Create_uk_charity_register", "uk.charity_interest.register": "#/components/schemas/Create_uk_charity_interest_register", "uk.charity_tax_recognition.apply": "#/components/schemas/Create_uk_charity_tax_recognition_apply", "uk.cic.incorporate": "#/components/schemas/Create_uk_cic_incorporate", "uk.cio.register": "#/components/schemas/Create_uk_cio_register", "uk.company.incorporate": "#/components/schemas/Create_uk_company_incorporate", "uk.company_name.check": "#/components/schemas/Create_uk_company_name_check", "uk.corporation_tax.register": "#/components/schemas/Create_uk_corporation_tax_register", "uk.existing_body.register": "#/components/schemas/Create_uk_existing_body_register", "uk.general_partnership.register": "#/components/schemas/Create_uk_general_partnership_register", "uk.limited_partnership.register": "#/components/schemas/Create_uk_limited_partnership_register", "uk.llp.incorporate": "#/components/schemas/Create_uk_llp_incorporate", "uk.overseas_entity.register": "#/components/schemas/Create_uk_overseas_entity_register", "uk.partnership_agreement.adopt": "#/components/schemas/Create_uk_partnership_agreement_adopt", "uk.partnership_self_assessment.register": "#/components/schemas/Create_uk_partnership_self_assessment_register", "uk.paye_scheme.register": "#/components/schemas/Create_uk_paye_scheme_register", "uk.private_fund_limited_partnership.register": "#/components/schemas/Create_uk_private_fund_limited_partnership_register", "uk.public_company_trading_certificate.apply": "#/components/schemas/Create_uk_public_company_trading_certificate_apply", "uk.register_of_members.form": "#/components/schemas/Create_uk_register_of_members_form", "uk.registered_society.register": "#/components/schemas/Create_uk_registered_society_register", "uk.sail.notify": "#/components/schemas/Create_uk_sail_notify", "uk.scio.register": "#/components/schemas/Create_uk_scio_register", "uk.scottish_qualifying_partnership.register": "#/components/schemas/Create_uk_scottish_qualifying_partnership_register", "uk.vat.register": "#/components/schemas/Create_uk_vat_register", "uk.accounting_records.record": "#/components/schemas/Create_uk_accounting_records_record", "uk.accounts_filing_extension.apply": "#/components/schemas/Create_uk_accounts_filing_extension_apply", "uk.annual_accounts.file": "#/components/schemas/Create_uk_annual_accounts_file", "uk.apostille.certify_and_legalise_document": "#/components/schemas/Create_uk_apostille_certify_and_legalise_document", "uk.apostille_registry_document.request": "#/components/schemas/Create_uk_apostille_registry_document_request", "uk.ccni_annual_monitoring_return.file": "#/components/schemas/Create_uk_ccni_annual_monitoring_return_file", "uk.certificate_of_incorporation.request": "#/components/schemas/Create_uk_certificate_of_incorporation_request", "uk.certified_copy.request": "#/components/schemas/Create_uk_certified_copy_request", "uk.charity_commission_annual_return.file": "#/components/schemas/Create_uk_charity_commission_annual_return_file", "uk.cic_report.file": "#/components/schemas/Create_uk_cic_report_file", "uk.cio_annual_return.file": "#/components/schemas/Create_uk_cio_annual_return_file", "uk.confirmation_statement.file": "#/components/schemas/Create_uk_confirmation_statement_file", "uk.corporation_tax.pay": "#/components/schemas/Create_uk_corporation_tax_pay", "uk.corporation_tax_return.file": "#/components/schemas/Create_uk_corporation_tax_return_file", "uk.data_protection_fee.pay": "#/components/schemas/Create_uk_data_protection_fee_pay", "uk.dormant_accounts.file": "#/components/schemas/Create_uk_dormant_accounts_file", "uk.gender_pay_gap.file": "#/components/schemas/Create_uk_gender_pay_gap_file", "uk.hmrc_dormancy.cease": "#/components/schemas/Create_uk_hmrc_dormancy_cease", "uk.hmrc_dormancy.notify": "#/components/schemas/Create_uk_hmrc_dormancy_notify", "uk.llp_annual_accounts.file": "#/components/schemas/Create_uk_llp_annual_accounts_file", "uk.llp_confirmation_statement.file": "#/components/schemas/Create_uk_llp_confirmation_statement_file", "uk.lp_principal_place_of_business.change": "#/components/schemas/Create_uk_lp_principal_place_of_business_change", "uk.mail_handling.change": "#/components/schemas/Create_uk_mail_handling_change", "uk.oscr_annual_return.file": "#/components/schemas/Create_uk_oscr_annual_return_file", "uk.overseas_company_accounts.file": "#/components/schemas/Create_uk_overseas_company_accounts_file", "uk.overseas_entity.change": "#/components/schemas/Create_uk_overseas_entity_change", "uk.overseas_entity_address.change": "#/components/schemas/Create_uk_overseas_entity_address_change", "uk.partnership_accounts.file": "#/components/schemas/Create_uk_partnership_accounts_file", "uk.partnership_tax_return.file": "#/components/schemas/Create_uk_partnership_tax_return_file", "uk.pension_declaration.file": "#/components/schemas/Create_uk_pension_declaration_file", "uk.plc_annual_accounts.file": "#/components/schemas/Create_uk_plc_annual_accounts_file", "uk.psc.cease": "#/components/schemas/Create_uk_psc_cease", "uk.psc.change": "#/components/schemas/Create_uk_psc_change", "uk.psc.notify": "#/components/schemas/Create_uk_psc_notify", "uk.psc_notice.notify": "#/components/schemas/Create_uk_psc_notice_notify", "uk.psc_statement.file": "#/components/schemas/Create_uk_psc_statement_file", "uk.psc_verification.provide": "#/components/schemas/Create_uk_psc_verification_provide", "uk.psc_verification_extension.request": "#/components/schemas/Create_uk_psc_verification_extension_request", "uk.registered_email.change": "#/components/schemas/Create_uk_registered_email_change", "uk.registered_society_annual_return.file": "#/components/schemas/Create_uk_registered_society_annual_return_file", "uk.slp_confirmation_statement.file": "#/components/schemas/Create_uk_slp_confirmation_statement_file", "uk.sqp_confirmation_statement.file": "#/components/schemas/Create_uk_sqp_confirmation_statement_file", "uk.sqp_psc.cease": "#/components/schemas/Create_uk_sqp_psc_cease", "uk.sqp_psc.change": "#/components/schemas/Create_uk_sqp_psc_change", "uk.sqp_psc.notify": "#/components/schemas/Create_uk_sqp_psc_notify", "uk.sqp_psc_filing.rectify": "#/components/schemas/Create_uk_sqp_psc_filing_rectify", "uk.sqp_psc_statement.change": "#/components/schemas/Create_uk_sqp_psc_statement_change", "uk.sqp_psc_statement.notify": "#/components/schemas/Create_uk_sqp_psc_statement_notify", "uk.sqp_registration_details.change": "#/components/schemas/Create_uk_sqp_registration_details_change", "uk.subsidiary_audit_exemption.file": "#/components/schemas/Create_uk_subsidiary_audit_exemption_file", "uk.uk_establishment_address.change": "#/components/schemas/Create_uk_uk_establishment_address_change", "uk.uk_establishment_service_agent.change": "#/components/schemas/Create_uk_uk_establishment_service_agent_change", "uk.agm.hold": "#/components/schemas/Create_uk_agm_hold", "uk.board_meeting.record": "#/components/schemas/Create_uk_board_meeting_record", "uk.board_resolution.pass": "#/components/schemas/Create_uk_board_resolution_pass", "uk.company_records.change": "#/components/schemas/Create_uk_company_records_change", "uk.dividend.declare": "#/components/schemas/Create_uk_dividend_declare", "uk.general_meeting.hold": "#/components/schemas/Create_uk_general_meeting_hold", "uk.general_meeting.record": "#/components/schemas/Create_uk_general_meeting_record", "uk.interests_register.record": "#/components/schemas/Create_uk_interests_register_record", "uk.register_of_members.change": "#/components/schemas/Create_uk_register_of_members_change", "uk.resolution.file": "#/components/schemas/Create_uk_resolution_file", "uk.sail.register": "#/components/schemas/Create_uk_sail_register", "uk.serious_loss_meeting.hold": "#/components/schemas/Create_uk_serious_loss_meeting_hold", "uk.share_transfer.register": "#/components/schemas/Create_uk_share_transfer_register", "uk.written_resolution.pass": "#/components/schemas/Create_uk_written_resolution_pass", "uk.auditor.appoint": "#/components/schemas/Create_uk_auditor_appoint", "uk.auditor.remove": "#/components/schemas/Create_uk_auditor_remove", "uk.auditor.resign": "#/components/schemas/Create_uk_auditor_resign", "uk.director.appoint": "#/components/schemas/Create_uk_director_appoint", "uk.director.remove": "#/components/schemas/Create_uk_director_remove", "uk.disclosure_protection.apply": "#/components/schemas/Create_uk_disclosure_protection_apply", "uk.limited_partnership_particulars.change": "#/components/schemas/Create_uk_limited_partnership_particulars_change", "uk.limited_partnership_partner.change": "#/components/schemas/Create_uk_limited_partnership_partner_change", "uk.nominee_director.hold": "#/components/schemas/Create_uk_nominee_director_hold", "uk.officer.remove": "#/components/schemas/Create_uk_officer_remove", "uk.officer_details.change": "#/components/schemas/Create_uk_officer_details_change", "uk.officer_identity.verify": "#/components/schemas/Create_uk_officer_identity_verify", "uk.overseas_company_officer.appoint": "#/components/schemas/Create_uk_overseas_company_officer_appoint", "uk.overseas_company_officer.change": "#/components/schemas/Create_uk_overseas_company_officer_change", "uk.overseas_company_verification_statement.file": "#/components/schemas/Create_uk_overseas_company_verification_statement_file", "uk.plc_secretary.appoint": "#/components/schemas/Create_uk_plc_secretary_appoint", "uk.secretarial_service.engage": "#/components/schemas/Create_uk_secretarial_service_engage", "uk.secretary.appoint": "#/components/schemas/Create_uk_secretary_appoint", "uk.ukeig_documents.notify": "#/components/schemas/Create_uk_ukeig_documents_notify", "uk.ukeig_manager.appoint": "#/components/schemas/Create_uk_ukeig_manager_appoint", "uk.ukeig_manager.change": "#/components/schemas/Create_uk_ukeig_manager_change", "uk.capital_payment.approve": "#/components/schemas/Create_uk_capital_payment_approve", "uk.charge.register": "#/components/schemas/Create_uk_charge_register", "uk.charge.release": "#/components/schemas/Create_uk_charge_release", "uk.charge.satisfy": "#/components/schemas/Create_uk_charge_satisfy", "uk.class_name.assign": "#/components/schemas/Create_uk_class_name_assign", "uk.class_rights.change": "#/components/schemas/Create_uk_class_rights_change", "uk.emi_options.notify": "#/components/schemas/Create_uk_emi_options_notify", "uk.ers_return.file": "#/components/schemas/Create_uk_ers_return_file", "uk.ers_scheme.register": "#/components/schemas/Create_uk_ers_scheme_register", "uk.limited_partner_interest.assign": "#/components/schemas/Create_uk_limited_partner_interest_assign", "uk.llp_member.appoint": "#/components/schemas/Create_uk_llp_member_appoint", "uk.llp_member.remove": "#/components/schemas/Create_uk_llp_member_remove", "uk.member_class.create": "#/components/schemas/Create_uk_member_class_create", "uk.own_shares.repurchase": "#/components/schemas/Create_uk_own_shares_repurchase", "uk.redeemable_shares.redeem": "#/components/schemas/Create_uk_redeemable_shares_redeem", "uk.seis_eis_advance_assurance.request": "#/components/schemas/Create_uk_seis_eis_advance_assurance_request", "uk.seis_eis_compliance_statement.file": "#/components/schemas/Create_uk_seis_eis_compliance_statement_file", "uk.share.allot": "#/components/schemas/Create_uk_share_allot", "uk.share.transfer": "#/components/schemas/Create_uk_share_transfer", "uk.share_capital.consolidate": "#/components/schemas/Create_uk_share_capital_consolidate", "uk.share_capital.redenominate": "#/components/schemas/Create_uk_share_capital_redenominate", "uk.share_capital.reduce_court": "#/components/schemas/Create_uk_share_capital_reduce_court", "uk.share_capital.reduce_solvency": "#/components/schemas/Create_uk_share_capital_reduce_solvency", "uk.share_capital.subdivide": "#/components/schemas/Create_uk_share_capital_subdivide", "uk.share_option.exercise": "#/components/schemas/Create_uk_share_option_exercise", "uk.share_option.grant": "#/components/schemas/Create_uk_share_option_grant", "uk.treasury_share.cancel": "#/components/schemas/Create_uk_treasury_share_cancel", "uk.treasury_share.transfer": "#/components/schemas/Create_uk_treasury_share_transfer", "uk.accounting_reference_date.change": "#/components/schemas/Create_uk_accounting_reference_date_change", "uk.articles.amend": "#/components/schemas/Create_uk_articles_amend", "uk.charitable_company_articles.amend": "#/components/schemas/Create_uk_charitable_company_articles_amend", "uk.cic_asset_lock_body.change": "#/components/schemas/Create_uk_cic_asset_lock_body_change", "uk.cic_objects.change": "#/components/schemas/Create_uk_cic_objects_change", "uk.cio_constitution.amend": "#/components/schemas/Create_uk_cio_constitution_amend", "uk.company_name.change": "#/components/schemas/Create_uk_company_name_change", "uk.disputed_address.change": "#/components/schemas/Create_uk_disputed_address_change", "uk.limited_suffix_exemption.apply": "#/components/schemas/Create_uk_limited_suffix_exemption_apply", "uk.llp_name.change": "#/components/schemas/Create_uk_llp_name_change", "uk.overseas_company_name.change": "#/components/schemas/Create_uk_overseas_company_name_change", "uk.register_material.remove": "#/components/schemas/Create_uk_register_material_remove", "uk.registered_office.change": "#/components/schemas/Create_uk_registered_office_change", "uk.registered_office_situation.change": "#/components/schemas/Create_uk_registered_office_situation_change", "uk.registered_society_name.change": "#/components/schemas/Create_uk_registered_society_name_change", "uk.registered_society_office.change": "#/components/schemas/Create_uk_registered_society_office_change", "uk.registered_society_rules.amend": "#/components/schemas/Create_uk_registered_society_rules_amend", "uk.replacement_document.file": "#/components/schemas/Create_uk_replacement_document_file", "uk.scio_constitution.amend": "#/components/schemas/Create_uk_scio_constitution_amend", "uk.second_filing.file": "#/components/schemas/Create_uk_second_filing_file", "uk.administration.appoint": "#/components/schemas/Create_uk_administration_appoint", "uk.charity.convert_to_cio": "#/components/schemas/Create_uk_charity_convert_to_cio", "uk.charity.convert_to_scio": "#/components/schemas/Create_uk_charity_convert_to_scio", "uk.cic.convert_to_charitable_company": "#/components/schemas/Create_uk_cic_convert_to_charitable_company", "uk.cic.convert_to_cio": "#/components/schemas/Create_uk_cic_convert_to_cio", "uk.cic.convert_to_registered_society": "#/components/schemas/Create_uk_cic_convert_to_registered_society", "uk.company.convert_to_cic": "#/components/schemas/Create_uk_company_convert_to_cic", "uk.company.convert_to_limited": "#/components/schemas/Create_uk_company_convert_to_limited", "uk.company.convert_to_private": "#/components/schemas/Create_uk_company_convert_to_private", "uk.company.convert_to_public": "#/components/schemas/Create_uk_company_convert_to_public", "uk.company.convert_to_registered_society": "#/components/schemas/Create_uk_company_convert_to_registered_society", "uk.company.convert_to_unlimited": "#/components/schemas/Create_uk_company_convert_to_unlimited", "uk.company_voluntary_arrangement.propose": "#/components/schemas/Create_uk_company_voluntary_arrangement_propose", "uk.limited_partnership.designate_pflp": "#/components/schemas/Create_uk_limited_partnership_designate_pflp", "uk.moratorium.request": "#/components/schemas/Create_uk_moratorium_request", "uk.mvl_reconstruction.implement": "#/components/schemas/Create_uk_mvl_reconstruction_implement", "uk.public_company_merger.implement": "#/components/schemas/Create_uk_public_company_merger_implement", "uk.redomiciliation.request": "#/components/schemas/Create_uk_redomiciliation_request", "uk.registered_society.convert_to_company": "#/components/schemas/Create_uk_registered_society_convert_to_company", "uk.registered_society.merge": "#/components/schemas/Create_uk_registered_society_merge", "uk.registered_society.transfer_engagements": "#/components/schemas/Create_uk_registered_society_transfer_engagements", "uk.restructuring_plan.implement": "#/components/schemas/Create_uk_restructuring_plan_implement", "uk.scheme_of_arrangement.implement": "#/components/schemas/Create_uk_scheme_of_arrangement_implement", "uk.societas.convert_to_plc": "#/components/schemas/Create_uk_societas_convert_to_plc", "uk.societas_conversion_draft_terms.notify": "#/components/schemas/Create_uk_societas_conversion_draft_terms_notify", "uk.uk_establishment.register": "#/components/schemas/Create_uk_uk_establishment_register", "uk.ukeig_alternative_name.register": "#/components/schemas/Create_uk_ukeig_alternative_name_register", "uk.ukeig_establishment.register": "#/components/schemas/Create_uk_ukeig_establishment_register", "uk.ukeig_establishment_change.notify": "#/components/schemas/Create_uk_ukeig_establishment_change_notify", "uk.administrative_restoration.apply": "#/components/schemas/Create_uk_administrative_restoration_apply", "uk.charitable_company.close": "#/components/schemas/Create_uk_charitable_company_close", "uk.cio.dissolve": "#/components/schemas/Create_uk_cio_dissolve", "uk.compulsory_liquidation.petition": "#/components/schemas/Create_uk_compulsory_liquidation_petition", "uk.court_restoration.apply": "#/components/schemas/Create_uk_court_restoration_apply", "uk.court_restoration_order.register": "#/components/schemas/Create_uk_court_restoration_order_register", "uk.creditors_voluntary_liquidation.commence": "#/components/schemas/Create_uk_creditors_voluntary_liquidation_commence", "uk.creditors_voluntary_liquidation.complete": "#/components/schemas/Create_uk_creditors_voluntary_liquidation_complete", "uk.general_partnership.dissolve": "#/components/schemas/Create_uk_general_partnership_dissolve", "uk.limited_partnership.dissolve": "#/components/schemas/Create_uk_limited_partnership_dissolve", "uk.members_voluntary_liquidation.commence": "#/components/schemas/Create_uk_members_voluntary_liquidation_commence", "uk.members_voluntary_liquidation.complete": "#/components/schemas/Create_uk_members_voluntary_liquidation_complete", "uk.members_voluntary_liquidation.file": "#/components/schemas/Create_uk_members_voluntary_liquidation_file", "uk.overseas_entity.remove": "#/components/schemas/Create_uk_overseas_entity_remove", "uk.paye_scheme.close": "#/components/schemas/Create_uk_paye_scheme_close", "uk.registered_society.cancel": "#/components/schemas/Create_uk_registered_society_cancel", "uk.registered_society.dissolve": "#/components/schemas/Create_uk_registered_society_dissolve", "uk.scio.dissolve": "#/components/schemas/Create_uk_scio_dissolve", "uk.scottish_qualifying_partnership.cease": "#/components/schemas/Create_uk_scottish_qualifying_partnership_cease", "uk.strike_off.apply": "#/components/schemas/Create_uk_strike_off_apply", "uk.strike_off.withdraw": "#/components/schemas/Create_uk_strike_off_withdraw", "uk.uk_establishment.close": "#/components/schemas/Create_uk_uk_establishment_close", "uk.vat_registration.cancel": "#/components/schemas/Create_uk_vat_registration_cancel", "ky.building_society.incorporate": "#/components/schemas/Create_ky_building_society_incorporate", "ky.cooperative_society.register": "#/components/schemas/Create_ky_cooperative_society_register", "ky.ein.apply": "#/components/schemas/Create_ky_ein_apply", "ky.elp.register": "#/components/schemas/Create_ky_elp_register", "ky.exempted_company.incorporate": "#/components/schemas/Create_ky_exempted_company_incorporate", "ky.exempted_ldc.convert": "#/components/schemas/Create_ky_exempted_ldc_convert", "ky.exempted_ldc.incorporate": "#/components/schemas/Create_ky_exempted_ldc_incorporate", "ky.exempted_spc.convert": "#/components/schemas/Create_ky_exempted_spc_convert", "ky.exempted_spc.incorporate": "#/components/schemas/Create_ky_exempted_spc_incorporate", "ky.exempted_trust.register": "#/components/schemas/Create_ky_exempted_trust_register", "ky.exempted_trust_draft.file": "#/components/schemas/Create_ky_exempted_trust_draft_file", "ky.fit_and_proper_determination.request": "#/components/schemas/Create_ky_fit_and_proper_determination_request", "ky.foreign_company.register": "#/components/schemas/Create_ky_foreign_company_register", "ky.foreign_lp.register": "#/components/schemas/Create_ky_foreign_lp_register", "ky.foundation_company.convert": "#/components/schemas/Create_ky_foundation_company_convert", "ky.foundation_company.incorporate": "#/components/schemas/Create_ky_foundation_company_incorporate", "ky.friendly_society.register": "#/components/schemas/Create_ky_friendly_society_register", "ky.general_partnership.form": "#/components/schemas/Create_ky_general_partnership_form", "ky.llc.register": "#/components/schemas/Create_ky_llc_register", "ky.llc_partnership_name.reserve": "#/components/schemas/Create_ky_llc_partnership_name_reserve", "ky.llp.register": "#/components/schemas/Create_ky_llp_register", "ky.local_companies_control_licence.apply": "#/components/schemas/Create_ky_local_companies_control_licence_apply", "ky.lp.register": "#/components/schemas/Create_ky_lp_register", "ky.mutual_fund.register": "#/components/schemas/Create_ky_mutual_fund_register", "ky.name.reserve": "#/components/schemas/Create_ky_name_reserve", "ky.npo.register": "#/components/schemas/Create_ky_npo_register", "ky.ordinary_nonresident_company.incorporate": "#/components/schemas/Create_ky_ordinary_nonresident_company_incorporate", "ky.ordinary_resident_company.incorporate": "#/components/schemas/Create_ky_ordinary_resident_company_incorporate", "ky.private_fund.register": "#/components/schemas/Create_ky_private_fund_register", "ky.private_trust_company.register": "#/components/schemas/Create_ky_private_trust_company_register", "ky.registered_office.notify": "#/components/schemas/Create_ky_registered_office_notify", "ky.registered_office.provide": "#/components/schemas/Create_ky_registered_office_provide", "ky.section_80_company.designate": "#/components/schemas/Create_ky_section_80_company_designate", "ky.section_80_company.incorporate": "#/components/schemas/Create_ky_section_80_company_incorporate", "ky.sez_trade_certificate.amend": "#/components/schemas/Create_ky_sez_trade_certificate_amend", "ky.sez_trade_certificate.apply": "#/components/schemas/Create_ky_sez_trade_certificate_apply", "ky.sezc.convert": "#/components/schemas/Create_ky_sezc_convert", "ky.sezc.register": "#/components/schemas/Create_ky_sezc_register", "ky.siba_registered_person.register": "#/components/schemas/Create_ky_siba_registered_person_register", "ky.tax_undertaking.apply": "#/components/schemas/Create_ky_tax_undertaking_apply", "ky.trade_and_business_licence.apply": "#/components/schemas/Create_ky_trade_and_business_licence_apply", "ky.annual_return.file": "#/components/schemas/Create_ky_annual_return_file", "ky.beneficial_ownership.change": "#/components/schemas/Create_ky_beneficial_ownership_change", "ky.beneficial_ownership.file": "#/components/schemas/Create_ky_beneficial_ownership_file", "ky.beneficial_ownership_alternative_route.confirm": "#/components/schemas/Create_ky_beneficial_ownership_alternative_route_confirm", "ky.books_location.file": "#/components/schemas/Create_ky_books_location_file", "ky.building_society_annual_fee.pay": "#/components/schemas/Create_ky_building_society_annual_fee_pay", "ky.building_society_annual_statement.file": "#/components/schemas/Create_ky_building_society_annual_statement_file", "ky.building_society_regulatory_fee.pay": "#/components/schemas/Create_ky_building_society_regulatory_fee_pay", "ky.cbc_notification.file": "#/components/schemas/Create_ky_cbc_notification_file", "ky.cbc_report.file": "#/components/schemas/Create_ky_cbc_report_file", "ky.cima_society_accounts.file": "#/components/schemas/Create_ky_cima_society_accounts_file", "ky.cooperative_society_annual_return.file": "#/components/schemas/Create_ky_cooperative_society_annual_return_file", "ky.cooperative_society_audit.file": "#/components/schemas/Create_ky_cooperative_society_audit_file", "ky.cooperative_society_audit.prepare": "#/components/schemas/Create_ky_cooperative_society_audit_prepare", "ky.crs_compliance_form.file": "#/components/schemas/Create_ky_crs_compliance_form_file", "ky.crs_return.file": "#/components/schemas/Create_ky_crs_return_file", "ky.economic_substance.notify": "#/components/schemas/Create_ky_economic_substance_notify", "ky.economic_substance_return.file": "#/components/schemas/Create_ky_economic_substance_return_file", "ky.economic_substance_tro.file": "#/components/schemas/Create_ky_economic_substance_tro_file", "ky.elp_annual_return.file": "#/components/schemas/Create_ky_elp_annual_return_file", "ky.fatca_crs.register": "#/components/schemas/Create_ky_fatca_crs_register", "ky.fatca_return.file": "#/components/schemas/Create_ky_fatca_return_file", "ky.foreign_company_annual_fee.pay": "#/components/schemas/Create_ky_foreign_company_annual_fee_pay", "ky.foreign_lp_annual_fee.pay": "#/components/schemas/Create_ky_foreign_lp_annual_fee_pay", "ky.friendly_society_mortality_return.file": "#/components/schemas/Create_ky_friendly_society_mortality_return_file", "ky.friendly_society_sickness_mortality_return.file": "#/components/schemas/Create_ky_friendly_society_sickness_mortality_return_file", "ky.friendly_society_statement.file": "#/components/schemas/Create_ky_friendly_society_statement_file", "ky.fund_annual_return.file": "#/components/schemas/Create_ky_fund_annual_return_file", "ky.llc_annual_return.file": "#/components/schemas/Create_ky_llc_annual_return_file", "ky.llp_annual_return.file": "#/components/schemas/Create_ky_llp_annual_return_file", "ky.llp_provisional_declaration.file": "#/components/schemas/Create_ky_llp_provisional_declaration_file", "ky.lp_annual_fee.pay": "#/components/schemas/Create_ky_lp_annual_fee_pay", "ky.mail_handling.change": "#/components/schemas/Create_ky_mail_handling_change", "ky.mail_item.forward": "#/components/schemas/Create_ky_mail_item_forward", "ky.npo_annual_return.file": "#/components/schemas/Create_ky_npo_annual_return_file", "ky.npo_filing_extension.request": "#/components/schemas/Create_ky_npo_filing_extension_request", "ky.npo_financial_statements_review_report.file": "#/components/schemas/Create_ky_npo_financial_statements_review_report_file", "ky.npo_review_report.file": "#/components/schemas/Create_ky_npo_review_report_file", "ky.ordinary_company_annual_return.file": "#/components/schemas/Create_ky_ordinary_company_annual_return_file", "ky.principal_point_of_contact.appoint": "#/components/schemas/Create_ky_principal_point_of_contact_appoint", "ky.ptc_annual_declaration.file": "#/components/schemas/Create_ky_ptc_annual_declaration_file", "ky.section_80_annual_return.file": "#/components/schemas/Create_ky_section_80_annual_return_file", "ky.sez_trade_certificate_annual_fee.pay": "#/components/schemas/Create_ky_sez_trade_certificate_annual_fee_pay", "ky.sez_trade_certificate_fee.pay": "#/components/schemas/Create_ky_sez_trade_certificate_fee_pay", "ky.sezc_annual_return.file": "#/components/schemas/Create_ky_sezc_annual_return_file", "ky.siba_annual_declaration.file": "#/components/schemas/Create_ky_siba_annual_declaration_file", "ky.siba_registration.deregister": "#/components/schemas/Create_ky_siba_registration_deregister", "ky.spc_annual_return.file": "#/components/schemas/Create_ky_spc_annual_return_file", "ky.trust_annual_fee.pay": "#/components/schemas/Create_ky_trust_annual_fee_pay", "ky.annual_general_meeting.hold": "#/components/schemas/Create_ky_annual_general_meeting_hold", "ky.apostille.request": "#/components/schemas/Create_ky_apostille_request", "ky.board_meeting.record": "#/components/schemas/Create_ky_board_meeting_record", "ky.board_resolution.pass": "#/components/schemas/Create_ky_board_resolution_pass", "ky.branch_register.change": "#/components/schemas/Create_ky_branch_register_change", "ky.branch_register.continue_out": "#/components/schemas/Create_ky_branch_register_continue_out", "ky.branch_register.open": "#/components/schemas/Create_ky_branch_register_open", "ky.certified_copy.request": "#/components/schemas/Create_ky_certified_copy_request", "ky.charge.record": "#/components/schemas/Create_ky_charge_record", "ky.charge.release": "#/components/schemas/Create_ky_charge_release", "ky.distribution.declare": "#/components/schemas/Create_ky_distribution_declare", "ky.dividend.declare": "#/components/schemas/Create_ky_dividend_declare", "ky.document_authentication.request": "#/components/schemas/Create_ky_document_authentication_request", "ky.general_meeting.hold": "#/components/schemas/Create_ky_general_meeting_hold", "ky.good_standing_certificate.request": "#/components/schemas/Create_ky_good_standing_certificate_request", "ky.member_resolution.pass": "#/components/schemas/Create_ky_member_resolution_pass", "ky.registry_certificate.request": "#/components/schemas/Create_ky_registry_certificate_request", "ky.registry_search.request": "#/components/schemas/Create_ky_registry_search_request", "ky.special_resolution.file": "#/components/schemas/Create_ky_special_resolution_file", "ky.statutory_register.change": "#/components/schemas/Create_ky_statutory_register_change", "ky.aml_officers.designate": "#/components/schemas/Create_ky_aml_officers_designate", "ky.director.appoint": "#/components/schemas/Create_ky_director_appoint", "ky.director.remove": "#/components/schemas/Create_ky_director_remove", "ky.director_registration.apply": "#/components/schemas/Create_ky_director_registration_apply", "ky.director_registration.change": "#/components/schemas/Create_ky_director_registration_change", "ky.director_registration.surrender": "#/components/schemas/Create_ky_director_registration_surrender", "ky.foundation_secretary.change": "#/components/schemas/Create_ky_foundation_secretary_change", "ky.general_partner.appoint": "#/components/schemas/Create_ky_general_partner_appoint", "ky.general_partner.remove": "#/components/schemas/Create_ky_general_partner_remove", "ky.llc_manager.appoint": "#/components/schemas/Create_ky_llc_manager_appoint", "ky.llc_manager.remove": "#/components/schemas/Create_ky_llc_manager_remove", "ky.nominee_director.appoint": "#/components/schemas/Create_ky_nominee_director_appoint", "ky.register_of_directors.file": "#/components/schemas/Create_ky_register_of_directors_file", "ky.register_of_managers.file": "#/components/schemas/Create_ky_register_of_managers_file", "ky.secretary.appoint": "#/components/schemas/Create_ky_secretary_appoint", "ky.secretary.remove": "#/components/schemas/Create_ky_secretary_remove", "ky.elp_interest.transfer": "#/components/schemas/Create_ky_elp_interest_transfer", "ky.llc_interest.transfer": "#/components/schemas/Create_ky_llc_interest_transfer", "ky.lp_interest.transfer": "#/components/schemas/Create_ky_lp_interest_transfer", "ky.minority_shares.acquire": "#/components/schemas/Create_ky_minority_shares_acquire", "ky.resident_company_share.transfer": "#/components/schemas/Create_ky_resident_company_share_transfer", "ky.share.allot": "#/components/schemas/Create_ky_share_allot", "ky.share.redeem": "#/components/schemas/Create_ky_share_redeem", "ky.share.transfer": "#/components/schemas/Create_ky_share_transfer", "ky.share_capital.change": "#/components/schemas/Create_ky_share_capital_change", "ky.share_capital.increase": "#/components/schemas/Create_ky_share_capital_increase", "ky.share_capital.reduce": "#/components/schemas/Create_ky_share_capital_reduce", "ky.share_capital.reduce_court": "#/components/schemas/Create_ky_share_capital_reduce_court", "ky.treasury_share.dispose": "#/components/schemas/Create_ky_treasury_share_dispose", "ky.constitution.amend": "#/components/schemas/Create_ky_constitution_amend", "ky.dual_foreign_name.change": "#/components/schemas/Create_ky_dual_foreign_name_change", "ky.foreign_company.cease": "#/components/schemas/Create_ky_foreign_company_cease", "ky.foreign_company_return.file": "#/components/schemas/Create_ky_foreign_company_return_file", "ky.foreign_lp_statement.file": "#/components/schemas/Create_ky_foreign_lp_statement_file", "ky.name.amend": "#/components/schemas/Create_ky_name_amend", "ky.name.change": "#/components/schemas/Create_ky_name_change", "ky.npo_registration.amend": "#/components/schemas/Create_ky_npo_registration_amend", "ky.npo_registration.cancel": "#/components/schemas/Create_ky_npo_registration_cancel", "ky.registered_office.amend": "#/components/schemas/Create_ky_registered_office_amend", "ky.registered_office.change": "#/components/schemas/Create_ky_registered_office_change", "ky.registered_particulars.amend": "#/components/schemas/Create_ky_registered_particulars_amend", "ky.registry_error.rectify": "#/components/schemas/Create_ky_registry_error_rectify", "ky.society_rules.amend": "#/components/schemas/Create_ky_society_rules_amend", "ky.building_society.merge": "#/components/schemas/Create_ky_building_society_merge", "ky.company.convert_to_exempted": "#/components/schemas/Create_ky_company_convert_to_exempted", "ky.company.convert_to_foundation_company": "#/components/schemas/Create_ky_company_convert_to_foundation_company", "ky.company.convert_to_ldc": "#/components/schemas/Create_ky_company_convert_to_ldc", "ky.company.convert_to_llc": "#/components/schemas/Create_ky_company_convert_to_llc", "ky.company.convert_to_ordinary_resident": "#/components/schemas/Create_ky_company_convert_to_ordinary_resident", "ky.company.convert_to_sezc": "#/components/schemas/Create_ky_company_convert_to_sezc", "ky.company.convert_to_spc": "#/components/schemas/Create_ky_company_convert_to_spc", "ky.company.merge": "#/components/schemas/Create_ky_company_merge", "ky.continuation_in.apply": "#/components/schemas/Create_ky_continuation_in_apply", "ky.continuation_out.apply": "#/components/schemas/Create_ky_continuation_out_apply", "ky.elp.continue_out": "#/components/schemas/Create_ky_elp_continue_out", "ky.exempted_company.convert_resident": "#/components/schemas/Create_ky_exempted_company_convert_resident", "ky.foreign_partnership.convert_to_elp": "#/components/schemas/Create_ky_foreign_partnership_convert_to_elp", "ky.foundation_company.convert_exempted": "#/components/schemas/Create_ky_foundation_company_convert_exempted", "ky.llc.continue_out": "#/components/schemas/Create_ky_llc_continue_out", "ky.llc.convert_exempted": "#/components/schemas/Create_ky_llc_convert_exempted", "ky.llc.merge": "#/components/schemas/Create_ky_llc_merge", "ky.llp.continue_in": "#/components/schemas/Create_ky_llp_continue_in", "ky.llp.continue_out": "#/components/schemas/Create_ky_llp_continue_out", "ky.llp_continue_out.complete": "#/components/schemas/Create_ky_llp_continue_out_complete", "ky.lp.convert_to_elp": "#/components/schemas/Create_ky_lp_convert_to_elp", "ky.partnership.convert_to_elp": "#/components/schemas/Create_ky_partnership_convert_to_elp", "ky.partnership.convert_to_llp": "#/components/schemas/Create_ky_partnership_convert_to_llp", "ky.provisional_registration.apply": "#/components/schemas/Create_ky_provisional_registration_apply", "ky.provisional_registration.complete": "#/components/schemas/Create_ky_provisional_registration_complete", "ky.provisional_registration.renew": "#/components/schemas/Create_ky_provisional_registration_renew", "ky.restructuring_officer.appoint": "#/components/schemas/Create_ky_restructuring_officer_appoint", "ky.scheme_of_arrangement.apply": "#/components/schemas/Create_ky_scheme_of_arrangement_apply", "ky.scheme_order.file": "#/components/schemas/Create_ky_scheme_order_file", "ky.cooperative_society.dissolve": "#/components/schemas/Create_ky_cooperative_society_dissolve", "ky.cooperative_society.dissolve_low_membership": "#/components/schemas/Create_ky_cooperative_society_dissolve_low_membership", "ky.dormancy.assess": "#/components/schemas/Create_ky_dormancy_assess", "ky.exempted_trust.deregister": "#/components/schemas/Create_ky_exempted_trust_deregister", "ky.foreign_registration.cease": "#/components/schemas/Create_ky_foreign_registration_cease", "ky.fund.deregister": "#/components/schemas/Create_ky_fund_deregister", "ky.general_partnership.dissolve": "#/components/schemas/Create_ky_general_partnership_dissolve", "ky.general_partnership.dissolve_by_court": "#/components/schemas/Create_ky_general_partnership_dissolve_by_court", "ky.liquidation_annual_meeting.hold": "#/components/schemas/Create_ky_liquidation_annual_meeting_hold", "ky.llc.restore": "#/components/schemas/Create_ky_llc_restore", "ky.lp_dissolution.file": "#/components/schemas/Create_ky_lp_dissolution_file", "ky.official_liquidation.petition": "#/components/schemas/Create_ky_official_liquidation_petition", "ky.partnership.restore": "#/components/schemas/Create_ky_partnership_restore", "ky.partnership_dissolution.file": "#/components/schemas/Create_ky_partnership_dissolution_file", "ky.partnership_registration.remove": "#/components/schemas/Create_ky_partnership_registration_remove", "ky.partnership_winding_up.commence": "#/components/schemas/Create_ky_partnership_winding_up_commence", "ky.restoration.apply": "#/components/schemas/Create_ky_restoration_apply", "ky.strike_off.request": "#/components/schemas/Create_ky_strike_off_request", "ky.supervision_order.apply": "#/components/schemas/Create_ky_supervision_order_apply", "ky.voluntary_liquidation.commence": "#/components/schemas/Create_ky_voluntary_liquidation_commence", "ky.voluntary_liquidation.complete": "#/components/schemas/Create_ky_voluntary_liquidation_complete", "vg.authorised_representative.appoint": "#/components/schemas/Create_vg_authorised_representative_appoint", "vg.beneficial_ownership.file": "#/components/schemas/Create_vg_beneficial_ownership_file", "vg.company.incorporate": "#/components/schemas/Create_vg_company_incorporate", "vg.company_name.reserve": "#/components/schemas/Create_vg_company_name_reserve", "vg.company_without_shares.incorporate": "#/components/schemas/Create_vg_company_without_shares_incorporate", "vg.director.appoint_first": "#/components/schemas/Create_vg_director_appoint_first", "vg.foreign_company.register": "#/components/schemas/Create_vg_foreign_company_register", "vg.fund.recognise": "#/components/schemas/Create_vg_fund_recognise", "vg.general_partnership.form": "#/components/schemas/Create_vg_general_partnership_form", "vg.incubator_or_approved_fund.apply": "#/components/schemas/Create_vg_incubator_or_approved_fund_apply", "vg.insurer_spc.incorporate": "#/components/schemas/Create_vg_insurer_spc_incorporate", "vg.insurer_spc.register": "#/components/schemas/Create_vg_insurer_spc_register", "vg.insurer_spc_approval.apply": "#/components/schemas/Create_vg_insurer_spc_approval_apply", "vg.limited_partnership.register": "#/components/schemas/Create_vg_limited_partnership_register", "vg.limited_partnership_name.reserve": "#/components/schemas/Create_vg_limited_partnership_name_reserve", "vg.lp_beneficial_ownership.file": "#/components/schemas/Create_vg_lp_beneficial_ownership_file", "vg.lp_without_legal_personality.register": "#/components/schemas/Create_vg_lp_without_legal_personality_register", "vg.mutual_fund_spc.incorporate": "#/components/schemas/Create_vg_mutual_fund_spc_incorporate", "vg.mutual_fund_spc.register": "#/components/schemas/Create_vg_mutual_fund_spc_register", "vg.mutual_fund_spc_approval.apply": "#/components/schemas/Create_vg_mutual_fund_spc_approval_apply", "vg.npo.register": "#/components/schemas/Create_vg_npo_register", "vg.private_investment_fund.recognise": "#/components/schemas/Create_vg_private_investment_fund_recognise", "vg.private_trust_company.incorporate": "#/components/schemas/Create_vg_private_trust_company_incorporate", "vg.register_of_directors.file": "#/components/schemas/Create_vg_register_of_directors_file", "vg.register_of_members.file": "#/components/schemas/Create_vg_register_of_members_file", "vg.register_of_partners.file": "#/components/schemas/Create_vg_register_of_partners_file", "vg.restricted_name_consent.apply": "#/components/schemas/Create_vg_restricted_name_consent_apply", "vg.restricted_name_consent.request": "#/components/schemas/Create_vg_restricted_name_consent_request", "vg.restricted_purposes_company.incorporate": "#/components/schemas/Create_vg_restricted_purposes_company_incorporate", "vg.segregated_portfolio_company.incorporate": "#/components/schemas/Create_vg_segregated_portfolio_company_incorporate", "vg.trade_licence.apply": "#/components/schemas/Create_vg_trade_licence_apply", "vg.annual_fee.pay": "#/components/schemas/Create_vg_annual_fee_pay", "vg.annual_return.file": "#/components/schemas/Create_vg_annual_return_file", "vg.annual_return_extension.apply": "#/components/schemas/Create_vg_annual_return_extension_apply", "vg.beneficial_ownership.change": "#/components/schemas/Create_vg_beneficial_ownership_change", "vg.beneficial_ownership.request": "#/components/schemas/Create_vg_beneficial_ownership_request", "vg.beneficial_ownership_access_decision.appeal": "#/components/schemas/Create_vg_beneficial_ownership_access_decision_appeal", "vg.beneficial_ownership_access_objection.file": "#/components/schemas/Create_vg_beneficial_ownership_access_objection_file", "vg.beneficial_ownership_copy.request": "#/components/schemas/Create_vg_beneficial_ownership_copy_request", "vg.beneficial_ownership_disclosure_exemption.apply": "#/components/schemas/Create_vg_beneficial_ownership_disclosure_exemption_apply", "vg.beneficial_ownership_disclosure_opposition.apply": "#/components/schemas/Create_vg_beneficial_ownership_disclosure_opposition_apply", "vg.beneficial_ownership_discrepancy.file": "#/components/schemas/Create_vg_beneficial_ownership_discrepancy_file", "vg.beneficial_ownership_exemption.file": "#/components/schemas/Create_vg_beneficial_ownership_exemption_file", "vg.beneficial_ownership_extract.request": "#/components/schemas/Create_vg_beneficial_ownership_extract_request", "vg.beneficial_ownership_objection.file": "#/components/schemas/Create_vg_beneficial_ownership_objection_file", "vg.beneficial_ownership_opposition.file": "#/components/schemas/Create_vg_beneficial_ownership_opposition_file", "vg.bvifars_annual_fee.pay": "#/components/schemas/Create_vg_bvifars_annual_fee_pay", "vg.bvifars_fee.pay": "#/components/schemas/Create_vg_bvifars_fee_pay", "vg.certified_copy.request": "#/components/schemas/Create_vg_certified_copy_request", "vg.company_record.request": "#/components/schemas/Create_vg_company_record_request", "vg.director_annual_return.file": "#/components/schemas/Create_vg_director_annual_return_file", "vg.directors_annual_return.file": "#/components/schemas/Create_vg_directors_annual_return_file", "vg.economic_substance.file": "#/components/schemas/Create_vg_economic_substance_file", "vg.economic_substance_financial_period.change": "#/components/schemas/Create_vg_economic_substance_financial_period_change", "vg.economic_substance_period.change": "#/components/schemas/Create_vg_economic_substance_period_change", "vg.fatca_crs.enrol": "#/components/schemas/Create_vg_fatca_crs_enrol", "vg.fatca_crs.file": "#/components/schemas/Create_vg_fatca_crs_file", "vg.fatca_crs_enrolment.change": "#/components/schemas/Create_vg_fatca_crs_enrolment_change", "vg.fatca_crs_enrolment.deactivate": "#/components/schemas/Create_vg_fatca_crs_enrolment_deactivate", "vg.financial_statements.file": "#/components/schemas/Create_vg_financial_statements_file", "vg.financial_statements_extension.request": "#/components/schemas/Create_vg_financial_statements_extension_request", "vg.foreign_company_annual_fee.pay": "#/components/schemas/Create_vg_foreign_company_annual_fee_pay", "vg.foreign_company_annual_return.file": "#/components/schemas/Create_vg_foreign_company_annual_return_file", "vg.foreign_company_fee.pay": "#/components/schemas/Create_vg_foreign_company_fee_pay", "vg.foreign_company_registered_agent.appoint": "#/components/schemas/Create_vg_foreign_company_registered_agent_appoint", "vg.fund_audit_exemption.apply": "#/components/schemas/Create_vg_fund_audit_exemption_apply", "vg.fund_financial_statements.file": "#/components/schemas/Create_vg_fund_financial_statements_file", "vg.fund_financial_statements_deadline.extend": "#/components/schemas/Create_vg_fund_financial_statements_deadline_extend", "vg.good_standing_certificate.request": "#/components/schemas/Create_vg_good_standing_certificate_request", "vg.insurer_spc_annual_fee.pay": "#/components/schemas/Create_vg_insurer_spc_annual_fee_pay", "vg.limited_partnership_annual_fee.pay": "#/components/schemas/Create_vg_limited_partnership_annual_fee_pay", "vg.limited_partnership_annual_return.file": "#/components/schemas/Create_vg_limited_partnership_annual_return_file", "vg.lp_beneficial_ownership.change": "#/components/schemas/Create_vg_lp_beneficial_ownership_change", "vg.lp_certified_copy.request": "#/components/schemas/Create_vg_lp_certified_copy_request", "vg.lp_fee.pay": "#/components/schemas/Create_vg_lp_fee_pay", "vg.lp_good_standing_certificate.request": "#/components/schemas/Create_vg_lp_good_standing_certificate_request", "vg.mutual_fund_spc_annual_fee.pay": "#/components/schemas/Create_vg_mutual_fund_spc_annual_fee_pay", "vg.npo.renew": "#/components/schemas/Create_vg_npo_renew", "vg.npo_registration.renew": "#/components/schemas/Create_vg_npo_registration_renew", "vg.npo_registration.restore": "#/components/schemas/Create_vg_npo_registration_restore", "vg.registered_agent.appoint": "#/components/schemas/Create_vg_registered_agent_appoint", "vg.registrar_certificate.request": "#/components/schemas/Create_vg_registrar_certificate_request", "vg.registry_inspection.request": "#/components/schemas/Create_vg_registry_inspection_request", "vg.spc_annual_fee.pay": "#/components/schemas/Create_vg_spc_annual_fee_pay", "vg.spc_fee.pay": "#/components/schemas/Create_vg_spc_fee_pay", "vg.spc_insurer_fee.pay": "#/components/schemas/Create_vg_spc_insurer_fee_pay", "vg.spc_mutual_fund_fee.pay": "#/components/schemas/Create_vg_spc_mutual_fund_fee_pay", "vg.status_certificate.request": "#/components/schemas/Create_vg_status_certificate_request", "vg.transitional_filing.file": "#/components/schemas/Create_vg_transitional_filing_file", "vg.transitional_registers.file": "#/components/schemas/Create_vg_transitional_registers_file", "vg.common_seal.record": "#/components/schemas/Create_vg_common_seal_record", "vg.directors_resolution.pass": "#/components/schemas/Create_vg_directors_resolution_pass", "vg.members_meeting.call": "#/components/schemas/Create_vg_members_meeting_call", "vg.members_resolution.pass": "#/components/schemas/Create_vg_members_resolution_pass", "vg.minutes.record": "#/components/schemas/Create_vg_minutes_record", "vg.nominee_details.file": "#/components/schemas/Create_vg_nominee_details_file", "vg.records_location.change": "#/components/schemas/Create_vg_records_location_change", "vg.register.rectify": "#/components/schemas/Create_vg_register_rectify", "vg.register_change.notify": "#/components/schemas/Create_vg_register_change_notify", "vg.alternate_director.appoint": "#/components/schemas/Create_vg_alternate_director_appoint", "vg.alternate_director.remove": "#/components/schemas/Create_vg_alternate_director_remove", "vg.director.appoint": "#/components/schemas/Create_vg_director_appoint", "vg.director.cease": "#/components/schemas/Create_vg_director_cease", "vg.director.change": "#/components/schemas/Create_vg_director_change", "vg.director.remove": "#/components/schemas/Create_vg_director_remove", "vg.director.resign": "#/components/schemas/Create_vg_director_resign", "vg.directors_list.request": "#/components/schemas/Create_vg_directors_list_request", "vg.general_partner.admit": "#/components/schemas/Create_vg_general_partner_admit", "vg.general_partner.appoint": "#/components/schemas/Create_vg_general_partner_appoint", "vg.general_partner.remove": "#/components/schemas/Create_vg_general_partner_remove", "vg.general_partner.withdraw": "#/components/schemas/Create_vg_general_partner_withdraw", "vg.general_partners_list.request": "#/components/schemas/Create_vg_general_partners_list_request", "vg.licensed_director.appoint": "#/components/schemas/Create_vg_licensed_director_appoint", "vg.licensed_director_disclosure.change": "#/components/schemas/Create_vg_licensed_director_disclosure_change", "vg.limited_partner.admit": "#/components/schemas/Create_vg_limited_partner_admit", "vg.limited_partner.withdraw": "#/components/schemas/Create_vg_limited_partner_withdraw", "vg.lp_particulars.change": "#/components/schemas/Create_vg_lp_particulars_change", "vg.nominee_director.appoint": "#/components/schemas/Create_vg_nominee_director_appoint", "vg.nominee_director.change": "#/components/schemas/Create_vg_nominee_director_change", "vg.officer.appoint": "#/components/schemas/Create_vg_officer_appoint", "vg.officer.remove": "#/components/schemas/Create_vg_officer_remove", "vg.partner.change": "#/components/schemas/Create_vg_partner_change", "vg.reserve_director.cease": "#/components/schemas/Create_vg_reserve_director_cease", "vg.reserve_director.nominate": "#/components/schemas/Create_vg_reserve_director_nominate", "vg.authorised_shares.change": "#/components/schemas/Create_vg_authorised_shares_change", "vg.distribution.declare": "#/components/schemas/Create_vg_distribution_declare", "vg.fair_value_appraisal.hold": "#/components/schemas/Create_vg_fair_value_appraisal_hold", "vg.minority_partnership_interests.redeem": "#/components/schemas/Create_vg_minority_partnership_interests_redeem", "vg.minority_share.redeem": "#/components/schemas/Create_vg_minority_share_redeem", "vg.minority_shares.redeem": "#/components/schemas/Create_vg_minority_shares_redeem", "vg.partnership_interest.redeem": "#/components/schemas/Create_vg_partnership_interest_redeem", "vg.partnership_interest.transfer": "#/components/schemas/Create_vg_partnership_interest_transfer", "vg.segregated_portfolio.create": "#/components/schemas/Create_vg_segregated_portfolio_create", "vg.share.allot": "#/components/schemas/Create_vg_share_allot", "vg.share.consolidate": "#/components/schemas/Create_vg_share_consolidate", "vg.share.redeem": "#/components/schemas/Create_vg_share_redeem", "vg.share.repurchase": "#/components/schemas/Create_vg_share_repurchase", "vg.share.subdivide": "#/components/schemas/Create_vg_share_subdivide", "vg.share.transfer": "#/components/schemas/Create_vg_share_transfer", "vg.share_option.grant": "#/components/schemas/Create_vg_share_option_grant", "vg.treasury_share.transfer": "#/components/schemas/Create_vg_treasury_share_transfer", "vg.apostille.request": "#/components/schemas/Create_vg_apostille_request", "vg.charge.change": "#/components/schemas/Create_vg_charge_change", "vg.charge.register": "#/components/schemas/Create_vg_charge_register", "vg.charge.satisfy": "#/components/schemas/Create_vg_charge_satisfy", "vg.company_name.change": "#/components/schemas/Create_vg_company_name_change", "vg.constitution.amend": "#/components/schemas/Create_vg_constitution_amend", "vg.foreign_character_name.change": "#/components/schemas/Create_vg_foreign_character_name_change", "vg.foreign_character_name.deregister": "#/components/schemas/Create_vg_foreign_character_name_deregister", "vg.foreign_character_name.register": "#/components/schemas/Create_vg_foreign_character_name_register", "vg.foreign_character_name.remove": "#/components/schemas/Create_vg_foreign_character_name_remove", "vg.foreign_company.change": "#/components/schemas/Create_vg_foreign_company_change", "vg.foreign_company_name.change": "#/components/schemas/Create_vg_foreign_company_name_change", "vg.foreign_company_particulars.change": "#/components/schemas/Create_vg_foreign_company_particulars_change", "vg.foreign_company_registered_agent.change": "#/components/schemas/Create_vg_foreign_company_registered_agent_change", "vg.lp_agreement.amend": "#/components/schemas/Create_vg_lp_agreement_amend", "vg.lp_charge.change": "#/components/schemas/Create_vg_lp_charge_change", "vg.lp_charge.register": "#/components/schemas/Create_vg_lp_charge_register", "vg.lp_charge.satisfy": "#/components/schemas/Create_vg_lp_charge_satisfy", "vg.lp_name.change": "#/components/schemas/Create_vg_lp_name_change", "vg.lp_registered_agent.change": "#/components/schemas/Create_vg_lp_registered_agent_change", "vg.lp_registered_agent.resign": "#/components/schemas/Create_vg_lp_registered_agent_resign", "vg.lp_registered_agent.transfer_out": "#/components/schemas/Create_vg_lp_registered_agent_transfer_out", "vg.lp_registered_agent_resignation.revoke": "#/components/schemas/Create_vg_lp_registered_agent_resignation_revoke", "vg.lp_registered_office.change": "#/components/schemas/Create_vg_lp_registered_office_change", "vg.lp_registered_particulars.change": "#/components/schemas/Create_vg_lp_registered_particulars_change", "vg.name.change": "#/components/schemas/Create_vg_name_change", "vg.npo.change": "#/components/schemas/Create_vg_npo_change", "vg.partnership_agreement.amend": "#/components/schemas/Create_vg_partnership_agreement_amend", "vg.private_document.legalise": "#/components/schemas/Create_vg_private_document_legalise", "vg.public_document.legalise": "#/components/schemas/Create_vg_public_document_legalise", "vg.registered_agent.change": "#/components/schemas/Create_vg_registered_agent_change", "vg.registered_agent.resign": "#/components/schemas/Create_vg_registered_agent_resign", "vg.registered_agent.transfer_out": "#/components/schemas/Create_vg_registered_agent_transfer_out", "vg.registered_agent_resignation.revoke": "#/components/schemas/Create_vg_registered_agent_resignation_revoke", "vg.registered_office.change": "#/components/schemas/Create_vg_registered_office_change", "vg.segregated_portfolio.remove": "#/components/schemas/Create_vg_segregated_portfolio_remove", "vg.segregated_portfolio.restore": "#/components/schemas/Create_vg_segregated_portfolio_restore", "vg.spc_information.change": "#/components/schemas/Create_vg_spc_information_change", "vg.spc_information_change.notify": "#/components/schemas/Create_vg_spc_information_change_notify", "vg.trade_licence.change": "#/components/schemas/Create_vg_trade_licence_change", "vg.asset.dispose": "#/components/schemas/Create_vg_asset_dispose", "vg.company.consolidate": "#/components/schemas/Create_vg_company_consolidate", "vg.company.continue_in": "#/components/schemas/Create_vg_company_continue_in", "vg.company.continue_out": "#/components/schemas/Create_vg_company_continue_out", "vg.company.convert_to_spc": "#/components/schemas/Create_vg_company_convert_to_spc", "vg.company.merge": "#/components/schemas/Create_vg_company_merge", "vg.company.merge_into_foreign": "#/components/schemas/Create_vg_company_merge_into_foreign", "vg.company.merge_out": "#/components/schemas/Create_vg_company_merge_out", "vg.company.merge_with_subsidiary": "#/components/schemas/Create_vg_company_merge_with_subsidiary", "vg.company_as_spc.register": "#/components/schemas/Create_vg_company_as_spc_register", "vg.continuance_notice.file": "#/components/schemas/Create_vg_continuance_notice_file", "vg.continuation_intention.withdraw": "#/components/schemas/Create_vg_continuation_intention_withdraw", "vg.continuation_notice.revoke": "#/components/schemas/Create_vg_continuation_notice_revoke", "vg.limited_partnership.consolidate": "#/components/schemas/Create_vg_limited_partnership_consolidate", "vg.limited_partnership.continue_in": "#/components/schemas/Create_vg_limited_partnership_continue_in", "vg.limited_partnership.continue_out": "#/components/schemas/Create_vg_limited_partnership_continue_out", "vg.limited_partnership.convert": "#/components/schemas/Create_vg_limited_partnership_convert", "vg.limited_partnership.merge": "#/components/schemas/Create_vg_limited_partnership_merge", "vg.limited_partnership.merge_into_foreign": "#/components/schemas/Create_vg_limited_partnership_merge_into_foreign", "vg.limited_partnership_continuation.revoke": "#/components/schemas/Create_vg_limited_partnership_continuation_revoke", "vg.lp_plan_of_arrangement.file": "#/components/schemas/Create_vg_lp_plan_of_arrangement_file", "vg.lp_scheme_of_arrangement.file": "#/components/schemas/Create_vg_lp_scheme_of_arrangement_file", "vg.plan_of_arrangement.file": "#/components/schemas/Create_vg_plan_of_arrangement_file", "vg.scheme_of_arrangement.file": "#/components/schemas/Create_vg_scheme_of_arrangement_file", "vg.company.restore": "#/components/schemas/Create_vg_company_restore", "vg.company.restore_by_court": "#/components/schemas/Create_vg_company_restore_by_court", "vg.company.wind_up_insolvent": "#/components/schemas/Create_vg_company_wind_up_insolvent", "vg.dormancy.record": "#/components/schemas/Create_vg_dormancy_record", "vg.foreign_company.deregister": "#/components/schemas/Create_vg_foreign_company_deregister", "vg.foreign_company.restore": "#/components/schemas/Create_vg_foreign_company_restore", "vg.general_partnership.dissolve": "#/components/schemas/Create_vg_general_partnership_dissolve", "vg.limited_partnership.restore": "#/components/schemas/Create_vg_limited_partnership_restore", "vg.limited_partnership.restore_by_court": "#/components/schemas/Create_vg_limited_partnership_restore_by_court", "vg.limited_partnership.strike_off": "#/components/schemas/Create_vg_limited_partnership_strike_off", "vg.limited_partnership.wind_up": "#/components/schemas/Create_vg_limited_partnership_wind_up", "vg.limited_partnership.wind_up_insolvent": "#/components/schemas/Create_vg_limited_partnership_wind_up_insolvent", "vg.limited_partnership_insolvency.file": "#/components/schemas/Create_vg_limited_partnership_insolvency_file", "vg.liquidation.commence": "#/components/schemas/Create_vg_liquidation_commence", "vg.liquidation.complete": "#/components/schemas/Create_vg_liquidation_complete", "vg.liquidation.remove": "#/components/schemas/Create_vg_liquidation_remove", "vg.liquidation_insolvency.file": "#/components/schemas/Create_vg_liquidation_insolvency_file", "vg.liquidation_notice.publish": "#/components/schemas/Create_vg_liquidation_notice_publish", "vg.strike_off_notice.respond": "#/components/schemas/Create_vg_strike_off_notice_respond", "us.bank_account_package.prepare": "#/components/schemas/Create_us_bank_account_package_prepare", "us.bea_survey.file": "#/components/schemas/Create_us_bea_survey_file", "us.board_consent.adopt": "#/components/schemas/Create_us_board_consent_adopt", "us.bylaws.adopt": "#/components/schemas/Create_us_bylaws_adopt", "us.cooperative.form": "#/components/schemas/Create_us_cooperative_form", "us.corporation.incorporate": "#/components/schemas/Create_us_corporation_incorporate", "us.ein.request": "#/components/schemas/Create_us_ein_request", "us.ein_foreign_party.request": "#/components/schemas/Create_us_ein_foreign_party_request", "us.entity_classification.elect": "#/components/schemas/Create_us_entity_classification_elect", "us.expedite.request": "#/components/schemas/Create_us_expedite_request", "us.foundation.form": "#/components/schemas/Create_us_foundation_form", "us.founder_stock.issue": "#/components/schemas/Create_us_founder_stock_issue", "us.general_partnership.register": "#/components/schemas/Create_us_general_partnership_register", "us.incorporator_consent.adopt": "#/components/schemas/Create_us_incorporator_consent_adopt", "us.itin.apply": "#/components/schemas/Create_us_itin_apply", "us.llc.form": "#/components/schemas/Create_us_llc_form", "us.llp.register": "#/components/schemas/Create_us_llp_register", "us.lp.form": "#/components/schemas/Create_us_lp_form", "us.name.reserve": "#/components/schemas/Create_us_name_reserve", "us.name_reservation.cancel": "#/components/schemas/Create_us_name_reservation_cancel", "us.name_reservation.transfer": "#/components/schemas/Create_us_name_reservation_transfer", "us.operating_agreement.adopt": "#/components/schemas/Create_us_operating_agreement_adopt", "us.partnership_agreement.adopt": "#/components/schemas/Create_us_partnership_agreement_adopt", "us.partnership_authority.file": "#/components/schemas/Create_us_partnership_authority_file", "us.s_corp_election.file": "#/components/schemas/Create_us_s_corp_election_file", "us.section_83b_election.file": "#/components/schemas/Create_us_section_83b_election_file", "us.series.convert": "#/components/schemas/Create_us_series_convert", "us.series.register": "#/components/schemas/Create_us_series_register", "us.state_business_licence.register": "#/components/schemas/Create_us_state_business_licence_register", "us.state_tax.register": "#/components/schemas/Create_us_state_tax_register", "us.statutory_trust.form": "#/components/schemas/Create_us_statutory_trust_form", "us.tax_exemption.apply": "#/components/schemas/Create_us_tax_exemption_apply", "us.trade_name.assign": "#/components/schemas/Create_us_trade_name_assign", "us.trade_name.cancel": "#/components/schemas/Create_us_trade_name_cancel", "us.trade_name.register": "#/components/schemas/Create_us_trade_name_register", "us.trade_name.renew": "#/components/schemas/Create_us_trade_name_renew", "us.trust_agreement.adopt": "#/components/schemas/Create_us_trust_agreement_adopt", "us.unincorporated_association.form": "#/components/schemas/Create_us_unincorporated_association_form", "us.annual_accounts.prepare": "#/components/schemas/Create_us_annual_accounts_prepare", "us.annual_list.file": "#/components/schemas/Create_us_annual_list_file", "us.annual_report.file": "#/components/schemas/Create_us_annual_report_file", "us.annual_tax.pay": "#/components/schemas/Create_us_annual_tax_pay", "us.apostille.request": "#/components/schemas/Create_us_apostille_request", "us.bea_quarterly_survey.file": "#/components/schemas/Create_us_bea_quarterly_survey_file", "us.boi_report.change": "#/components/schemas/Create_us_boi_report_change", "us.boi_report.file": "#/components/schemas/Create_us_boi_report_file", "us.certified_copy.request": "#/components/schemas/Create_us_certified_copy_request", "us.commerce_tax_exemption.file": "#/components/schemas/Create_us_commerce_tax_exemption_file", "us.commerce_tax_return.file": "#/components/schemas/Create_us_commerce_tax_return_file", "us.exempt_annual_report.file": "#/components/schemas/Create_us_exempt_annual_report_file", "us.exempt_postcard.file": "#/components/schemas/Create_us_exempt_postcard_file", "us.exempt_return.file": "#/components/schemas/Create_us_exempt_return_file", "us.exempt_return_extension.file": "#/components/schemas/Create_us_exempt_return_extension_file", "us.fbar.file": "#/components/schemas/Create_us_fbar_file", "us.federal_return.file": "#/components/schemas/Create_us_federal_return_file", "us.federal_return_extension.file": "#/components/schemas/Create_us_federal_return_extension_file", "us.financial_statements.file": "#/components/schemas/Create_us_financial_statements_file", "us.foreign_annual_report.file": "#/components/schemas/Create_us_foreign_annual_report_file", "us.form_1042.file": "#/components/schemas/Create_us_form_1042_file", "us.form_1099.file": "#/components/schemas/Create_us_form_1099_file", "us.form_1120f.file": "#/components/schemas/Create_us_form_1120f_file", "us.form_5472.file": "#/components/schemas/Create_us_form_5472_file", "us.foundation_annual_report.file": "#/components/schemas/Create_us_foundation_annual_report_file", "us.franchise_tax.pay": "#/components/schemas/Create_us_franchise_tax_pay", "us.franchise_tax_installment.pay": "#/components/schemas/Create_us_franchise_tax_installment_pay", "us.franchise_tax_report.file": "#/components/schemas/Create_us_franchise_tax_report_file", "us.good_standing.request": "#/components/schemas/Create_us_good_standing_request", "us.irs_authorization.file": "#/components/schemas/Create_us_irs_authorization_file", "us.irs_authorization.revoke": "#/components/schemas/Create_us_irs_authorization_revoke", "us.llp_annual_report.file": "#/components/schemas/Create_us_llp_annual_report_file", "us.mail.scan": "#/components/schemas/Create_us_mail_scan", "us.nonprofit_annual_report.file": "#/components/schemas/Create_us_nonprofit_annual_report_file", "us.ny_llcta_disclosure.change": "#/components/schemas/Create_us_ny_llcta_disclosure_change", "us.ny_llcta_disclosure.file": "#/components/schemas/Create_us_ny_llcta_disclosure_file", "us.registered_agent.appoint": "#/components/schemas/Create_us_registered_agent_appoint", "us.registered_agent.resign": "#/components/schemas/Create_us_registered_agent_resign", "us.service_of_process.forward": "#/components/schemas/Create_us_service_of_process_forward", "us.statutory_trust_annual_report.file": "#/components/schemas/Create_us_statutory_trust_annual_report_file", "us.tax_return_extension.file": "#/components/schemas/Create_us_tax_return_extension_file", "us.transparency_standards.adopt": "#/components/schemas/Create_us_transparency_standards_adopt", "us.transparency_standards.renew": "#/components/schemas/Create_us_transparency_standards_renew", "us.transparency_standards.restore": "#/components/schemas/Create_us_transparency_standards_restore", "us.unclaimed_property.file": "#/components/schemas/Create_us_unclaimed_property_file", "us.annual_meeting.hold": "#/components/schemas/Create_us_annual_meeting_hold", "us.benefit_report.file": "#/components/schemas/Create_us_benefit_report_file", "us.board_resolution.adopt": "#/components/schemas/Create_us_board_resolution_adopt", "us.bylaws.amend": "#/components/schemas/Create_us_bylaws_amend", "us.defective_act.ratify": "#/components/schemas/Create_us_defective_act_ratify", "us.distribution.approve": "#/components/schemas/Create_us_distribution_approve", "us.dividend.declare": "#/components/schemas/Create_us_dividend_declare", "us.member_consent.adopt": "#/components/schemas/Create_us_member_consent_adopt", "us.minutes.record": "#/components/schemas/Create_us_minutes_record", "us.operating_agreement.amend": "#/components/schemas/Create_us_operating_agreement_amend", "us.register.change": "#/components/schemas/Create_us_register_change", "us.stockholder_consent.adopt": "#/components/schemas/Create_us_stockholder_consent_adopt", "us.director.appoint": "#/components/schemas/Create_us_director_appoint", "us.director.remove": "#/components/schemas/Create_us_director_remove", "us.director.resign": "#/components/schemas/Create_us_director_resign", "us.incumbency_certificate.issue": "#/components/schemas/Create_us_incumbency_certificate_issue", "us.irs_address.change": "#/components/schemas/Create_us_irs_address_change", "us.nominee_arrangement.declare": "#/components/schemas/Create_us_nominee_arrangement_declare", "us.officer.appoint": "#/components/schemas/Create_us_officer_appoint", "us.officer.remove": "#/components/schemas/Create_us_officer_remove", "us.officer.resign": "#/components/schemas/Create_us_officer_resign", "us.responsible_party.change": "#/components/schemas/Create_us_responsible_party_change", "us.secretary_certificate.issue": "#/components/schemas/Create_us_secretary_certificate_issue", "us.trustee.appoint": "#/components/schemas/Create_us_trustee_appoint", "us.trustee.change": "#/components/schemas/Create_us_trustee_change", "us.authorised_share.increase": "#/components/schemas/Create_us_authorised_share_increase", "us.authorised_share.reduce": "#/components/schemas/Create_us_authorised_share_reduce", "us.blue_sky_notice.file": "#/components/schemas/Create_us_blue_sky_notice_file", "us.form_3921.file": "#/components/schemas/Create_us_form_3921_file", "us.form_d.file": "#/components/schemas/Create_us_form_d_file", "us.option.grant": "#/components/schemas/Create_us_option_grant", "us.option_plan.adopt": "#/components/schemas/Create_us_option_plan_adopt", "us.preferred_series.change": "#/components/schemas/Create_us_preferred_series_change", "us.preferred_series.designate": "#/components/schemas/Create_us_preferred_series_designate", "us.share.cancel": "#/components/schemas/Create_us_share_cancel", "us.share.consolidate": "#/components/schemas/Create_us_share_consolidate", "us.share.issue": "#/components/schemas/Create_us_share_issue", "us.share.repurchase": "#/components/schemas/Create_us_share_repurchase", "us.share.subdivide": "#/components/schemas/Create_us_share_subdivide", "us.share.transfer": "#/components/schemas/Create_us_share_transfer", "us.share_valuation.request": "#/components/schemas/Create_us_share_valuation_request", "us.charter.amend": "#/components/schemas/Create_us_charter_amend", "us.filing.rectify": "#/components/schemas/Create_us_filing_rectify", "us.llc.convert_to_dao": "#/components/schemas/Create_us_llc_convert_to_dao", "us.name.change": "#/components/schemas/Create_us_name_change", "us.registered_agent.change": "#/components/schemas/Create_us_registered_agent_change", "us.registered_office.change": "#/components/schemas/Create_us_registered_office_change", "us.smart_contract_identifier.admit": "#/components/schemas/Create_us_smart_contract_identifier_admit", "us.branch.register": "#/components/schemas/Create_us_branch_register", "us.entity.continue_in": "#/components/schemas/Create_us_entity_continue_in", "us.entity.continue_out": "#/components/schemas/Create_us_entity_continue_out", "us.entity.convert": "#/components/schemas/Create_us_entity_convert", "us.entity.merge": "#/components/schemas/Create_us_entity_merge", "us.entity_division.file": "#/components/schemas/Create_us_entity_division_file", "us.foreign_qualification.file": "#/components/schemas/Create_us_foreign_qualification_file", "us.temporary_transfer.extend": "#/components/schemas/Create_us_temporary_transfer_extend", "us.temporary_transfer.file": "#/components/schemas/Create_us_temporary_transfer_file", "us.temporary_transfer.withdraw": "#/components/schemas/Create_us_temporary_transfer_withdraw", "us.administrative_dissolution.record": "#/components/schemas/Create_us_administrative_dissolution_record", "us.corporation.dissolve": "#/components/schemas/Create_us_corporation_dissolve", "us.dissolution.revoke": "#/components/schemas/Create_us_dissolution_revoke", "us.ein.deactivate": "#/components/schemas/Create_us_ein_deactivate", "us.entity.restore": "#/components/schemas/Create_us_entity_restore", "us.final_payroll_return.file": "#/components/schemas/Create_us_final_payroll_return_file", "us.final_return.file": "#/components/schemas/Create_us_final_return_file", "us.foreign_qualification.withdraw": "#/components/schemas/Create_us_foreign_qualification_withdraw", "us.inactive_status.record": "#/components/schemas/Create_us_inactive_status_record", "us.irs_dissolution.notify": "#/components/schemas/Create_us_irs_dissolution_notify", "us.llc.cancel": "#/components/schemas/Create_us_llc_cancel", "us.lp.cancel": "#/components/schemas/Create_us_lp_cancel", "us.statutory_trust.cancel": "#/components/schemas/Create_us_statutory_trust_cancel" } } }, "Account": { "type": "object", "description": "A customer of Entiva: a person running their own companies, or a business. Every entity, person, key and action belongs to one account.", "properties": { "id": { "type": "string", "pattern": "^acct_" }, "object": { "const": "account" }, "type": { "type": "string", "enum": [ "individual", "business" ], "description": "A person using Entiva for their own companies, or a business." }, "display_name": { "type": "string", "description": "Shown in the dashboard and on emails to the people you add." }, "country": { "type": "string", "description": "ISO 3166 country of the person or business." }, "business_profile": { "type": "object", "description": "For business accounts: legal_name, registration_number, jurisdiction, website and what the business does." }, "owner": { "type": "string", "pattern": "^usr_", "description": "The user who owns the account. Ownership can be transferred to another verified admin." }, "status": { "type": "string", "enum": [ "sandbox", "pending_verification", "active", "restricted", "closed" ], "description": "sandbox until the owner claims and activates the account. restricted while something required is past due." }, "capabilities": { "type": "object", "description": "live_actions, formations, agent_keys and connected_accounts, each inactive, pending or active." }, "requirements": { "$ref": "#/components/schemas/AccountRequirements", "description": "What is needed, and by when, to activate the account or keep it active." }, "settings": { "type": "object", "description": "approval_policy (a second approver above an amount), default_currency, timezone and notification_email." }, "plan": { "type": "string", "enum": [ "free", "run", "group", "platform" ], "description": "The plan the account is on." }, "platform": { "type": "string", "pattern": "^acct_", "description": "The platform that created this account, if one did." }, "claim_url": { "type": "string", "description": "Sandbox accounts an agent created: the link the owner opens to claim the account." }, "terms_acceptance": { "type": "object", "description": "date, ip and user. Set only when a person accepts the terms in the hosted flow." }, "created": { "type": "integer", "description": "Unix time" }, "livemode": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "id", "object" ] }, "AccountRequirements": { "type": "object", "description": "What an account still needs. Each entry is a dotted path such as owner.verification or business_profile.registration_number.", "properties": { "currently_due": { "type": "array", "items": { "type": "string" }, "description": "Needed now to activate the account or keep it active." }, "eventually_due": { "type": "array", "items": { "type": "string" }, "description": "Will be needed later, for example when you add a jurisdiction or reach a volume." }, "past_due": { "type": "array", "items": { "type": "string" }, "description": "Overdue. Live actions are paused until these are cleared." }, "pending_verification": { "type": "array", "items": { "type": "string" }, "description": "Submitted and being checked." }, "disabled_reason": { "type": "string", "enum": [ "requirements.past_due", "requirements.pending_verification", "under_review", "rejected.sanctions", "rejected.fraud", "rejected.other" ], "description": "Why live actions are off, if they are." }, "current_deadline": { "type": "integer", "description": "When currently_due becomes past_due." } } }, "Signup": { "type": "object", "description": "What POST /v1/signups returns: a sandbox account, its owner and, when an agent signed up for a person, a test key and the link the person claims the account with.", "properties": { "account": { "$ref": "#/components/schemas/Account", "description": "A sandbox account. Test mode works at once." }, "user": { "$ref": "#/components/schemas/User", "description": "The owner, pending until they confirm their email." }, "claim_url": { "type": "string", "description": "The link the owner opens to confirm their email, verify their identity and accept the terms. Entiva also emails it." }, "test_key": { "type": "string", "description": "Only when an agent signed up: an ak_test_ key, so the agent can work in the sandbox straight away." } } }, "User": { "type": "object", "description": "A person who signs in to Entiva. A user is linked to a person record, so the identity they verify at sign-up is reused when they become a director or shareholder.", "properties": { "id": { "type": "string", "pattern": "^usr_" }, "object": { "const": "user" }, "email": { "type": "string" }, "email_verified": { "type": "boolean" }, "name": { "type": "string" }, "phone": { "type": "string", "description": "E.164." }, "phone_verified": { "type": "boolean" }, "person": { "type": "string", "pattern": "^per_", "description": "The person record for this user." }, "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/Membership" }, "description": "The accounts this user belongs to and their role in each." }, "authentication": { "type": "object", "description": "passkeys (count), totp, sso and last_login. Users sign in with a passkey or an emailed link, and SSO on the Group plan." }, "status": { "type": "string", "enum": [ "pending_email", "active", "locked", "deactivated" ] }, "created": { "type": "integer", "description": "Unix time" } }, "required": [ "id", "object" ] }, "Membership": { "type": "object", "description": "A user's role in one account.", "properties": { "account": { "type": "string", "pattern": "^acct_" }, "role": { "type": "string", "enum": [ "owner", "admin", "approver", "member", "developer", "billing", "viewer" ], "description": "See Users and roles." }, "entities": { "type": "array", "items": { "type": "string", "pattern": "^ent_" }, "description": "Limits the user to these entities. Empty means every entity." }, "added_by": { "type": "string", "pattern": "^usr_" }, "created": { "type": "integer", "description": "Unix time" } } }, "Invitation": { "type": "object", "description": "An invitation for a teammate to join the account with a role.", "properties": { "id": { "type": "string", "pattern": "^inv_" }, "object": { "const": "invitation" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "approver", "member", "developer", "billing", "viewer" ] }, "entities": { "type": "array", "items": { "type": "string", "pattern": "^ent_" }, "description": "Limits the new user to these entities." }, "invited_by": { "type": "string", "pattern": "^usr_", "description": "Or the agent key, with its mandate." }, "status": { "type": "string", "enum": [ "pending", "accepted", "expired", "revoked" ] }, "accept_url": { "type": "string" }, "expires_at": { "type": "integer", "description": "Seven days after it is sent." } }, "required": [ "id", "object" ] }, "ApiKey": { "type": "object", "description": "A key for the API. The secret is shown once, when the key is created.", "properties": { "id": { "type": "string", "pattern": "^key_" }, "object": { "const": "api_key" }, "type": { "type": "string", "enum": [ "secret", "restricted", "agent" ], "description": "secret has full access. restricted carries scopes. agent is bound to a mandate." }, "mode": { "type": "string", "enum": [ "test", "live" ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "For restricted keys, for example entities:read, actions:write or people:write." }, "mandate": { "type": "string", "pattern": "^man_", "description": "For agent keys: the mandate that limits what the agent may do and spend." }, "secret": { "type": "string", "description": "Returned once on creation." }, "redacted": { "type": "string", "description": "For example sk_live_...4f2a." }, "status": { "type": "string", "enum": [ "active", "expiring", "revoked" ] }, "created_by": { "type": "string", "pattern": "^usr_" }, "last_used": { "type": "integer", "description": "Unix time" }, "expires_at": { "type": "integer", "description": "Unix time" } }, "required": [ "id", "object" ] }, "AccountLink": { "type": "object", "description": "A single-use link to a hosted Entiva page where a person does what only they can do.", "properties": { "id": { "type": "string", "pattern": "^link_" }, "object": { "const": "account_link" }, "account": { "type": "string", "pattern": "^acct_" }, "person": { "type": "string", "pattern": "^per_", "description": "For identity_verification and signature links." }, "type": { "type": "string", "enum": [ "account_claim", "account_onboarding", "account_update", "identity_verification", "signature" ] }, "url": { "type": "string" }, "return_url": { "type": "string", "description": "Where the person goes when they finish." }, "refresh_url": { "type": "string", "description": "Where they go if the link has expired, so you can create a new one." }, "expires_at": { "type": "integer", "description": "Ten minutes after creation." } }, "required": [ "id", "object" ] }, "VerificationCheck": { "type": "object", "description": "One check inside a verification.", "properties": { "type": { "type": "string", "enum": [ "document", "selfie_liveness", "government_eid", "database", "proof_of_address", "address_database", "sanctions", "pep", "adverse_media", "source_of_funds", "source_of_wealth", "registry_idv", "business_registry" ], "description": "See Checks." }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "needs_review", "not_applicable" ] }, "provider": { "type": "string" }, "completed_at": { "type": "integer", "description": "Unix time" }, "details": { "type": "object", "description": "Check-specific results, such as the document type and issuing country, or the list a screening match came from." } } }, "VerifiedOutputs": { "type": "object", "description": "The facts a verification established.", "properties": { "legal_name": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "nationality": { "type": "string" }, "residential_address": { "$ref": "#/components/schemas/Address" }, "address_source": { "type": "string", "enum": [ "document", "database", "government_eid" ] }, "document": { "type": "object", "description": "type, issuing_country, number_last4 and expiry_date." } } }, "ShareClass": { "type": "object", "description": "A class of shares (or of membership or partnership interests) in an entity. Every share action names the class it affects; changing a class's rights needs that class's own consent.", "properties": { "id": { "type": "string", "pattern": "^shc_" }, "object": { "const": "share_class" }, "entity": { "type": "string", "pattern": "^ent_" }, "name": { "type": "string", "description": "As the constitution names it, for example Ordinary or Series A Preferred." }, "currency": { "type": "string", "description": "ISO 4217. Empty for no-par shares where the law allows them." }, "par_value": { "$ref": "#/components/schemas/Money", "description": "Nominal value per share; absent for no-par shares." }, "voting": { "type": "string", "enum": [ "full", "limited", "none" ], "description": "Votes at general meetings." }, "dividend": { "type": "string", "enum": [ "ordinary", "preferred", "none" ], "description": "Rank for dividends." }, "capital": { "type": "string", "enum": [ "ordinary", "preferred", "none" ], "description": "Rank for capital on a winding up or return of capital." }, "redeemable": { "type": "boolean" }, "convertible": { "type": "boolean" }, "rights_text": { "type": "string", "description": "The rights as the constitution states them." }, "authorised": { "type": "integer", "description": "Maximum the entity may issue, where the jurisdiction or constitution sets one." }, "issued": { "type": "integer", "description": "Shares in issue, from the register of members." }, "status": { "type": "string", "enum": [ "active", "redeemed", "cancelled" ] }, "created": { "type": "integer", "description": "Unix time" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "id", "object" ] }, "SigningAuthority": { "type": "object", "description": "How an entity signs. Every signature with signs_for: entity is checked against it; a signature the rule does not allow is refused.", "properties": { "rule": { "type": "string", "enum": [ "any_one_director", "two_directors", "director_and_secretary", "director_and_witness", "common_seal", "sole_director", "any_general_partner", "any_member", "any_manager", "named_signatories", "as_resolution" ], "description": "Taken from the constitution, or set by a board resolution." }, "signatories": { "type": "array", "items": { "type": "string", "pattern": "^per_" }, "description": "For named_signatories: the people allowed to sign, each verified." }, "limits": { "type": "object", "description": "Optional limits by action type or amount, for example two signatories above a value." }, "source": { "type": "string", "enum": [ "constitution", "resolution", "law" ] }, "source_document": { "type": "string", "pattern": "^doc_", "description": "The constitution or resolution it comes from." }, "effective_from": { "type": "string", "format": "date" } } }, "GoverningDocument": { "type": "object", "description": "A document that sets an entity's own rules: its articles or constitution, a shareholders' agreement, an LLC or partnership agreement. Entiva reads it into the entity's governance profile, which a person reviews before it takes effect.", "properties": { "id": { "type": "string", "pattern": "^gdoc_" }, "object": { "const": "governing_document" }, "entity": { "type": "string", "pattern": "^ent_" }, "type": { "type": "string", "enum": [ "articles", "memorandum", "constitution", "bylaws", "llc_agreement", "partnership_agreement", "shareholders_agreement", "investors_rights_agreement", "voting_agreement", "board_resolution" ], "description": "Articles and constitutions bind by law; agreements bind the parties by contract." }, "document": { "type": "string", "pattern": "^doc_", "description": "The file." }, "origin": { "type": "string", "enum": [ "generated", "uploaded" ], "description": "generated: Entiva drafted it from the entity's governance at formation or on an amendment, so its rules are confirmed at once. uploaded: read into governance for a person to review." }, "parties": { "type": "array", "items": { "type": "string", "pattern": "^per_" }, "description": "For agreements: who is bound." }, "effective_from": { "type": "string", "format": "date" }, "supersedes": { "type": "string", "pattern": "^gdoc_", "description": "The version this one replaces." }, "status": { "type": "string", "enum": [ "processing", "extracted", "in_review", "confirmed", "superseded" ], "description": "Extracted rules apply only once a person confirms them." }, "extracted": { "type": "object", "description": "What was read from it, clause by clause, before review: share_classes, approval_rules, signing_authority, board, transfer_restrictions, appointment_rights." }, "created": { "type": "integer", "description": "Unix time" } }, "required": [ "id", "object" ] }, "Governance": { "type": "object", "description": "An entity's own rules, built from the law's defaults and its confirmed governing documents. Set at formation for entities Entiva forms (the articles and any shareholders' agreement are generated from it); extracted and reviewed for entities that move in; updated by every amendment. Every action's approvals and signatures are resolved against it.", "properties": { "entity": { "type": "string", "pattern": "^ent_" }, "share_classes": { "type": "array", "items": { "type": "string", "pattern": "^shc_" }, "description": "From the articles, and the register of members." }, "signing_authority": { "$ref": "#/components/schemas/SigningAuthority" }, "board": { "type": "object", "description": "min_directors, max_directors, quorum, chair_casting_vote, written_resolution (unanimous or majority), alternates_allowed." }, "approval_rules": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalRule" }, "description": "Rules stricter than the law, from the articles, and reserved matters from shareholders' agreements." }, "transfer_restrictions": { "type": "object", "description": "pre_emption_on_issue, pre_emption_on_transfer, right_of_first_refusal, board_consent_to_transfer, drag_along, tag_along, lock_up_until." }, "appointment_rights": { "type": "array", "items": { "type": "object" }, "description": "Who may appoint or remove directors: holder (person or class), seats." }, "sources": { "type": "array", "items": { "type": "string", "pattern": "^gdoc_" }, "description": "The confirmed documents it was built from." }, "confirmed_by": { "type": "string", "pattern": "^usr_" }, "confirmed_at": { "type": "integer", "description": "Unix time" } } }, "ApprovalRule": { "type": "object", "description": "One authorisation requirement for a kind of action, with where it comes from.", "properties": { "matters": { "type": "array", "items": { "type": "string" }, "description": "Action type patterns it covers, such as *.share.allot or *.director.appoint, or a matter such as issue_shares, sell_assets, borrow_over." }, "body": { "type": "string", "enum": [ "board", "members", "class_members", "investors", "named_parties", "partners", "general_partners", "limited_partners", "trustees", "governing_body", "creditors", "court", "regulator" ] }, "threshold": { "type": "string", "enum": [ "unanimous", "special", "majority", "sole", "any_one", "each", "consent" ] }, "percent": { "type": "integer", "description": "Where a percentage applies." }, "class": { "type": "string", "pattern": "^shc_", "description": "For class consents." }, "parties": { "type": "array", "items": { "type": "string", "pattern": "^per_" }, "description": "For named investor consents." }, "condition": { "type": "string", "description": "When it applies, for example above an amount." }, "source": { "type": "string", "enum": [ "statute", "articles", "shareholders_agreement", "other_agreement" ], "description": "Statute and articles bind by law; agreements bind by contract." }, "document": { "type": "string", "pattern": "^gdoc_" }, "clause": { "type": "string", "description": "For example art. 14.2 or clause 8.1(c)." } } }, "Authority": { "type": "object", "description": "A person's legal authority to instruct actions for an entity: their capacity, the evidence for it and its scope. Every action records the authority it was instructed under; a mandate can only be granted by someone who holds one.", "properties": { "id": { "type": "string", "pattern": "^auth_" }, "object": { "const": "authority" }, "entity": { "type": "string", "pattern": "^ent_" }, "person": { "type": "string", "pattern": "^per_", "description": "Verified to the level the capacity needs." }, "user": { "type": "string", "pattern": "^usr_", "description": "The login that acts on it, if the person signs in." }, "capacity": { "type": "string", "enum": [ "founder", "director", "officer", "company_secretary", "member", "general_partner", "manager", "trustee", "liquidator", "authorised_representative", "attorney" ] }, "evidence": { "type": "string", "enum": [ "founder_consent", "register_of_directors", "register_of_officers", "register_of_members", "board_resolution", "power_of_attorney", "court_order", "appointment_document" ], "description": "Directors and officers are checked against the statutory register Entiva keeps; anyone else needs a board resolution or power of attorney." }, "document": { "type": "string", "pattern": "^doc_", "description": "The resolution, power of attorney or order." }, "scope": { "type": "array", "items": { "type": "string" }, "description": "Action type patterns it covers, for example hk.share.* or *. A board resolution can limit it." }, "limit": { "$ref": "#/components/schemas/Money", "description": "Optional ceiling per action." }, "valid_until": { "type": "string", "format": "date" }, "status": { "type": "string", "enum": [ "pending_evidence", "active", "revoked", "expired" ], "description": "Active only once the evidence is checked." }, "created": { "type": "integer", "description": "Unix time" } }, "required": [ "id", "object" ] }, "ScreeningAlert": { "type": "object", "description": "A possible match for a person on a sanctions, politically exposed person or adverse media list. Every verified person is screened again every day.", "properties": { "id": { "type": "string", "pattern": "^scr_" }, "object": { "const": "screening_alert" }, "person": { "type": "string", "pattern": "^per_" }, "list": { "type": "string", "enum": [ "sanctions", "pep", "adverse_media" ] }, "match": { "type": "object", "description": "name, source list, strength (low, medium or high) and a link to the entry." }, "status": { "type": "string", "enum": [ "open", "cleared", "confirmed" ], "description": "Entiva's compliance team reviews every alert. Open sanctions alerts pause live actions that involve the person." }, "opened_at": { "type": "integer", "description": "Unix time" }, "resolved_at": { "type": "integer", "description": "Unix time" } }, "required": [ "id", "object" ] }, "Event": { "type": "object", "description": "Something that happened, delivered to your webhook endpoints and listed for 30 days.", "properties": { "id": { "type": "string", "pattern": "^evt_" }, "object": { "const": "event" }, "type": { "type": "string", "description": "For example verification.verified." }, "data": { "type": "object", "description": "object: the object as it is after the event." }, "request": { "type": "object", "description": "id and idempotency_key of the API request that caused it, if one did." }, "created": { "type": "integer", "description": "Unix time" }, "livemode": { "type": "boolean" } }, "required": [ "id", "object" ] }, "AuditEvent": { "type": "object", "description": "Who did what: every request by a user, key or agent, kept for the life of the account.", "properties": { "id": { "type": "string", "pattern": "^aud_" }, "object": { "type": "string", "description": "The id acted on." }, "actor": { "type": "object", "description": "type (user, api_key, agent or entiva), id, and the mandate an agent acted under." }, "action": { "type": "string", "description": "For example action.approved, api_key.created or user.role_changed." }, "ip": { "type": "string" }, "created": { "type": "integer", "description": "Unix time" } }, "required": [ "id", "object" ] } } } }