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
Hevn

Hevn Inc Contracts API

The contracts API from Hevn Inc — 28 operation(s) for contracts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hevn Inc Contracts API is one of 31 APIs that Hevn publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.hevn.finance.

34 operations 28 paths 34 schemas 2 DELETE10 GET4 PATCH16 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Contracts 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 34

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

Contracts 34
POST
/api/v1/documents/contracts
Create a new contract
create_contract_api_v1_documents_contracts_post 1 param body → 201422
GET
/api/v1/documents/contracts
List contracts for current user
list_contracts_api_v1_documents_contracts_get 1 param → 200422
POST
/api/v1/documents/contracts/{contract_id}/attach-document
Attach a document to a contract
attach_document_api_v1_documents_contracts__contract_id__attach_document_post 2 params body → 200422
GET
/api/v1/documents/contracts/templates
List fillable document templates and their fields
list_templates_api_v1_documents_contracts_templates_get → 200
POST
/api/v1/documents/contracts/generate_scope_prefill
Generate plain-text scope description from a role
generate_scope_prefill_api_v1_documents_contracts_generate_scope_prefill_post body → 200422
POST
/api/v1/documents/contracts/prepare_document
Persist prepared contract markdown as a document
prepare_contract_document_api_v1_documents_contracts_prepare_document_post 1 param body → 201422
GET
/api/v1/documents/contracts/{contract_id}/preview_document
Preview contract document generated from a saved contract
preview_contract_document_api_v1_documents_contracts__contract_id__preview_document_get 2 params → 200422
GET
/api/v1/documents/contracts/{contract_id}/preview
Preview contract document generated from a saved contract
preview_contract_document_api_v1_documents_contracts__contract_id__preview_get 2 params → 200422
GET
/api/v1/documents/contracts/{contract_id}
Get contract by ID
get_contract_api_v1_documents_contracts__contract_id__get 2 params → 200422
PATCH
/api/v1/documents/contracts/{contract_id}
Update contract terms and schedule
update_contract_api_v1_documents_contracts__contract_id__patch 2 params body → 200422
DELETE
/api/v1/documents/contracts/{contract_id}
Delete contract
delete_contract_api_v1_documents_contracts__contract_id__delete 2 params → 200422
POST
/api/v1/documents/contracts/{contract_id}/close
Close contract
close_contract_api_v1_documents_contracts__contract_id__close_post 2 params → 200422
POST
/api/v1/documents/contracts/{contract_id}/pause
Pause contract
pause_contract_api_v1_documents_contracts__contract_id__pause_post 2 params → 200422
POST
/api/v1/documents/contracts/{contract_id}/approve
Approve contract by client or contractor
approve_contract_api_v1_documents_contracts__contract_id__approve_post 2 params body → 200422
PUT
/api/v1/documents/contracts/{contract_id}/payment_methods
Set contractor payment methods for contract
update_contract_payment_methods_api_v1_documents_contracts__contract_id__payment_methods_put 2 params body → 200422
PATCH
/api/v1/documents/contracts/{contract_id}/label
Update contract label
update_contract_label_api_v1_documents_contracts__contract_id__label_patch 2 params body → 200422
POST
/api/v1/documents/contracts/{contract_id}/send-for-signing
Send contract for signing
send_for_signing_api_v1_documents_contracts__contract_id__send_for_signing_post 2 params → 200422
POST
/api/v1/invoices/documents/contracts
Create a new contract
create_contract_package_alias_api_v1_invoices_documents_contracts_post 1 param body → 201422
GET
/api/v1/invoices/documents/contracts
List contracts for current user
list_contracts_package_alias_api_v1_invoices_documents_contracts_get 1 param → 200422
POST
/api/v1/invoices/documents/contracts/{contract_id}/attach-document
Attach a document to a contract
attach_document_package_alias_api_v1_invoices_documents_contracts__contract_id__attach_document_post 2 params body → 200422
GET
/api/v1/invoices/documents/contracts/templates
List fillable document templates and their fields
list_templates_package_alias_api_v1_invoices_documents_contracts_templates_get → 200
POST
/api/v1/invoices/documents/contracts/generate_scope_prefill
Generate plain-text scope description from a role
generate_scope_prefill_package_alias_api_v1_invoices_documents_contracts_generate_scope_prefill_post body → 200422
POST
/api/v1/invoices/documents/contracts/prepare_document
Persist prepared contract markdown as a document
prepare_contract_document_package_alias_api_v1_invoices_documents_contracts_prepare_document_post 1 param body → 201422
GET
/api/v1/invoices/documents/contracts/{contract_id}/preview_document
Preview contract document generated from a saved contract
preview_contract_document_package_alias_api_v1_invoices_documents_contracts__contract_id__preview_document_get 2 params → 200422
GET
/api/v1/invoices/documents/contracts/{contract_id}/preview
Preview contract document generated from a saved contract
preview_contract_document_package_alias_api_v1_invoices_documents_contracts__contract_id__preview_get 2 params → 200422
GET
/api/v1/invoices/documents/contracts/{contract_id}
Get contract by ID
get_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__get 2 params → 200422
PATCH
/api/v1/invoices/documents/contracts/{contract_id}
Update contract terms and schedule
update_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__patch 2 params body → 200422
DELETE
/api/v1/invoices/documents/contracts/{contract_id}
Delete contract
delete_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__delete 2 params → 200422
POST
/api/v1/invoices/documents/contracts/{contract_id}/close
Close contract
close_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__close_post 2 params → 200422
POST
/api/v1/invoices/documents/contracts/{contract_id}/pause
Pause contract
pause_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__pause_post 2 params → 200422
POST
/api/v1/invoices/documents/contracts/{contract_id}/approve
Approve contract by client or contractor
approve_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__approve_post 2 params body → 200422
PUT
/api/v1/invoices/documents/contracts/{contract_id}/payment_methods
Set contractor payment methods for contract
update_contract_payment_methods_package_alias_api_v1_invoices_documents_contracts__contract_id__payment_methods_put 2 params body → 200422
PATCH
/api/v1/invoices/documents/contracts/{contract_id}/label
Update contract label
update_contract_label_package_alias_api_v1_invoices_documents_contracts__contract_id__label_patch 2 params body → 200422
POST
/api/v1/invoices/documents/contracts/{contract_id}/send-for-signing
Send contract for signing
send_for_signing_package_alias_api_v1_invoices_documents_contracts__contract_id__send_for_signing_post 2 params → 200422

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are ContractResponse (28 properties), ContractLastInvoice (20 properties), ContractorContractPreviewFields (18 properties), CreateContractRequest (16 properties). Each schema is shown below with its type and property counts.

TemplateFieldType
string
Structural type of a template field, so clients can render the right input. Composite types carry their shape: OBJECT populates :attr:TemplateField.fields, ARR…
ContractType
string
Contract type.
UpdateContractRequest
object
Request to update creator-owned contract terms and schedule.
6 properties
CustomContractPreviewFields
object
1 property
UpdateContractPaymentMethodsRequest
object
Payment methods selected by the contractor for this contract.
1 property
CreateContractRequest
object
Request to create a new contract. Exactly one of contractoremail or clientemail must be set. contractoremail — the creator is the client. clientemail — the cre…
16 properties
ContractListResponse
object
List of contracts.
1 property 1 required
GenerateContractDocumentResponse
object
6 properties 3 required
TransactionType
string
Transaction type - payment rail. Includes all FiatPaymentType values (sepa/swift/ach/uaefts) plus extended fiat variants (wire/swift-usd/swift-eur/fedwire/pix)…
UpdateContractLabelRequest
object
Request to update a contract label.
1 property
ContractorContractPreviewFields
object
18 properties 14 required
EmployerContractPreviewFields
object
14 properties 14 required
ContractStatus
string
Contract status.
ContractLastInvoice
object
Flat last invoice data embedded in contract responses.
20 properties 7 required
ContractParty
object
Minimal user data embedded in contract responses.
9 properties 1 required
TemplateFieldSource
string
Where a template field's value comes from. USER — must be entered by the user. PROFILE — taken from a party's profile when available; if the profile is incompl…
ValidationError
object
3 properties 3 required
ContractResponse
object
Contract response.
28 properties 7 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
ContractPeriod
string
Recurring billing period of a contract.
ContractDocumentTemplateType
string
Markdown contract template type.
ServiceContractPreviewFields
object
9 properties 9 required
Currency
string
Supported invoice/contract currencies. G10 majors + AED/HKD.
TemplateField
object
Single field of a document template, for dynamic discovery. Clients should prompt the user for USER fields, and for PROFILE fields only when the referenced par…
11 properties 2 required
PrepareContractDocumentResponse
object
5 properties 3 required
app__schemas__routers__invoices__contract__AttachDocumentRequest
object
Request to attach a document to a contract.
1 property 1 required
UserAddress
object
Address schema for user. Canonical field names: streetaddress, addressline2, city, state, country, zip. Accepts legacy Align/IBAN field names (streetline1, str…
6 properties
GenerateScopePrefillRequest
object
Generate plain-text scope description from a role.
2 properties 1 required
ApproveContractRequest
object
Optional body for contract approval — each party can provide their own data.
3 properties
HTTPValidationError
object
1 property
TemplateListResponse
object
List of fillable document templates.
1 property 1 required
PrepareContractDocumentRequest
object
Persist already prepared markdown as a document file.
4 properties 2 required
TemplateDescriptor
object
Describes a document template and the fields a client must fill.
7 properties 3 required
GenerateScopePrefillResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-contracts-api-openapi.yml Raw ↑

Other APIs Hevn publishes across the network.

Hevn Inc Activity API
AE Profile APIs.io
Hevn Inc Apps API
AE Profile APIs.io
Hevn Inc Apps Transfer API
AE Profile APIs.io
Hevn Inc Auth API
AE Profile APIs.io
Hevn Inc Balance API
AE Profile APIs.io
Hevn Inc Banks API
AE Profile APIs.io
Hevn Inc Cards API
AE Profile APIs.io
Hevn Inc Chat API
AE Profile APIs.io
Hevn Inc Devices API
AE Profile APIs.io
Hevn Inc Documents API
AE Profile APIs.io
Hevn Inc Exports API
AE Profile APIs.io
Hevn Inc Health API
AE Profile APIs.io
#Contracts
← Back to H APIs
API Details
ID
hevn-inc:hevn-inc-contracts-api
Base URL
https://api.hevn.finance/api/v1
Docs
https://hevninc.mintlify.app/
Provider
Hevn
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=hevn-inc-contracts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hevn-inc-contracts-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 Hevn Inc Contracts 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.