How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SingleFile entities API

Business entities — create, list, read, update, and their contacts, documents, jurisdictions, orders and tasks

SingleFile entities API is one of 7 APIs that SingleFile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 16 operations across 12 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.demo.singlefile.ai/external-api/v1.

16 operations 12 paths 20 schemas 8 GET2 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.demo.singlefile.ai/external-api/v1
Authentication
OAuth 2.0
License
BSD License
Terms of Service
Resource Areas
1

Authentication & Security 1

SingleFile entities API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 2 scopes. By default, every request must be authenticated.

  • OAuth2ClientCredentials — OAuth 2.0 Client Credentials flow. Exchange clientid/clientsecret at the token endpoint for a 1-hour bearer token; send it as Authorization: Bearer .

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 8 GET, 2 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

entities 16

Business entities — create, list, read, update, and their contacts, documents, jurisdictions, orders and tasks

POST
/entities/{entity_id}/contacts/create
View to create contacts for an entity
entities_contacts_create_create 1 param body → 201
GET
/entities/{entity_id}/contacts
View to list all contacts associated with an entity
entities_contacts_list 5 params → 200
PATCH
/entities/{entity_id}/contacts/{contact_id}
View to retrieve and update a specific contact for an entity
entities_contacts_partial_update 2 params body → 200
GET
/entities/{entity_id}/contacts/{contact_id}
View to retrieve and update a specific contact for an entity
entities_contacts_read 2 params → 200
PUT
/entities/{entity_id}/contacts/{contact_id}
View to retrieve and update a specific contact for an entity
entities_contacts_update 2 params body → 200
POST
/entities/create
Create a new entity.
entities_create_create → 201
GET
/entities/{entity_id}/documents
entities_documents_list 9 params → 200
POST
/entities/{entity_id}/documents/upload
entities_documents_upload_create 1 param body → 201
POST
/entities/{entity_id}/jurisdictions/create
entities_jurisdictions_create_create 1 param body → 201
GET
/entities/{entity_id}/jurisdictions
entities_jurisdictions_list 5 params → 200
GET
/entities/list
View and list your entities.
entities_list_list 4 params → 200
GET
/entities/{entity_id}/orders
entities_orders_list 5 params → 200
PATCH
/entities/{entity_id}
View to retrieve and update a specific entity
entities_partial_update 1 param body → 200
GET
/entities/{entity_id}
View to retrieve and update a specific entity
entities_read 1 param → 200
PUT
/entities/{entity_id}
View to retrieve and update a specific entity
entities_update 1 param body → 200
GET
/entities/{entity_id}/tasks
entities_tasks_list 5 params → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are EntityDetail (24 properties), TaskInstance (21 properties), JurisdictionDetail (15 properties), JurisdictionList (13 properties). Each schema is shown below with its type and property counts.

EntityList
object
6 properties 1 required
ExternalAddress
object
10 properties
OrderList
object
9 properties
ContactDetail
object
12 properties 1 required
TaskInstance
object
21 properties 1 required
GrossAsset
object
2 properties 2 required
EntityDetail
object
24 properties 1 required
ShareClass
object
5 properties 2 required
JurisdictionList
object
13 properties 5 required
EntityContactCreateRequest
object
3 properties
ContactUpdate
object
7 properties 1 required
JurisdictionCreate
object
11 properties 3 required
DocumentList
object
10 properties 2 required
User
object
7 properties 3 required
ContactList
object
7 properties
EntityUpdate
object
8 properties
JurisdictionDetail
object
15 properties 5 required
DocumentUpload
object
8 properties 1 required
ContactCreate
objectnull
7 properties 3 required
Address
objectnull
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

singlefile-entities-api-openapi.yml Raw ↑

Other APIs SingleFile publishes across the network.

SingleFile documents API
SingleFile jurisdictions API
SingleFile orders API
SingleFile organizations API
SingleFile schemas API
SingleFile tasks API
Where this information came from

This is an independent, third-party profile of SingleFile entities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.