Fill the typed fields read off a document

The verification gate refuses a submission whose documents have no recognised fields. Write them here — the keys are the paths the refusal names in details.documents, without the slot prefix.

PUT /documents/{documentId}/content

Fill the typed fields read off a document

cURL

curl --request PUT \
  --url https://api.example.com/documents/{documentId}/content \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fields": {}
}'

200

{
  "id": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "slot": "certificate_of_incorporation",
  "name": "<string>",
  "fileName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

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

Headers

Idempotency-Key · string | null

Your own key for this write, ^[A-Za-z0-9._:-]{1,128}$. A retry with the same key replays the first answer; the same key with a different request is refused.

Example:

"po-inv-2026-114"

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Path Parameters

documentId · string · required

Prefixed document id

Body

application/json

fields · Fields · object · required

Typed values extracted from or supplied for the document.

Show child attributes

Response

200

application/json

Successful Response

id · string · required

Stable public identifier for this document.

Pattern: ^(?:doc_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

slot · enum<string> · required

Verification requirement this document satisfies.

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, aml_policy, 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, ubo_declaration, 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

Human-readable document name.

fileName · string | null

Original file name including its extension.

createdAt · string<date-time> | null

UTC timestamp when the document was created.