Skip to main content
GET
/
api
/
v1
/
documents
/
contracts
/
{contract_id}
/
preview_document
Preview contract document generated from a saved contract
curl --request GET \
  --url https://api.hevn.finance/api/v1/documents/contracts/{contract_id}/preview_document \
  --header 'Authorization: Bearer <token>'
{
  "markdown": "<string>",
  "html": "<string>",
  "htmlPreview": "<string>",
  "fields": {
    "effectiveDate": "<string>",
    "employerName": "<string>",
    "employeeName": "<string>",
    "positionTitle": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "scope": "<string>",
    "compensation": "<string>",
    "paymentTerms": "<string>",
    "invoiceCycle": "<string>",
    "paymentDue": "<string>",
    "confidentialityTerms": "<string>",
    "intellectualPropertyTerms": "<string>",
    "complianceTerms": "<string>"
  },
  "missingFields": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
default:Bearer <token>
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-key
string | null

Path Parameters

​
contract_id
string<uuid>
required

Response

Successful Response

​
type
enum<string>
required

Markdown contract template type.

Available options:
employer,
employment,
service,
contractor,
default_contractor,
custom,
nda,
vendor,
milestone,
msa
​
markdown
string
required
​
html
string
required
​
htmlPreview
string | null
​
fields
EmployerContractPreviewFields · object
​
missingFields
string[]