2018 lines
63 KiB
JSON
2018 lines
63 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "InvestMoz — private existing-business intake",
|
|
"version": "1.2.0",
|
|
"description": "Internal preparation and review only. No publication, certification, legal transfer, NDA, payment or external CRM operation."
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "/api/v1/existing-business"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/listings": {
|
|
"get": {
|
|
"summary": "List own active records, 20 per page",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"records",
|
|
"management",
|
|
"modalities"
|
|
],
|
|
"properties": {
|
|
"records": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Business"
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"management": {
|
|
"type": "boolean"
|
|
},
|
|
"modalities": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"summary": "Create private draft",
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Business"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"modality",
|
|
"classification",
|
|
"reason",
|
|
"payload"
|
|
],
|
|
"properties": {
|
|
"modality": {
|
|
"type": "string"
|
|
},
|
|
"classification": {
|
|
"enum": [
|
|
"internal",
|
|
"confidential",
|
|
"restricted"
|
|
]
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 1000
|
|
},
|
|
"payload": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"description": "Proposed title"
|
|
},
|
|
"description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10000,
|
|
"description": "Private description"
|
|
},
|
|
"declared_reason": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Reason and objective"
|
|
},
|
|
"source_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Source reference"
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10,
|
|
"format": "date",
|
|
"description": "Declared expiry"
|
|
},
|
|
"proponent_type": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"person",
|
|
"organization",
|
|
null
|
|
],
|
|
"description": "Applicant type"
|
|
},
|
|
"proponent_name": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 200,
|
|
"description": "Name"
|
|
},
|
|
"tax_identifier": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 50,
|
|
"description": "Tax identifier"
|
|
},
|
|
"contact_email": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 254,
|
|
"description": "Contact email"
|
|
},
|
|
"contact_phone": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 40,
|
|
"description": "Phone"
|
|
},
|
|
"country": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2,
|
|
"description": "Country (two-letter code)"
|
|
},
|
|
"acting_capacity": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"holder",
|
|
"representative",
|
|
null
|
|
],
|
|
"description": "Acting capacity"
|
|
},
|
|
"declared_holder": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 200,
|
|
"description": "Declared holder"
|
|
},
|
|
"mandate_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 500,
|
|
"description": "Mandate reference"
|
|
},
|
|
"mandate_valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10,
|
|
"format": "date",
|
|
"description": "Mandate expiry"
|
|
},
|
|
"legitimacy_declaration": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 3,
|
|
"enum": [
|
|
"yes",
|
|
"no",
|
|
null
|
|
],
|
|
"description": "I declare authority to submit"
|
|
},
|
|
"asking_value": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 24,
|
|
"description": "Asking value"
|
|
},
|
|
"currency": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 3,
|
|
"description": "Currency (three-letter code)"
|
|
},
|
|
"value_nature": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"asking",
|
|
"indicative",
|
|
"appraised",
|
|
null
|
|
],
|
|
"description": "Value basis"
|
|
},
|
|
"equity_percentage": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 8,
|
|
"description": "Available equity (%)"
|
|
},
|
|
"funds_use": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Use of funds"
|
|
},
|
|
"location_notes": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Declared location (private)"
|
|
},
|
|
"asset_notes": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Declared assets and rights summary"
|
|
},
|
|
"document_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Document references (not validated files)"
|
|
},
|
|
"wizard_version": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"1",
|
|
null
|
|
]
|
|
},
|
|
"wizard_step": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"pattern": "^[1-8]$"
|
|
}
|
|
}
|
|
},
|
|
"sector_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Existing active public.sectors identifier; required on wizard submission."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Session authentication and Laravel CSRF/origin protection apply. Use X-XSRF-TOKEN for browser clients."
|
|
}
|
|
},
|
|
"/reviews": {
|
|
"get": {
|
|
"summary": "List submitted records for designated reviewers with MFA; excludes own records",
|
|
"parameters": [],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"records": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Business"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"management": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/listings/{id}": {
|
|
"get": {
|
|
"summary": "Read own record or currently reviewable submission",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"record": {
|
|
"$ref": "#/components/schemas/Business"
|
|
},
|
|
"canEdit": {
|
|
"type": "boolean"
|
|
},
|
|
"owner": {
|
|
"type": "boolean"
|
|
},
|
|
"canReview": {
|
|
"type": "boolean"
|
|
},
|
|
"history": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version_no": {
|
|
"type": "integer"
|
|
},
|
|
"action": {
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"verifications": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": [
|
|
"version_no",
|
|
"check",
|
|
"outcome",
|
|
"evidence_reference",
|
|
"note"
|
|
],
|
|
"properties": {
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"object_id": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "uuid"
|
|
},
|
|
"check": {
|
|
"enum": [
|
|
"identity",
|
|
"representation",
|
|
"declared_ownership",
|
|
"documentary_ownership",
|
|
"document_received",
|
|
"document_validated",
|
|
"independent_valuation",
|
|
"land_right_documented",
|
|
"license_confirmed",
|
|
"validity",
|
|
"legal_transfer",
|
|
"prior_authorization"
|
|
]
|
|
},
|
|
"outcome": {
|
|
"enum": [
|
|
"confirmed",
|
|
"rejected",
|
|
"inconclusive",
|
|
"revoked"
|
|
]
|
|
},
|
|
"evidence_reference": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 2000
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 2000
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "date",
|
|
"description": "Required for confirmed findings; must be today or later."
|
|
},
|
|
"effective_outcome": {
|
|
"enum": [
|
|
"confirmed",
|
|
"rejected",
|
|
"inconclusive",
|
|
"revoked",
|
|
"stale",
|
|
"expired"
|
|
]
|
|
},
|
|
"content_version": {
|
|
"type": "integer"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"summary": "Update owned draft or request for information; optimistic version required",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Business"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"modality",
|
|
"classification",
|
|
"reason",
|
|
"payload",
|
|
"version_no"
|
|
],
|
|
"properties": {
|
|
"modality": {
|
|
"type": "string"
|
|
},
|
|
"classification": {
|
|
"enum": [
|
|
"internal",
|
|
"confidential",
|
|
"restricted"
|
|
]
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 1000
|
|
},
|
|
"payload": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"description": "Proposed title"
|
|
},
|
|
"description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10000,
|
|
"description": "Private description"
|
|
},
|
|
"declared_reason": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Reason and objective"
|
|
},
|
|
"source_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Source reference"
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10,
|
|
"format": "date",
|
|
"description": "Declared expiry"
|
|
},
|
|
"proponent_type": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"person",
|
|
"organization",
|
|
null
|
|
],
|
|
"description": "Applicant type"
|
|
},
|
|
"proponent_name": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 200,
|
|
"description": "Name"
|
|
},
|
|
"tax_identifier": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 50,
|
|
"description": "Tax identifier"
|
|
},
|
|
"contact_email": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 254,
|
|
"description": "Contact email"
|
|
},
|
|
"contact_phone": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 40,
|
|
"description": "Phone"
|
|
},
|
|
"country": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2,
|
|
"description": "Country (two-letter code)"
|
|
},
|
|
"acting_capacity": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"holder",
|
|
"representative",
|
|
null
|
|
],
|
|
"description": "Acting capacity"
|
|
},
|
|
"declared_holder": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 200,
|
|
"description": "Declared holder"
|
|
},
|
|
"mandate_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 500,
|
|
"description": "Mandate reference"
|
|
},
|
|
"mandate_valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10,
|
|
"format": "date",
|
|
"description": "Mandate expiry"
|
|
},
|
|
"legitimacy_declaration": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 3,
|
|
"enum": [
|
|
"yes",
|
|
"no",
|
|
null
|
|
],
|
|
"description": "I declare authority to submit"
|
|
},
|
|
"asking_value": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 24,
|
|
"description": "Asking value"
|
|
},
|
|
"currency": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 3,
|
|
"description": "Currency (three-letter code)"
|
|
},
|
|
"value_nature": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"asking",
|
|
"indicative",
|
|
"appraised",
|
|
null
|
|
],
|
|
"description": "Value basis"
|
|
},
|
|
"equity_percentage": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 8,
|
|
"description": "Available equity (%)"
|
|
},
|
|
"funds_use": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Use of funds"
|
|
},
|
|
"location_notes": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Declared location (private)"
|
|
},
|
|
"asset_notes": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Declared assets and rights summary"
|
|
},
|
|
"document_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Document references (not validated files)"
|
|
},
|
|
"wizard_version": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"1",
|
|
null
|
|
]
|
|
},
|
|
"wizard_step": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"pattern": "^[1-8]$"
|
|
}
|
|
}
|
|
},
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"sector_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Existing active public.sectors identifier; required on wizard submission."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Session authentication and Laravel CSRF/origin protection apply. Use X-XSRF-TOKEN for browser clients."
|
|
}
|
|
},
|
|
"/listings/{id}/transitions": {
|
|
"post": {
|
|
"summary": "Submit, begin review, request information or withdraw",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Business"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"version_no",
|
|
"action",
|
|
"note"
|
|
],
|
|
"properties": {
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"action": {
|
|
"enum": [
|
|
"submitted",
|
|
"in_review",
|
|
"needs_information",
|
|
"withdrawn"
|
|
]
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 2000
|
|
},
|
|
"review_consent": {
|
|
"type": "boolean",
|
|
"description": "Must be true for submission. Stored in encrypted review evidence. Does not authorize publication."
|
|
},
|
|
"confirmation_code": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "Exact business code required for wizard_version=1 submission, in addition to internal review consent."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Session authentication and Laravel CSRF/origin protection apply. Use X-XSRF-TOKEN for browser clients."
|
|
}
|
|
},
|
|
"/listings/{id}/objects": {
|
|
"post": {
|
|
"summary": "Declare a separate restricted object; increments aggregate version without granting verification",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"version_no": {
|
|
"type": "integer"
|
|
},
|
|
"verification_status": {
|
|
"const": "pending"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"kind",
|
|
"version_no",
|
|
"reason",
|
|
"payload"
|
|
],
|
|
"properties": {
|
|
"kind": {
|
|
"enum": [
|
|
"company",
|
|
"participation",
|
|
"asset",
|
|
"property",
|
|
"unit",
|
|
"improvement",
|
|
"agricultural_investment",
|
|
"land_right",
|
|
"contract",
|
|
"license",
|
|
"authorization",
|
|
"encumbrance",
|
|
"valuation",
|
|
"capital_request"
|
|
]
|
|
},
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 1000
|
|
},
|
|
"payload": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"label",
|
|
"source_reference"
|
|
],
|
|
"properties": {
|
|
"label": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"declared_holder": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"document_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"source_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"competent_entity": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"purpose": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"location_description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"boundaries_description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"occupancy": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"condition": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"encumbrances": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"restrictions": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"required_authorizations": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"transfer_condition": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"contract_type": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"valid_from": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"area": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"area_unit": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"amount": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"currency": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"value_kind": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"participation_percent": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Session authentication and Laravel CSRF/origin protection apply. Use X-XSRF-TOKEN for browser clients."
|
|
}
|
|
},
|
|
"/listings/{id}/objects/{object}": {
|
|
"put": {
|
|
"summary": "Update scoped object with immutable kind; amount requires currency and value kind; area requires unit",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "object",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"version_no": {
|
|
"type": "integer"
|
|
},
|
|
"verification_status": {
|
|
"const": "pending"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"kind",
|
|
"version_no",
|
|
"reason",
|
|
"payload"
|
|
],
|
|
"properties": {
|
|
"kind": {
|
|
"enum": [
|
|
"company",
|
|
"participation",
|
|
"asset",
|
|
"property",
|
|
"unit",
|
|
"improvement",
|
|
"agricultural_investment",
|
|
"land_right",
|
|
"contract",
|
|
"license",
|
|
"authorization",
|
|
"encumbrance",
|
|
"valuation",
|
|
"capital_request"
|
|
]
|
|
},
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 1000
|
|
},
|
|
"payload": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"label",
|
|
"source_reference"
|
|
],
|
|
"properties": {
|
|
"label": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"declared_holder": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"document_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"source_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"competent_entity": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"purpose": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"location_description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"boundaries_description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"occupancy": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"condition": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"encumbrances": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"restrictions": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"required_authorizations": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"transfer_condition": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"contract_type": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"valid_from": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"area": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"area_unit": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"amount": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"currency": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"value_kind": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"participation_percent": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Session authentication and Laravel CSRF/origin protection apply. Use X-XSRF-TOKEN for browser clients."
|
|
}
|
|
},
|
|
"/listings/{id}/verifications": {
|
|
"post": {
|
|
"summary": "Record independent finding while in_review; immutable encrypted evidence, optimistic version and scoped object. Does not publish or certify the business.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"session": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Private response; Cache-Control private, no-store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Business"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authentication required"
|
|
},
|
|
"403": {
|
|
"description": "Account, ownership or current reviewer/MFA policy rejected"
|
|
},
|
|
"404": {
|
|
"description": "Module disabled or resource unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Stale version or invalid transition"
|
|
},
|
|
"422": {
|
|
"description": "Validation error"
|
|
},
|
|
"429": {
|
|
"description": "Rate limited"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"version_no",
|
|
"check",
|
|
"outcome",
|
|
"evidence_reference",
|
|
"note"
|
|
],
|
|
"properties": {
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"object_id": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "uuid"
|
|
},
|
|
"check": {
|
|
"enum": [
|
|
"identity",
|
|
"representation",
|
|
"declared_ownership",
|
|
"documentary_ownership",
|
|
"document_received",
|
|
"document_validated",
|
|
"independent_valuation",
|
|
"land_right_documented",
|
|
"license_confirmed",
|
|
"validity",
|
|
"legal_transfer",
|
|
"prior_authorization"
|
|
]
|
|
},
|
|
"outcome": {
|
|
"enum": [
|
|
"confirmed",
|
|
"rejected",
|
|
"inconclusive",
|
|
"revoked"
|
|
]
|
|
},
|
|
"evidence_reference": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 2000
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"minLength": 10,
|
|
"maxLength": 2000
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"format": "date",
|
|
"description": "Required for confirmed findings; must be today or later."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Session authentication and Laravel CSRF/origin protection apply. Use X-XSRF-TOKEN for browser clients."
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"session": {
|
|
"type": "apiKey",
|
|
"in": "cookie",
|
|
"name": "session_cookie",
|
|
"description": "Actual Laravel cookie name comes from deployment configuration; no bearer token support."
|
|
}
|
|
},
|
|
"schemas": {
|
|
"Business": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"code",
|
|
"modality",
|
|
"status",
|
|
"classification",
|
|
"version_no",
|
|
"payload"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"modality": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"draft",
|
|
"submitted",
|
|
"in_review",
|
|
"needs_information",
|
|
"withdrawn"
|
|
]
|
|
},
|
|
"classification": {
|
|
"enum": [
|
|
"internal",
|
|
"confidential",
|
|
"restricted"
|
|
]
|
|
},
|
|
"version_no": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"payload": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"description": "Proposed title"
|
|
},
|
|
"description": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10000,
|
|
"description": "Private description"
|
|
},
|
|
"declared_reason": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Reason and objective"
|
|
},
|
|
"source_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Source reference"
|
|
},
|
|
"valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10,
|
|
"format": "date",
|
|
"description": "Declared expiry"
|
|
},
|
|
"proponent_type": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"person",
|
|
"organization",
|
|
null
|
|
],
|
|
"description": "Applicant type"
|
|
},
|
|
"proponent_name": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 200,
|
|
"description": "Name"
|
|
},
|
|
"tax_identifier": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 50,
|
|
"description": "Tax identifier"
|
|
},
|
|
"contact_email": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 254,
|
|
"description": "Contact email"
|
|
},
|
|
"contact_phone": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 40,
|
|
"description": "Phone"
|
|
},
|
|
"country": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2,
|
|
"description": "Country (two-letter code)"
|
|
},
|
|
"acting_capacity": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"holder",
|
|
"representative",
|
|
null
|
|
],
|
|
"description": "Acting capacity"
|
|
},
|
|
"declared_holder": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 200,
|
|
"description": "Declared holder"
|
|
},
|
|
"mandate_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 500,
|
|
"description": "Mandate reference"
|
|
},
|
|
"mandate_valid_until": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 10,
|
|
"format": "date",
|
|
"description": "Mandate expiry"
|
|
},
|
|
"legitimacy_declaration": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 3,
|
|
"enum": [
|
|
"yes",
|
|
"no",
|
|
null
|
|
],
|
|
"description": "I declare authority to submit"
|
|
},
|
|
"asking_value": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 24,
|
|
"description": "Asking value"
|
|
},
|
|
"currency": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 3,
|
|
"description": "Currency (three-letter code)"
|
|
},
|
|
"value_nature": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 30,
|
|
"enum": [
|
|
"asking",
|
|
"indicative",
|
|
"appraised",
|
|
null
|
|
],
|
|
"description": "Value basis"
|
|
},
|
|
"equity_percentage": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 8,
|
|
"description": "Available equity (%)"
|
|
},
|
|
"funds_use": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Use of funds"
|
|
},
|
|
"location_notes": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Declared location (private)"
|
|
},
|
|
"asset_notes": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Declared assets and rights summary"
|
|
},
|
|
"document_reference": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"maxLength": 2000,
|
|
"description": "Document references (not validated files)"
|
|
},
|
|
"wizard_version": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"1",
|
|
null
|
|
]
|
|
},
|
|
"wizard_step": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"pattern": "^[1-8]$"
|
|
}
|
|
}
|
|
},
|
|
"sector_id": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"description": "Existing active public.sectors identifier; required on wizard submission."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|