Hevn Inc documents API is one of 31 APIs that Hevn Inc 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, API documentation, and an API reference.
This API exposes
7 operations
across 7 paths,
and defines 12 schemas.
It is described by OpenAPI 3.1.0, at version 0.1.2.
Requests are made against a single base URL, https://api.hevn.finance.
7 operations7 paths12 schemas4 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
0.1.2
Base URL
https://api.hevn.finance/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 2
Hevn Inc documents API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
An API key is passed in the header as x-api-key (ApiKeyAuth).
ApiKeyAuth — Alternative HEVN API key header. The CLI defaults to Authorization Bearer unless configured with HEVNAPIKEYHEADER=X-Api-Key.
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
documents 7
GET
/api/v1/b2b/documentsdeprecated
List uploaded documents (deprecated, use GET /documents)
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ContractorAgreementData (17 properties), FirmaCreateDocumentResponse (7 properties), DocumentDraftInfo (7 properties), KybDocumentUpload (5 properties). Each schema is shown below with its type and property counts.
DocumentDraftInfo
object
Document info in response.
7 properties2 required
FirmaSignerInfo
object
Signer information for a signing request.
3 properties3 required
FirmaSigningUrlInfo
object
Signing URL for embedding in iframe.
2 properties2 required
KybDocumentUpload
object
Document upload for draft.
5 properties2 required
CorpDocumentType
string
Supported document types for e-signing.
FirmaCreateDocumentResponse
object
Response after creating and sending a signing request.
7 properties5 required
ValidationError
object
3 properties3 required
UploadedDocumentListResponse
object
Response for user-uploaded documents list.
1 property1 required
SlxDocumentType
string
Document types for upload.
FirmaCreateDocumentRequest
object
Request to create a document for signing via Firma.
4 properties3 required
HTTPValidationError
object
1 property
ContractorAgreementData
object
Data for filling Contractor Agreement template.
17 properties9 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
