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

TrustLayer documents API

The documents API from TrustLayer — 15 operation(s) for documents.

TrustLayer documents API is one of 21 APIs that TrustLayer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 25 operations across 15 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: http://localhost:4000/v1, https://api.trustlayer.io/v1.

25 operations 15 paths 25 schemas 8 DELETE5 GET1 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.trustlayer.io/v2
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

TrustLayer documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Token). By default, every request must be authenticated.

Paths & Operations 25

Across 15 paths, the API surfaces 25 operations — 8 DELETE, 5 GET, 1 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

documents 25
GET
/documentsdeprecated
List documents
get-documents 5 params → 200
POST
/documentsdeprecated
Upload a document
post-documents body → 201
GET
/documents/{documentId}deprecated
Fetch a document
get-documents-id 2 params → 200
PATCH
/documents/{documentId}deprecated
Update a document
patch-documents-documentId 3 params body → 200
DELETE
/documents/{documentId}deprecated
Delete a document
delete-documents-documentId 1 param → 200
DELETE
/documents/{documentId}/reviewdeprecated
Remove the review from a document
delete-documents-id-review 3 params → 200
POST
/documents/{documentId}/reviewdeprecated
Review a document
put-documents-id-review 3 params → 201
DELETE
/documents/{documentId}/archivedeprecated
Un-archive a document
delete-documents-id-archive 3 params → 200
POST
/documents/{documentId}/archivedeprecated
Archive a document
post-documents-id-archive 3 params → 201
POST
/documents/{documentId}/reprocessdeprecated
Reprocess a document
put-documents-id-review 1 param → 201
DELETE
/documents/{documentId}/flagdeprecated
Remove the flag from a document
delete-documents-id-flag 3 params → 200
POST
/documents/{documentId}/flagdeprecated
Flag a document or update the existing flag info
put-documents-id-flag 3 params body → 201
POST
/parties/{partyId}/compliance-certificatedeprecated
Create a party compliance certificate
post-parties-id-compliance-certificate-create 1 param body → 201
GET
/parties/{partyId}/compliance-certificatedeprecated
Fetch a party's compliance certificate
get-parties-id-compliance-certificate 1 param → 200
POST
/parties/{partyId}/relationships/documentsdeprecated
Attach documents to a party
post-parties-id-relationships-documents 1 param body → 201
DELETE
/parties/{partyId}/relationships/documentsdeprecated
Detach a document from a party
delete-parties-id-relationships-documents 1 param body → 200
POST
/projects/{projectId}/relationships/documentsdeprecated
Attach documents to a project
post-projects-id-relationships-documents 1 param body → 201
DELETE
/projects/{projectId}/relationships/documentsdeprecated
Detach documents from a project
delete-projects-id-relationships-documents 1 param body → 200
POST
/parties/{partyId}/documentsdeprecated
Upload a document to a party
post-parties-id-documents 1 param body → 201
DELETE
/parties/{partyId}/relationships/documents/{documentId}deprecated
Remove a document from a party
get-parties-partyId-relationships-documents-documentId 2 params → 200
DELETE
/projects/{projectId}/relationships/documents/{documentId}deprecated
Remove a document from a project
delete-projects-projectId-relationships-documents-documentId 2 params → 200
GET
/parties/{partyId}/document-requestdeprecated
Fetch the current document request
get-parties-:id-document-request 2 params body → 200
POST
/parties/{partyId}/document-requestdeprecated
Send a new document request
post-parties-partyId-document-request 1 param body → 201
POST
/documents/{documentId}/relationships/projectsdeprecated
Associate a document to multiple projects
post-documents-documentId-relationships-projects 1 param body → 200
GET
/documents/{id}/amendments
List amendments (cancellations and reinstatements) attached to a document. Each amendment is either a cancellation that reduces or ends the policy coverage referenced by the document, or a reinstatem…
3 params → 200400401403404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are document (23 properties), party (20 properties), contact (13 properties), project (13 properties). Each schema is shown below with its type and property counts.

reference
object
Generic object reference
2 properties
compliance-profile
object
6 properties
objectId
string
collection-meta
object
4 properties
reference-list-input
array
compliance-document
object
3 properties
reference-input
object
1 property 1 required
taggging-full
object
6 properties
custom-field
object
9 properties
party-type
object
5 properties
user
object
5 properties
taggging
object
5 properties
party
object
20 properties
document-input
object
6 properties
document-request
object
8 properties
document-flag-input
object
4 properties 1 required
response-status
string
The possible values are "success", "fail", and "error".
objectIdInput
string
document-request-input
object
4 properties 1 required
contact
object
13 properties
document
object
23 properties
document-type
object
5 properties 4 required
compliance-certificate-create
object
3 properties
compliance-status
object
8 properties 5 required
project
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

trustlayer-documents-api-openapi.yml Raw ↑

Other APIs TrustLayer publishes across the network.

TrustLayer Auth API
TrustLayer branding API
TrustLayer compliance-profiles API
TrustLayer contacts API
TrustLayer Context Objects API
TrustLayer Context Records API
TrustLayer custom-fields API
TrustLayer Document Types API
TrustLayer Parties API
TrustLayer party-types API
TrustLayer Policies API
TrustLayer Primary Objects API
Where this information came from

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