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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Socotra

Socotra Document API

The Document API from Socotra — 28 operation(s) for document.

Documentation Provider Profile APIs.io OpenAPI GitHub

Socotra Document API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 30 operations across 28 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

30 operations 28 paths 12 schemas 1 DELETE17 GET1 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
View terms
Resource Areas
1

Paths & Operations 30

Across 28 paths, the API surfaces 30 operations — 1 DELETE, 17 GET, 1 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Document 30
POST
/document/{tenantLocator}/documents/transaction/{locator}/trigger
triggerTimedOutDocumentsJobForTransaction 2 params → 200
POST
/document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}/trigger
triggerFailedDocumentJobForTransaction 3 params → 200
POST
/document/{tenantLocator}/documents/segment/{locator}/trigger
triggerTimedOutDocumentsJobForSegment 2 params → 200
POST
/document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}/trigger
triggerFailedDocumentJobForSegment 3 params → 200
POST
/document/{tenantLocator}/documents/render
renderDocument 8 params body → 200
POST
/document/{tenantLocator}/documents/quote/{locator}/trigger
triggerTimedOutDocumentsJobForQuote 2 params → 200
POST
/document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}/trigger
triggerFailedDocumentJobForQuote 3 params → 200
POST
/document/{tenantLocator}/documents/quote/{locator}/copyOnIssue
copyDocumentsOnIssue 3 params → 200
POST
/document/{tenantLocator}/documents/invoices/{locator}/trigger
triggerTimedOutJob 2 params → 200
POST
/document/{tenantLocator}/documents/invoices/{locator}/jobs/{jobLocator}/trigger
triggerFailedDocumentJobForInvoice 3 params → 200
POST
/document/{tenantLocator}/documents/attach
attachDocument 11 params body → 200
GET
/document/{tenantLocator}/documents/{locator}
fetchDocument 2 params → 200
PATCH
/document/{tenantLocator}/documents/{locator}
replaceDocument 4 params body → 200
DELETE
/document/{tenantLocator}/documents/{locator}
deleteDocument 2 params → 200
GET
/document/events
fetchDocumentEventDefinitions → 200
GET
/document/{tenantLocator}/documents/{locator}/source
fetchSourceForDocument 2 params → 200
GET
/document/{tenantLocator}/documents/{locator}/document
fetchDocumentResource 2 params → 200
GET
/document/{tenantLocator}/documents/transaction/{locator}/list
fetchDocumentsForTransaction 6 params → 200
GET
/document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}
fetchDocumentsJobForTransaction 3 params → 200
GET
/document/{tenantLocator}/documents/transaction/{locator}/jobs/list
fetchMultipleDocumentsJobsForTransaction 5 params → 200
GET
/document/{tenantLocator}/documents/segment/{locator}/list
fetchDocumentsForSegment 6 params → 200
GET
/document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}
fetchDocumentsJobForSegment 3 params → 200
GET
/document/{tenantLocator}/documents/segment/{locator}/jobs/list
fetchMultipleDocumentsJobsForSegment 5 params → 200
GET
/document/{tenantLocator}/documents/quote/{locator}/list
fetchDocumentsForQuote 6 params → 200
GET
/document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}
fetchDocumentsJobForQuote 3 params → 200
GET
/document/{tenantLocator}/documents/quote/{locator}/jobs/list
fetchMultipleDocumentsJobsForQuote 5 params → 200
GET
/document/{tenantLocator}/documents/policy/{policyLocator}/term/{termLocator}/summary
fetchDocumentsForTerm 6 params → 200
GET
/document/{tenantLocator}/documents/invoices/{locator}
fetchInvoiceDocument 2 params → 200
GET
/document/{tenantLocator}/documents/invoices/{locator}/jobs
getDocumentJob 2 params → 200
GET
/document/{tenantLocator}/documents/invoices/{locator}/jobs/{jobLocator}
fetchDocumentJob 3 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are DocumentInstanceResponse (23 properties), DocumentsJob (14 properties), DocumentJobInfo (6 properties), DocumentsJobSummary (4 properties). Each schema is shown below with its type and property counts.

DocumentJobListResponse
object
2 properties 2 required
DocumentEventData
object
3 properties 3 required
StreamingResponseBody
object
DocumentEvents
object
2 properties
TemplateResponse
object
2 properties
DocumentJobInfo
object
6 properties 6 required
DocumentsJobSummary
object
4 properties 4 required
DocumentListResponse
object
2 properties 2 required
DocumentInstanceResponse
object
23 properties 11 required
DocumentsJob
object
14 properties 14 required
ListPageResponseDocumentInstance
object
2 properties 2 required
DocumentServiceEventTypeDefinitions
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-document-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
AE Profile APIs.io
Socotra Auxdata API
AE Profile APIs.io
Socotra Billing API
AE Profile APIs.io
Socotra Business Stats API
AE Profile APIs.io
Socotra Claim API
AE Profile APIs.io
Socotra Compliance API
AE Profile APIs.io
Socotra Config API
AE Profile APIs.io
Socotra Contact API
AE Profile APIs.io
Socotra Event API
AE Profile APIs.io
Socotra Migration API
AE Profile APIs.io
Socotra Payment Execution API
AE Profile APIs.io
Socotra Plugin API
AE Profile APIs.io
#Document
← Back to S APIs
API Details
ID
socotra:socotra-document-api
Base URL
https://api.sandbox.socotra.com
Docs
https://docs.socotra.com/docs/api
Provider
Socotra
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=socotra-document-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/socotra-document-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Socotra Document 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.