Create a PDF document from markdown

Render an uploaded markdown file into a stored HEVN-generated PDF.

POST /api/v1/documents/create

Create a PDF document from markdown

cURL

curl --request POST \
  --url https://api.example.com/api/v1/documents/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "markdownBase64": "<string>"
}
'

201

{
  "id": "<string>",
  "type": "certificate_of_incorporation",
  "name": "<string>",
  "originName": "<string>",
  "link": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "issueDate": "2023-12-25",
  "expiryDate": "2023-12-25",
  "content": {},
  "dakotaId": "<string>",
  "signature": {
    "state": "draft",
    "signatureRequestId": "<string>",
    "signerEmails": [
      "<string>"
    ],
    "lastSignerEmail": "<string>",
    "testMode": false
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-api-key · string | null

Body

application/json

Upload markdown, render it through safe document blocks, and store a file.

markdownBase64 · string · required

Base64-encoded UTF-8 markdown file content.

name · string · default: Generated document

Human-readable document title.

Required string length: 1 - 255

originName · string | null

Human-readable final filename with spaces and extension, for example 'Mutual NDA - Client Inc and HEVN Inc.pdf'. Do not use snake_case or slug text.

Maximum string length: 255

documentType · enum<string> · default: other

Stored HEVN document type.

Available options: certificate_of_incorporation, formation_document, articles_of_incorporation, power_of_attorney, corporate_structure, company_registry_extract, corporate_registry_extract, shareholder_registry, director_structure, proof_of_address, utility_bill, annual_financial_statements, articles_of_association, audit_report, bank_reference_letter, bank_statement, banking_details, birth_certificate, business_license, business_plan, certificate_of_good_standing, crypto_statement, credit_report, criminal_record_check, cv_resume, driving_license, education_certificate, financial_projections, investment_statement, insurance_policy, lease_agreement, list_of_authorized_signatories, marriage_certificate, national_id, operating_agreement, partnership_agreement, professional_license, regulatory_license, reference_letter, register_of_members, residence_permit, shareholding_structure, shareholders_agreement, social_security_document, source_of_funds_declaration, tax_identification_document, tax_compliance_form, tax_returns, payslip, pitch_deck, savings_statement, trade_references, vat_registration, vendor_contracts, visa, wealth_statement, contract, invoice, loan_agreement, subscription_agreement, safe_agreement, convertible_note, promissory_note, marketing_material, employment_contract, authorization_to_act, authority_to_bind, income_verification_letter, source_of_funds, source_of_wealth, supporting_document, memorandum, passport_front, passport_back, id_card_front, id_card_back, drivers_license_front, drivers_license_back, residence_permit_front, residence_permit_back, other

context · string | null · default: hevn_generated

Document context stored with the document row.

Maximum string length: 255

title · string | null

Optional render title. Defaults to name.

Maximum string length: 255

outputFormat · enum<string> · default: pdf

Generated document file format.

Available options: pdf, docx

Response

201

application/json

Successful Response

Document info in response.

id · string · required

type · enum<string> · required

Open internal document type; providers map it to their own taxonomy.

Available options: certificate_of_incorporation, formation_document, articles_of_incorporation, power_of_attorney, corporate_structure, company_registry_extract, corporate_registry_extract, shareholder_registry, director_structure, proof_of_address, utility_bill, annual_financial_statements, articles_of_association, audit_report, bank_reference_letter, bank_statement, banking_details, birth_certificate, business_license, business_plan, certificate_of_good_standing, crypto_statement, credit_report, criminal_record_check, cv_resume, driving_license, education_certificate, financial_projections, investment_statement, insurance_policy, lease_agreement, list_of_authorized_signatories, marriage_certificate, national_id, operating_agreement, partnership_agreement, professional_license, regulatory_license, reference_letter, register_of_members, residence_permit, shareholding_structure, shareholders_agreement, social_security_document, source_of_funds_declaration, tax_identification_document, tax_compliance_form, tax_returns, payslip, pitch_deck, savings_statement, trade_references, vat_registration, vendor_contracts, visa, wealth_statement, contract, invoice, loan_agreement, subscription_agreement, safe_agreement, convertible_note, promissory_note, marketing_material, employment_contract, authorization_to_act, authority_to_bind, income_verification_letter, source_of_funds, source_of_wealth, supporting_document, memorandum, passport_front, passport_back, id_card_front, id_card_back, drivers_license_front, drivers_license_back, residence_permit_front, residence_permit_back, other

name · string | null

originName · string | null

link · string | null

createdAt · string<date-time> | null

issueDate · string<date> | null

expiryDate · string<date> | null

content · Content · object | null

dakotaId · string | null

signature · DocumentSignatureInfo · object | null

Signing state for a HEVN-generated document. null when the document carries no signature blocks, so a plain upload stays plain. A stored document is not a signed one — read the state.

Show child attributes