HEhevn-inc
documents

Fill the typed fields read off a document

Changed on

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

Request

Path parameters

documentIdstring required

Prefixed document id

Headers

Idempotency-Keystring nullable

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-Accountstring nullable

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

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Request body

fieldsobject required

Typed values extracted from or supplied for the document.

Response

Successful Response

idstring required

Stable public identifier for this document.

slot'certificate_of_incorporation' | 'certificate_of_registration' | 'formation_document' | 'articles_of_incorporation' | 'power_of_attorney' | 'corporate_structure' | 'org_structure_chart' | 'company_registry_extract' | 'corporate_registry_extract' | 'shareholder_registry' | 'cap_table' | 'director_structure' | 'proof_of_address' | 'utility_bill' | 'aml_policy' | 'annual_financial_statements' | 'articles_of_association' | 'audit_report' | 'independent_aml_audit_report' | 'identity_verification_attestation' | 'institutional_investor_documentation' | 'audited_financial_statement' | 'bank_reference_letter' | 'bank_verification_letter' | 'bank_statement' | 'banking_details' | 'birth_certificate' | 'business_license' | 'operating_license' | 'business_plan' | 'certificate_of_good_standing' | 'corporate_resolution' | 'proof_of_registered_address' | 'proof_of_operating_address' | 'crypto_statement' | 'credit_report' | 'criminal_record_check' | 'cv_resume' | 'driving_license' | 'education_certificate' | 'financial_projections' | 'investment_statement' | 'insurance_policy' | 'lease_agreement' | 'marriage_certificate' | 'national_id' | 'national_id_front' | 'national_id_back' | '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' | 'ein_letter' | 'tax_certificate' | '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' | 'flow_of_funds' | 'payroll_register' | 'investment_agreement' | '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' required
namestring nullable

Human-readable document name.

fileNamestring nullable

Original file name including its extension.

createdAtstring date-time nullable

UTC timestamp when the document was created.

Example response

{
  "id": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the directors_registry enum value from the response property for the response status

    • info

      removed the list_of_authorized_signatories enum value from the response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new audited_financial_statement enum value to the response property for the response status

    • warning

      added the new bank_verification_letter enum value to the response property for the response status

    • warning

      added the new cap_table enum value to the response property for the response status

    • warning

      added the new certificate_of_registration enum value to the response property for the response status

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new corporate_resolution enum value to the response property for the response status

    • warning

      added the new directors_registry enum value to the response property for the response status

    • warning

      added the new ein_letter enum value to the response property for the response status

    • warning

      added the new flow_of_funds enum value to the response property for the response status

    • warning

      added the new identity_verification_attestation enum value to the response property for the response status

    • warning

      added the new independent_aml_audit_report enum value to the response property for the response status

    • warning

      added the new institutional_investor_documentation enum value to the response property for the response status

    • warning

      added the new investment_agreement enum value to the response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new national_id_back enum value to the response property for the response status

    • warning

      added the new national_id_front enum value to the response property for the response status

    • warning

      added the new operating_license enum value to the response property for the response status

    • warning

      added the new org_structure_chart enum value to the response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new payroll_register enum value to the response property for the response status

    • warning

      added the new proof_of_operating_address enum value to the response property for the response status

    • warning

      added the new proof_of_registered_address enum value to the response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • warning

      added the new tax_certificate enum value to the response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status