--- updatedAt: 2026-06-17T23:46:53.000Z agentTools: projectIndex: https://docs.singlefile.ai/llms.txt --- # /entities/{entity_id} View to retrieve and update a specific entity # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "SingleFile External API Documentation", "description": "", "termsOfService": "https://www.singlefile.io/", "contact": { "email": "support@singlefile.io" }, "license": { "name": "BSD License" }, "version": "v1" }, "paths": { "/entities/{entity_id}": { "get": { "operationId": "entities_read", "description": "View to retrieve and update a specific entity", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDetail" } } } } }, "tags": [ "entities" ] }, "parameters": [ { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "servers": [ { "url": "https://api.demo.singlefile.ai/external-api/v1" } ], "components": { "schemas": { "ExternalAddress": { "type": "object", "properties": { "id": { "title": "Id", "type": "string", "readOnly": true, "nullable": true }, "street_address": { "title": "Street address", "type": "string", "maxLength": 200, "nullable": true }, "city": { "title": "City", "type": "string", "maxLength": 100, "nullable": true }, "state": { "title": "State", "type": "string", "maxLength": 100, "nullable": true }, "postal_code": { "title": "Postal code", "type": "string", "maxLength": 20, "nullable": true }, "country": { "title": "Country", "type": "string", "maxLength": 100, "nullable": true }, "country_code": { "title": "Country code", "type": "string", "maxLength": 10, "nullable": true }, "country_area": { "title": "Country area", "type": "string", "maxLength": 100, "nullable": true }, "city_area": { "title": "City area", "type": "string", "maxLength": 100, "nullable": true }, "sorting_code": { "title": "Sorting code", "type": "string", "maxLength": 100, "nullable": true } } }, "User": { "required": [ "email", "first_name", "last_name" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "readOnly": true, "nullable": true }, "email": { "title": "Email", "type": "string", "format": "email", "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "minLength": 1 }, "last_name": { "title": "Last name", "type": "string", "minLength": 1 }, "job_title": { "title": "Job title", "type": "string", "nullable": true }, "telephone_number": { "title": "Telephone number", "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/ExternalAddress" } } }, "GrossAsset": { "required": [ "date", "assets" ], "type": "object", "properties": { "date": { "title": "Date", "type": "string", "format": "date" }, "assets": { "title": "Assets", "type": "string", "format": "decimal" } } }, "ShareClass": { "required": [ "class_name", "authorized_shares" ], "type": "object", "properties": { "start_date": { "title": "Start date", "type": "string", "format": "date", "nullable": true }, "class_name": { "title": "Class name", "type": "string", "maxLength": 100, "minLength": 1 }, "authorized_shares": { "title": "Authorized shares", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000 }, "par_value": { "title": "Par value", "type": "string", "format": "decimal", "nullable": true }, "issued_shares": { "title": "Issued shares", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "nullable": true } } }, "JurisdictionDetail": { "required": [ "registration_type", "state_file_number", "status", "has_annual_report_subscription", "is_registered_agent" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "readOnly": true, "nullable": true }, "name": { "title": "Jurisdiction", "type": "string", "maxLength": 100, "nullable": true }, "organization_id": { "title": "Organization id", "type": "string", "readOnly": true }, "entity_id": { "title": "Entity id", "type": "string", "readOnly": true }, "registration_type": { "title": "Registration type", "type": "string", "minLength": 1 }, "state_file_number": { "title": "State file number", "type": "string", "minLength": 1 }, "registration_date": { "title": "Registration date", "type": "string", "format": "date", "nullable": true }, "expiration_date": { "title": "Expiration date", "type": "string", "format": "date", "nullable": true }, "status": { "title": "Status", "type": "string", "minLength": 1 }, "has_annual_report_subscription": { "title": "Has annual report subscription", "type": "boolean" }, "is_registered_agent": { "title": "Is registered agent", "type": "boolean" }, "dbas": { "title": "Dbas", "type": "string", "readOnly": true }, "local_address": { "$ref": "#/components/schemas/ExternalAddress" }, "created_at": { "title": "Created at", "type": "string", "format": "date-time" }, "updated_at": { "title": "Updated at", "type": "string", "format": "date-time" } } }, "EntityDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "readOnly": true, "nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 500, "minLength": 1 }, "entity_type": { "title": "Entity type", "type": "string", "enum": [ "Corporation", "Limited Liability Company", "Association", "Attorney for Bar", "Benefit Corporation", "Close Benefit Corporation", "Benefit LLC", "Benefit Professional Corporation", "Benevolent Corporation", "Close Corporation", "Close Limited Liability Company", "Close Professional Corporation", "Cooperative", "Cooperative Corporation", "Farm Corporation", "Farm Limited Liability Company", "Professional Limited Liability Limited Partnership", "Corporation Sole", "Doing Business as Name", "Exempt Nonstock Corporation", "General Partnership", "Individual", "Series Professional Limited Liability Company", "Limited Liability Limited Partnership", "Limited Liability Partnership", "Limited Partnership", "Low-Profit Limited Liability Company", "Massachusetts Trust", "Mutual Benefit Enterprise", "Mutual Benefit Nonprofit Corporation", "Nonprofit Corporation", "Nonprofit Limited Liability Company", "Personal Attorney", "Private Foundation", "Professional Corporation", "Professional Limited Liability Company", "Professional Limited Liability Partnership", "Professional Limited Partnership", "Public Benefit Corporation", "Public Benefit Nonprofit Corporation", "Religious Nonprofit Corporation", "Series Limited Liability Company", "Social Purpose Corporation", "Sole Proprietorship", "Sustainable Business Corporation", "Statutory Trust", "Trust" ] }, "organization_id": { "title": "Organization id", "type": "string", "readOnly": true }, "mailing_address": { "$ref": "#/components/schemas/ExternalAddress" }, "primary_address": { "$ref": "#/components/schemas/ExternalAddress" }, "tasks": { "title": "Tasks", "type": "string", "readOnly": true }, "governing_persons": { "title": "Governing persons", "type": "string", "readOnly": true }, "nature_of_business": { "title": "Nature of business", "type": "string", "maxLength": 500 }, "specific_business_purpose": { "title": "Specific business purpose", "type": "string", "maxLength": 250, "nullable": true }, "fein": { "title": "Fein", "type": "string", "pattern": "^\\d{2}-\\d{7}$", "maxLength": 10, "nullable": true }, "telephone_number": { "title": "Telephone number", "type": "string", "maxLength": 25, "nullable": true }, "website_url": { "title": "Website url", "type": "string", "maxLength": 250, "nullable": true }, "fiscal_year_end": { "title": "Fiscal year end", "description": "Date of the end of fiscal year. The year does not matter, you can default it to 1970.", "type": "string", "format": "date", "nullable": true }, "taxid_type": { "title": "Taxid type", "description": "Type of tax identification number", "type": "string", "enum": [ "FEIN", "SSN", "ITIN", "FOREIGN" ], "nullable": true }, "taxid": { "title": "Taxid", "description": "Tax identification number (SSN, ITIN, or Foreign Tax ID)", "type": "string", "maxLength": 50, "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionDetail" }, "readOnly": true }, "gross_assets": { "type": "array", "items": { "$ref": "#/components/schemas/GrossAsset" }, "readOnly": true }, "share_classes": { "type": "array", "items": { "$ref": "#/components/schemas/ShareClass" }, "readOnly": true }, "incorporator": { "$ref": "#/components/schemas/User" }, "primary_contact": { "$ref": "#/components/schemas/User" }, "entity_authorized_contact": { "$ref": "#/components/schemas/User" }, "created_at": { "title": "Created at", "type": "string", "format": "date-time" }, "updated_at": { "title": "Updated at", "type": "string", "format": "date-time" } } } } }, "x-readme": { "explorer-enabled": false } } ```